Fixed doxygen findings

BlueAndi · Jun 26, 2024 · 1b5104e · 1b5104e
1 parent 54ad700
commit 1b5104e
Show file tree

Hide file tree

Showing 47 changed files with 805 additions and 151 deletions.
diff --git a/lib/APPCalib/src/App.h b/lib/APPCalib/src/App.h
@@ -96,9 +96,23 @@ class App
     /** Timer used for differential drive control processing. */
     SimpleTimer m_controlInterval;
 
-    /* Not allowed. */
-    App(const App& app);            /**< Copy construction of an instance. */
-    App& operator=(const App& app); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] app Source instance.
+     */
+    App(const App& app);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] app Source instance.
+     *
+     * @returns Reference to App instance.
+     */
+    App& operator=(const App& app);
 };
 
 /******************************************************************************

diff --git a/lib/APPCalib/src/DrivingState.h b/lib/APPCalib/src/DrivingState.h
@@ -137,9 +137,23 @@ class DrivingState : public IState
     {
     }
 
-    /* Not allowed. */
-    DrivingState(const DrivingState& state);            /**< Copy construction of an instance. */
-    DrivingState& operator=(const DrivingState& state); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     */
+    DrivingState(const DrivingState& state);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     *
+     * @returns Reference to DrivingState instance.
+     */
+    DrivingState& operator=(const DrivingState& state);
 };
 
 /******************************************************************************

diff --git a/lib/APPCalib/src/ErrorState.h b/lib/APPCalib/src/ErrorState.h
@@ -121,9 +121,23 @@ class ErrorState : public IState
     {
     }
 
-    /* Not allowed. */
-    ErrorState(const ErrorState& state);            /**< Copy construction of an instance. */
-    ErrorState& operator=(const ErrorState& state); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     */
+    ErrorState(const ErrorState& state);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     *
+     * @returns Reference to ErrorState instance.
+     */
+    ErrorState& operator=(const ErrorState& state);
 };
 
 /******************************************************************************

diff --git a/lib/APPCalib/src/MotorSpeedCalibrationState.h b/lib/APPCalib/src/MotorSpeedCalibrationState.h
@@ -137,9 +137,23 @@ class MotorSpeedCalibrationState : public IState
     {
     }
 
-    /* Not allowed. */
-    MotorSpeedCalibrationState(const MotorSpeedCalibrationState& state); /**< Copy construction of an instance. */
-    MotorSpeedCalibrationState& operator=(const MotorSpeedCalibrationState& state); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     */
+    MotorSpeedCalibrationState(const MotorSpeedCalibrationState& state);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     *
+     * @returns Reference to MotorSpeedCalibrationStateinstance.
+     */
+    MotorSpeedCalibrationState& operator=(const MotorSpeedCalibrationState& state);
 
     /**
      * Determine the max. motor speed, considering both driving directions.

diff --git a/lib/APPCalib/src/ReadyState.h b/lib/APPCalib/src/ReadyState.h
@@ -130,9 +130,23 @@ class ReadyState : public IState
     {
     }
 
-    /* Not allowed. */
-    ReadyState(const ReadyState& state);            /**< Copy construction of an instance. */
-    ReadyState& operator=(const ReadyState& state); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     */
+    ReadyState(const ReadyState& state);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     *
+     * @returns Reference to ReadyState instance.
+     */
+    ReadyState& operator=(const ReadyState& state);
 
     /**
      * Show next user info.

diff --git a/lib/APPCalib/src/StartupState.h b/lib/APPCalib/src/StartupState.h
@@ -127,9 +127,23 @@ class StartupState : public IState
     {
     }
 
-    /* Not allowed. */
-    StartupState(const StartupState& state);            /**< Copy construction of an instance. */
-    StartupState& operator=(const StartupState& state); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     */
+    StartupState(const StartupState& state);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     *
+     * @returns Reference to StartupState instance.
+     */
+    StartupState& operator=(const StartupState& state);
 
     /**
      * Show next user info.

diff --git a/lib/APPConvoyFollower/src/App.h b/lib/APPConvoyFollower/src/App.h
@@ -193,9 +193,23 @@ class App
      */
     void sendLineSensorsData() const;
 
