Merge branch 'main' into HeadingFinder

doc/doxygen/ConvoyLeaderSimDoxyfile

@@ -499,19 +499,19 @@ NUM_PROC_THREADS       = 1
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = YES
+EXTRACT_ALL            = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIV_VIRTUAL   = NO
+EXTRACT_PRIV_VIRTUAL   = YES
 
 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
 # scope will be included in the documentation.
@@ -523,7 +523,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,

doc/doxygen/ConvoyLeaderTargetDoxyfile

@@ -499,19 +499,19 @@ NUM_PROC_THREADS       = 1
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = YES
+EXTRACT_ALL            = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIV_VIRTUAL   = NO
+EXTRACT_PRIV_VIRTUAL   = YES
 
 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
 # scope will be included in the documentation.
@@ -523,7 +523,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,

doc/doxygen/LineFollowerSimDoxyfile

@@ -499,19 +499,19 @@ NUM_PROC_THREADS       = 1
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = YES
+EXTRACT_ALL            = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIV_VIRTUAL   = NO
+EXTRACT_PRIV_VIRTUAL   = YES
 
 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
 # scope will be included in the documentation.
@@ -523,7 +523,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,

doc/doxygen/LineFollowerTargetDoxyfile

@@ -499,19 +499,19 @@ NUM_PROC_THREADS       = 1
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = YES
+EXTRACT_ALL            = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIV_VIRTUAL   = NO
+EXTRACT_PRIV_VIRTUAL   = YES
 
 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
 # scope will be included in the documentation.
@@ -523,7 +523,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,

doc/doxygen/RemoteControlSimDoxyfile

@@ -499,19 +499,19 @@ NUM_PROC_THREADS       = 1
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = YES
+EXTRACT_ALL            = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIV_VIRTUAL   = NO
+EXTRACT_PRIV_VIRTUAL   = YES
 
 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
 # scope will be included in the documentation.
@@ -523,7 +523,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,

doc/doxygen/RemoteControlTargetDoxyfile

@@ -499,19 +499,19 @@ NUM_PROC_THREADS       = 1
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = YES
+EXTRACT_ALL            = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIV_VIRTUAL   = NO
+EXTRACT_PRIV_VIRTUAL   = YES
 
 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
 # scope will be included in the documentation.
@@ -523,7 +523,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,

lib/APPConvoyLeader/App.h

@@ -135,10 +135,9 @@ class App
      */
     void reportSpeed();
 
-private:
-    /* An instance shall not be copied or assigned. */
-    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.