Fixed Doxygen findings

lib/APPConvoyLeader/App.h

@@ -27,7 +27,7 @@
 /**
  * @brief  ConvoyLeader application
  * @author Andreas Merkle <[email protected]>
- * 
+ *
  * @addtogroup Application
  *
  * @{
@@ -60,14 +60,10 @@
 class App
 {
 public:
-
     /**
      * Construct the convoy leader application.
      */
-    App() :
-        m_systemStateMachine(),
-        m_controlInterval(),
-        m_smpServer(Serial)
+    App() : m_systemStateMachine(), m_controlInterval(), m_smpServer(Serial)
     {
     }
 
@@ -89,7 +85,6 @@ class App
     void loop();
 
 private:
-
     /** Differential drive control period in ms. */
     static const uint32_t DIFFERENTIAL_DRIVE_CONTROL_PERIOD = 5U;
 
@@ -129,8 +124,9 @@ class App
      */
     static void positionCallback(const uint8_t* payload, const uint8_t payloadSize);
 
-    App(const App& app);
-    App& operator=(const App& app);
+    /* Not allowed. */
+    App(const App& app);            /**< Copy construction of an instance. */
+    App& operator=(const App& app); /**< Assignment of an instance. */
 };
 
 /******************************************************************************

lib/APPConvoyLeader/DrivingState.h

@@ -127,11 +127,11 @@ class DrivingState : public IState
     SimpleTimer            m_lapTime;          /**< Timer used to calculate the lap time. */
     SimpleTimer            m_pidProcessTime;   /**< Timer used for periodically PID processing. */
     PIDController<int16_t> m_pidCtrl;          /**< PID controller, used for driving. */
-    int16_t                m_topSpeed;         /**< Top speed in [steps/s]. It might be lower or equal to the max. speed! */
-    LineStatus             m_lineStatus;       /**< Status of start-/end line detection */
-    TrackStatus            m_trackStatus;      /**< Status of track which means on track or track lost, etc. */
-    uint8_t m_startEndLineDebounce; /**< Counter used for easys debouncing of the start-/end line detection. */
-    MovAvg<int16_t, 2> m_posMovAvg; /**< The moving average of the position over 2 calling cycles. */
+    int16_t                m_topSpeed;    /**< Top speed in [steps/s]. It might be lower or equal to the max. speed! */
+    LineStatus             m_lineStatus;  /**< Status of start-/end line detection */
+    TrackStatus            m_trackStatus; /**< Status of track which means on track or track lost, etc. */
+    uint8_t m_startEndLineDebounce;       /**< Counter used for easys debouncing of the start-/end line detection. */
+    MovAvg<int16_t, 2> m_posMovAvg;       /**< The moving average of the position over 2 calling cycles. */
 
     /**
      * Default constructor.
@@ -156,23 +156,24 @@ class DrivingState : public IState
     {
     }
 
-    DrivingState(const DrivingState& state);
-    DrivingState& operator=(const DrivingState& state);
+    /* Not allowed. */
+    DrivingState(const DrivingState& state);            /**< Copy construction of an instance. */
+    DrivingState& operator=(const DrivingState& state); /**< Assignment of an instance. */
 
     /**
      * Control driving in case the robot is on track.
      *
-     * @param[in] position          Current position on track
-     * @param[in] lineSensorValue   Value of each line sensor
+     * @param[in] position           Current position on track
+     * @param[in] lineSensorValues   Value of each line sensor
      */
     void processOnTrack(int16_t position, const uint16_t* lineSensorValues);
 
     /**
      * Control driving in case the robot lost the track.
      * It handles the track search algorithm.
      *
-     * @param[in] position          Current position on track
-     * @param[in] lineSensorValue   Value of each line sensor
+     * @param[in] position           Current position on track
+     * @param[in] lineSensorValues   Value of each line sensor
      */
     void processTrackLost(int16_t position, const uint16_t* lineSensorValues);
 

lib/APPConvoyLeader/ErrorState.h