-    /* Not allowed. */
-    App(const App& app);            /**< Copy construction of an instance. */
-    App& operator=(const App& app); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] app Source instance.
+     */
+    App(const App& app);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] app Source instance.
+     *
+     * @returns Reference to App instance.
+     */
+    App& operator=(const App& app);
 };
 
 /******************************************************************************

diff --git a/lib/APPConvoyFollower/src/DrivingState.h b/lib/APPConvoyFollower/src/DrivingState.h
@@ -117,9 +117,23 @@ class DrivingState : public IState
     {
     }
 
-    /* Not allowed. */
-    DrivingState(const DrivingState& state);            /**< Copy construction of an instance. */
-    DrivingState& operator=(const DrivingState& state); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     */
+    DrivingState(const DrivingState& state);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     *
+     * @returns Reference to DrivingState instance.
+     */
+    DrivingState& operator=(const DrivingState& state);
 };
 
 /******************************************************************************

diff --git a/lib/APPConvoyFollower/src/ErrorState.h b/lib/APPConvoyFollower/src/ErrorState.h
@@ -121,9 +121,23 @@ class ErrorState : public IState
     {
     }
 
-    /* Not allowed. */
-    ErrorState(const ErrorState& state);            /**< Copy construction of an instance. */
-    ErrorState& operator=(const ErrorState& state); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     */
+    ErrorState(const ErrorState& state);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     *
+     * @returns Reference to ErrorState instance.
+     */
+    ErrorState& operator=(const ErrorState& state);
 };
 
 /******************************************************************************

diff --git a/lib/APPConvoyFollower/src/LineSensorsCalibrationState.h b/lib/APPConvoyFollower/src/LineSensorsCalibrationState.h
@@ -131,9 +131,23 @@ class LineSensorsCalibrationState : public IState
     {
     }
 
-    /* Not allowed. */
-    LineSensorsCalibrationState(const LineSensorsCalibrationState& state); /**< Copy construction of an instance. */
-    LineSensorsCalibrationState& operator=(const LineSensorsCalibrationState& state); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     */
+    LineSensorsCalibrationState(const LineSensorsCalibrationState& state);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     *
+     * @returns Reference to LineSensorsCalibrationState.
+     */
+    LineSensorsCalibrationState& operator=(const LineSensorsCalibrationState& state);
 
     /**
      * Turn and calibrate the line sensors.

diff --git a/lib/APPConvoyFollower/src/StartupState.h b/lib/APPConvoyFollower/src/StartupState.h
@@ -123,9 +123,23 @@ class StartupState : public IState
     {
     }
 
-    /* Not allowed. */
-    StartupState(const StartupState& state);            /**< Copy construction of an instance. */
-    StartupState& operator=(const StartupState& state); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     */
+    StartupState(const StartupState& state);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     *
+     * @returns Reference to StartupState instance.
+     */
+    StartupState& operator=(const StartupState& state);
 };
 
 /******************************************************************************

diff --git a/lib/APPConvoyLeader/src/App.h b/lib/APPConvoyLeader/src/App.h
@@ -189,9 +189,23 @@ class App
      */
     bool setupSerialMuxProt();
 
-    /* Not allowed. */
-    App(const App& app);            /**< Copy construction of an instance. */
-    App& operator=(const App& app); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] app Source instance.
+     */
+    App(const App& app);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] app Source instance.
+     *
+     * @returns Reference to App instance.
+     */
+    App& operator=(const App& app);
 };
 
 /******************************************************************************

diff --git a/lib/APPConvoyLeader/src/DrivingState.h b/lib/APPConvoyLeader/src/DrivingState.h
@@ -166,9 +166,23 @@ class DrivingState : public IState
     {
     }
 
-    /* Not allowed. */
-    DrivingState(const DrivingState& state);            /**< Copy construction of an instance. */
-    DrivingState& operator=(const DrivingState& state); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     */
+    DrivingState(const DrivingState& state);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     *
+     * @returns Reference to DrivingState instance.
+     */
+    DrivingState& operator=(const DrivingState& state);
 
     /**
      * Control driving in case the robot is on track.

diff --git a/lib/APPConvoyLeader/src/ErrorState.h b/lib/APPConvoyLeader/src/ErrorState.h
@@ -121,9 +121,23 @@ class ErrorState : public IState
     {
     }
 
-    /* Not allowed. */
-    ErrorState(const ErrorState& state);            /**< Copy construction of an instance. */
-    ErrorState& operator=(const ErrorState& state); /**< Assignment of an instance. */
+    /**
+     * Copy construction of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     */
+    ErrorState(const ErrorState& state);
+
+    /**
+     * Assignment of an instance.
+     * Not allowed.
+     *
+     * @param[in] state Source instance.
+     *
+     * @returns Reference to ErrorState instance.
+     */
+    ErrorState& operator=(const ErrorState& state);
 };
 
 /******************************************************************************