Adding comments

BlueAndi · Jul 29, 2024 · c8c3094 · c8c3094
1 parent f589e5c
commit c8c3094
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 9 deletions.
diff --git a/lib/APPReinforcementLearning/src/ErrorState.h b/lib/APPReinforcementLearning/src/ErrorState.h
@@ -122,9 +122,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/APPReinforcementLearning/src/LineSensorsCalibrationState.h b/lib/APPReinforcementLearning/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/APPReinforcementLearning/src/MotorSpeedCalibrationState.h b/lib/APPReinforcementLearning/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.