@@ -27,7 +27,7 @@
 /**
  * @brief  Error state
  * @author Andreas Merkle <[email protected]>
- * 
+ *
  * @addtogroup Application
  *
  * @{
@@ -91,21 +91,20 @@ class ErrorState : public IState
 
     /**
      * Set error message, which to show on the display.
-     * 
+     *
      * @param[in] msg   Error message
      */
     void setErrorMsg(const char* msg);
 
 protected:
 private:
-
     /**
      * The error message string size in bytes, which
      * includes the terminating character.
      */
-    static const size_t ERROR_MSG_SIZE  = 20;
+    static const size_t ERROR_MSG_SIZE = 20;
 
-    char    m_errorMsg[ERROR_MSG_SIZE]; /**< Error message, which to show. */
+    char m_errorMsg[ERROR_MSG_SIZE]; /**< Error message, which to show. */
 
     /**
      * Default constructor.
@@ -122,8 +121,9 @@ class ErrorState : public IState
     {
     }
 
-    ErrorState(const ErrorState& state);
-    ErrorState& operator=(const ErrorState& state);
+    /* Not allowed. */
+    ErrorState(const ErrorState& state);            /**< Copy construction of an instance. */
+    ErrorState& operator=(const ErrorState& state); /**< Assignment of an instance. */
 };
 
 /******************************************************************************

lib/APPConvoyLeader/LineSensorsCalibrationState.h

@@ -131,8 +131,9 @@ class LineSensorsCalibrationState : public IState
     {
     }
 
-    LineSensorsCalibrationState(const LineSensorsCalibrationState& state);
-    LineSensorsCalibrationState& operator=(const LineSensorsCalibrationState& state);
+    /* Not allowed. */
+    LineSensorsCalibrationState(const LineSensorsCalibrationState& state); /**< Copy construction of an instance. */
+    LineSensorsCalibrationState& operator=(const LineSensorsCalibrationState& state); /**< Assignment of an instance. */
 
     /**
      * Turn and calibrate the line sensors.

lib/APPConvoyLeader/MotorSpeedCalibrationState.h

@@ -137,8 +137,9 @@ class MotorSpeedCalibrationState : public IState
     {
     }
 
-    MotorSpeedCalibrationState(const MotorSpeedCalibrationState& state);
-    MotorSpeedCalibrationState& operator=(const MotorSpeedCalibrationState& state);
+    /* Not allowed. */
+    MotorSpeedCalibrationState(const MotorSpeedCalibrationState& state); /**< Copy construction of an instance. */
+    MotorSpeedCalibrationState& operator=(const MotorSpeedCalibrationState& state); /**< Assignment of an instance. */
 
     /**
      * Determine the max. motor speed, considering both driving directions.

lib/APPConvoyLeader/ParameterSets.h

@@ -27,7 +27,7 @@
 /**
  * @brief  Parameter state
  * @author Andreas Merkle <[email protected]>
- * 
+ *
  * @addtogroup Application
  *
  * @{
@@ -132,8 +132,9 @@ class ParameterSets
      */
     ~ParameterSets();
 
-    ParameterSets(const ParameterSets& set);
-    ParameterSets& operator=(const ParameterSets& set);
+    /* Not allowed. */
+    ParameterSets(const ParameterSets& set);            /**< Copy construction of an instance. */
+    ParameterSets& operator=(const ParameterSets& set); /**< Assignment of an instance. */
 };
 
 /******************************************************************************

lib/APPConvoyLeader/ReadyState.h

@@ -27,7 +27,7 @@
 /**
  * @brief  Ready state
  * @author Andreas Merkle <[email protected]>
- * 
+ *
  * @addtogroup Application
  *
  * @{
@@ -116,8 +116,9 @@ class ReadyState : public IState
     {
     }
 
-    ReadyState(const ReadyState& state);
-    ReadyState& operator=(const ReadyState& state);
+    /* Not allowed. */
+    ReadyState(const ReadyState& state);            /**< Copy construction of an instance. */
+    ReadyState& operator=(const ReadyState& state); /**< Assignment of an instance. */
 };
 
 /******************************************************************************

lib/APPConvoyLeader/ReleaseTrackState.h

@@ -27,7 +27,7 @@
 /**
  * @brief  Release track state
  * @author Andreas Merkle <[email protected]>
- * 
+ *
  * @addtogroup Application
  *
  * @{
@@ -111,8 +111,9 @@ class ReleaseTrackState : public IState
     {
     }
 
-    ReleaseTrackState(const ReleaseTrackState& state);
-    ReleaseTrackState& operator=(const ReleaseTrackState& state);
+    /* Not allowed. */
+    ReleaseTrackState(const ReleaseTrackState& state);            /**< Copy construction of an instance. */
+    ReleaseTrackState& operator=(const ReleaseTrackState& state); /**< Assignment of an instance. */
 
     /**
      * Show choosen parameter set on LCD.

lib/APPConvoyLeader/StartupState.h

@@ -27,7 +27,7 @@
 /**
  * @brief  Startup state
  * @author Andreas Merkle <[email protected]>
- * 
+ *
  * @addtogroup Application
  *
  * @{
@@ -110,8 +110,9 @@ class StartupState : public IState
     {
     }
 
-    StartupState(const StartupState& state);
-    StartupState& operator=(const StartupState& state);
+    /* Not allowed. */
+    StartupState(const StartupState& state);            /**< Copy construction of an instance. */
+    StartupState& operator=(const StartupState& state); /**< Assignment of an instance. */
 };
 
 /******************************************************************************

lib/APPLineFollower/App.h

@@ -96,8 +96,9 @@ class App
     /** Timer used for differential drive control processing. */
     SimpleTimer m_controlInterval;
 
-    App(const App& app);
-    App& operator=(const App& app);
+    /* Not allowed. */
+    App(const App& app);            /**< Copy construction of an instance. */
+    App& operator=(const App& app); /**< Assignment of an instance. */
 };
 
 /******************************************************************************

lib/APPLineFollower/DrivingState.h

@@ -127,11 +127,11 @@ class DrivingState : public IState
     SimpleTimer            m_lapTime;          /**< Timer used to calculate the lap time. */
     SimpleTimer            m_pidProcessTime;   /**< Timer used for periodically PID processing. */
     PIDController<int16_t> m_pidCtrl;          /**< PID controller, used for driving. */
-    int16_t                m_topSpeed;         /**< Top speed in [steps/s]. It might be lower or equal to the max. speed! */
-    LineStatus             m_lineStatus;       /**< Status of start-/end line detection */
-    TrackStatus            m_trackStatus;      /**< Status of track which means on track or track lost, etc. */
-    uint8_t m_startEndLineDebounce; /**< Counter used for easys debouncing of the start-/end line detection. */
-    MovAvg<int16_t, 2> m_posMovAvg; /**< The moving average of the position over 2 calling cycles. */
+    int16_t                m_topSpeed;    /**< Top speed in [steps/s]. It might be lower or equal to the max. speed! */
+    LineStatus             m_lineStatus;  /**< Status of start-/end line detection */
+    TrackStatus            m_trackStatus; /**< Status of track which means on track or track lost, etc. */
+    uint8_t m_startEndLineDebounce;       /**< Counter used for easys debouncing of the start-/end line detection. */
+    MovAvg<int16_t, 2> m_posMovAvg;       /**< The moving average of the position over 2 calling cycles. */
 
     /**
      * Default constructor.
@@ -156,23 +156,24 @@ class DrivingState : public IState
     {
     }
 
-    DrivingState(const DrivingState& state);
-    DrivingState& operator=(const DrivingState& state);
+    /* Not allowed. */
+    DrivingState(const DrivingState& state);            /**< Copy construction of an instance. */
+    DrivingState& operator=(const DrivingState& state); /**< Assignment of an instance. */
 
     /**
      * Control driving in case the robot is on track.
      *
-     * @param[in] position          Current position on track
-     * @param[in] lineSensorValue   Value of each line sensor
+     * @param[in] position           Current position on track
+     * @param[in] lineSensorValues   Value of each line sensor
      */
     void processOnTrack(int16_t position, const uint16_t* lineSensorValues);
 
     /**
      * Control driving in case the robot lost the track.
      * It handles the track search algorithm.
      *
-     * @param[in] position          Current position on track
-     * @param[in] lineSensorValue   Value of each line sensor
+     * @param[in] position           Current position on track
+     * @param[in] lineSensorValues   Value of each line sensor
      */
     void processTrackLost(int16_t position, const uint16_t* lineSensorValues);
 

lib/APPLineFollower/ErrorState.h

@@ -27,7 +27,7 @@
 /**
  * @brief  Error state
  * @author Andreas Merkle <[email protected]>
- * 
+ *
  * @addtogroup Application
  *
  * @{
@@ -91,21 +91,20 @@ class ErrorState : public IState
 
     /**
      * Set error message, which to show on the display.
-     * 
+     *
      * @param[in] msg   Error message
      */
     void setErrorMsg(const char* msg);
 
 protected:
 private:
-
     /**
      * The error message string size in bytes, which
      * includes the terminating character.
      */
-    static const size_t ERROR_MSG_SIZE  = 20;
+    static const size_t ERROR_MSG_SIZE = 20;
 
-    char    m_errorMsg[ERROR_MSG_SIZE]; /**< Error message, which to show. */
+    char m_errorMsg[ERROR_MSG_SIZE]; /**< Error message, which to show. */
 
     /**
      * Default constructor.
@@ -122,8 +121,9 @@ class ErrorState : public IState
     {
     }
 
-    ErrorState(const ErrorState& state);
-    ErrorState& operator=(const ErrorState& state);
+    /* Not allowed. */
+    ErrorState(const ErrorState& state);            /**< Copy construction of an instance. */
+    ErrorState& operator=(const ErrorState& state); /**< Assignment of an instance. */
 };
 
 /******************************************************************************

lib/APPLineFollower/LineSensorsCalibrationState.h

@@ -131,8 +131,9 @@ class LineSensorsCalibrationState : public IState
     {
     }
 
-    LineSensorsCalibrationState(const LineSensorsCalibrationState& state);
-    LineSensorsCalibrationState& operator=(const LineSensorsCalibrationState& state);
+    /* Not allowed. */
+    LineSensorsCalibrationState(const LineSensorsCalibrationState& state); /**< Copy construction of an instance. */
+    LineSensorsCalibrationState& operator=(const LineSensorsCalibrationState& state); /**< Assignment of an instance. */
 
     /**
      * Turn and calibrate the line sensors.

lib/APPLineFollower/MotorSpeedCalibrationState.h

@@ -137,8 +137,9 @@ class MotorSpeedCalibrationState : public IState
     {
     }
 
-    MotorSpeedCalibrationState(const MotorSpeedCalibrationState& state);
-    MotorSpeedCalibrationState& operator=(const MotorSpeedCalibrationState& state);
+    /* Not allowed. */
+    MotorSpeedCalibrationState(const MotorSpeedCalibrationState& state); /**< Copy construction of an instance. */
+    MotorSpeedCalibrationState& operator=(const MotorSpeedCalibrationState& state); /**< Assignment of an instance. */
 
     /**
      * Determine the max. motor speed, considering both driving directions.

lib/APPLineFollower/ParameterSets.h

@@ -27,7 +27,7 @@
 /**
  * @brief  Parameter state
  * @author Andreas Merkle <[email protected]>
- * 
+ *
  * @addtogroup Application
  *
  * @{
@@ -132,8 +132,9 @@ class ParameterSets
      */
     ~ParameterSets();
 
-    ParameterSets(const ParameterSets& set);
-    ParameterSets& operator=(const ParameterSets& set);
+    /* Not allowed. */
+    ParameterSets(const ParameterSets& set);            /**< Copy construction of an instance. */
+    ParameterSets& operator=(const ParameterSets& set); /**< Assignment of an instance. */
 };
 
 /******************************************************************************