From 1b5104ed910a2405d18f57095f69a1d96932f7a4 Mon Sep 17 00:00:00 2001 From: Gabryel Reyes Date: Wed, 26 Jun 2024 15:02:01 +0200 Subject: [PATCH] Fixed doxygen findings --- lib/APPCalib/src/App.h | 20 ++++++++++-- lib/APPCalib/src/DrivingState.h | 20 ++++++++++-- lib/APPCalib/src/ErrorState.h | 20 ++++++++++-- lib/APPCalib/src/MotorSpeedCalibrationState.h | 20 ++++++++++-- lib/APPCalib/src/ReadyState.h | 20 ++++++++++-- lib/APPCalib/src/StartupState.h | 20 ++++++++++-- lib/APPConvoyFollower/src/App.h | 20 ++++++++++-- lib/APPConvoyFollower/src/DrivingState.h | 20 ++++++++++-- lib/APPConvoyFollower/src/ErrorState.h | 20 ++++++++++-- .../src/LineSensorsCalibrationState.h | 20 ++++++++++-- lib/APPConvoyFollower/src/StartupState.h | 20 ++++++++++-- lib/APPConvoyLeader/src/App.h | 20 ++++++++++-- lib/APPConvoyLeader/src/DrivingState.h | 20 ++++++++++-- lib/APPConvoyLeader/src/ErrorState.h | 20 ++++++++++-- .../src/LineSensorsCalibrationState.h | 20 ++++++++++-- lib/APPConvoyLeader/src/ParameterSets.h | 20 ++++++++++-- lib/APPConvoyLeader/src/StartupState.h | 20 ++++++++++-- lib/APPLineFollower/src/App.h | 20 ++++++++++-- lib/APPLineFollower/src/DrivingState.h | 32 +++++++++++++------ lib/APPLineFollower/src/ErrorState.h | 20 ++++++++++-- .../src/LineSensorsCalibrationState.h | 20 ++++++++++-- .../src/MotorSpeedCalibrationState.h | 20 ++++++++++-- lib/APPLineFollower/src/ParameterSets.h | 20 ++++++++++-- lib/APPLineFollower/src/ReadyState.h | 20 ++++++++++-- lib/APPLineFollower/src/ReleaseTrackState.h | 20 ++++++++++-- lib/APPLineFollower/src/StartupState.h | 20 ++++++++++-- lib/APPRemoteControl/src/App.h | 20 ++++++++++-- lib/APPRemoteControl/src/DrivingState.h | 20 ++++++++++-- lib/APPRemoteControl/src/ErrorState.h | 20 ++++++++++-- .../src/LineSensorsCalibrationState.h | 20 ++++++++++-- lib/APPRemoteControl/src/StartupState.h | 20 ++++++++++-- lib/APPSensorFusion/src/App.h | 20 ++++++++++-- lib/APPSensorFusion/src/DrivingState.h | 29 +++++++++++++---- lib/APPSensorFusion/src/ErrorState.h | 20 ++++++++++-- .../src/LineSensorsCalibrationState.h | 20 ++++++++++-- lib/APPSensorFusion/src/ParameterSets.h | 20 ++++++++++-- lib/APPSensorFusion/src/ReadyState.h | 20 ++++++++++-- lib/APPSensorFusion/src/ReleaseTrackState.h | 20 ++++++++++-- lib/APPSensorFusion/src/StartupState.h | 20 ++++++++++-- lib/APPTest/src/App.h | 19 +++++++++-- lib/Service/src/DifferentialDrive.h | 20 ++++++++++-- lib/Service/src/MovAvg.hpp | 20 ++++++++++-- lib/Service/src/Odometry.h | 23 ++++++++++--- lib/Service/src/RelativeEncoders.h | 27 +++++++++++++--- lib/Service/src/SimpleTimer.h | 6 +++- lib/Service/src/Speedometer.h | 20 ++++++++++-- lib/Service/src/StateMachine.h | 20 ++++++++++-- 47 files changed, 805 insertions(+), 151 deletions(-) diff --git a/lib/APPCalib/src/App.h b/lib/APPCalib/src/App.h index e2ffbae0..8e520108 100644 --- 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 index 3c593561..b0052873 100644 --- 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 index 0679e9a3..b560f3d3 100644 --- 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 index f4ea0bcc..33e820aa 100644 --- 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 index 27721365..40f52094 100644 --- 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 index 4be1f2d2..9c1e3a0a 100644 --- 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 index 7db5be14..9b9ca35f 100644 --- 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 index 92f48a94..b50d2377 100644 --- 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 index 0679e9a3..b560f3d3 100644 --- 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 index 1ee29963..d6dcafe6 100644 --- 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 index b8d40db3..29d3e00b 100644 --- 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 index a2f91cbb..a3568197 100644 --- 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 index 3cdcde83..daf4d09d 100644 --- 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 index 0679e9a3..b560f3d3 100644 --- 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); }; /****************************************************************************** diff --git a/lib/APPConvoyLeader/src/LineSensorsCalibrationState.h b/lib/APPConvoyLeader/src/LineSensorsCalibrationState.h index 1ee29963..d6dcafe6 100644 --- a/lib/APPConvoyLeader/src/LineSensorsCalibrationState.h +++ b/lib/APPConvoyLeader/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/APPConvoyLeader/src/ParameterSets.h b/lib/APPConvoyLeader/src/ParameterSets.h index a046236a..56fd9b81 100644 --- a/lib/APPConvoyLeader/src/ParameterSets.h +++ b/lib/APPConvoyLeader/src/ParameterSets.h @@ -132,9 +132,23 @@ class ParameterSets */ ~ParameterSets(); - /* Not allowed. */ - ParameterSets(const ParameterSets& set); /**< Copy construction of an instance. */ - ParameterSets& operator=(const ParameterSets& set); /**< Assignment of an instance. */ + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] set Source instance. + */ + ParameterSets(const ParameterSets& set); + + /** + * Assignment of an instance. + * Not allowed. + * + * @param[in] set Source instance. + * + * @returns Reference to ParameterSets. + */ + ParameterSets& operator=(const ParameterSets& set); }; /****************************************************************************** diff --git a/lib/APPConvoyLeader/src/StartupState.h b/lib/APPConvoyLeader/src/StartupState.h index 99f8a1a5..e8e99969 100644 --- a/lib/APPConvoyLeader/src/StartupState.h +++ b/lib/APPConvoyLeader/src/StartupState.h @@ -118,9 +118,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/APPLineFollower/src/App.h b/lib/APPLineFollower/src/App.h index dc5e939e..b09e1c8f 100644 --- a/lib/APPLineFollower/src/App.h +++ b/lib/APPLineFollower/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/APPLineFollower/src/DrivingState.h b/lib/APPLineFollower/src/DrivingState.h index cef98de6..5a94b5c7 100644 --- a/lib/APPLineFollower/src/DrivingState.h +++ b/lib/APPLineFollower/src/DrivingState.h @@ -193,7 +193,7 @@ class DrivingState : public IState bool m_isStartStopLineDetected; /**< Is the start/stop line detected? */ uint8_t m_lastSensorIdSawTrack; /**< The sensor id of the sensor which saw the track as last. */ int16_t m_lastPosition; /**< Last position, used to decide strategy in case of a track gap. */ - bool m_isTrackLost; /**< Is the track lost? Lost means the line sensors didn't detect it. */ + bool m_isTrackLost; /**< Is the track lost? Lost means the line sensors didn't detect it. */ /** * Default constructor. @@ -207,9 +207,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); /** * Calculate the position with the inner 3 line sensors. @@ -226,16 +240,17 @@ class DrivingState : public IState * Evaluate the situation by line sensor values and position and determine * the track status. The result influences the measures to keep track on * the line. - * + * * @param[in] lineSensorValues The line sensor values as array. * @param[in] length The number of line sensor values. * @param[in] position The position calculated with all sensors. * @param[in] position3 The position calculated with the inner 3 sensors only. * @param[in] isTrackLost Information whether the track is lost or not. - * + * * @return The track status result. */ - TrackStatus evaluateSituation(const uint16_t* lineSensorValues, uint8_t length, int16_t position, int16_t position3, bool isTrackLost) const; + TrackStatus evaluateSituation(const uint16_t* lineSensorValues, uint8_t length, int16_t position, int16_t position3, + bool isTrackLost) const; /** * Is the start/stop line detected? @@ -327,11 +342,10 @@ class DrivingState : public IState */ bool isAbortRequired(); - #ifdef DEBUG_ALGORITHM /** * Required for debugging purposes. - * + * * @param[in] trackStatus The track status. */ friend void logCsvDataTrackStatus(TrackStatus trackStatus); diff --git a/lib/APPLineFollower/src/ErrorState.h b/lib/APPLineFollower/src/ErrorState.h index 0679e9a3..b560f3d3 100644 --- a/lib/APPLineFollower/src/ErrorState.h +++ b/lib/APPLineFollower/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/APPLineFollower/src/LineSensorsCalibrationState.h b/lib/APPLineFollower/src/LineSensorsCalibrationState.h index e9336431..3569fe72 100644 --- a/lib/APPLineFollower/src/LineSensorsCalibrationState.h +++ b/lib/APPLineFollower/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/APPLineFollower/src/MotorSpeedCalibrationState.h b/lib/APPLineFollower/src/MotorSpeedCalibrationState.h index f4ea0bcc..33e820aa 100644 --- a/lib/APPLineFollower/src/MotorSpeedCalibrationState.h +++ b/lib/APPLineFollower/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/APPLineFollower/src/ParameterSets.h b/lib/APPLineFollower/src/ParameterSets.h index a046236a..56fd9b81 100644 --- a/lib/APPLineFollower/src/ParameterSets.h +++ b/lib/APPLineFollower/src/ParameterSets.h @@ -132,9 +132,23 @@ class ParameterSets */ ~ParameterSets(); - /* Not allowed. */ - ParameterSets(const ParameterSets& set); /**< Copy construction of an instance. */ - ParameterSets& operator=(const ParameterSets& set); /**< Assignment of an instance. */ + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] set Source instance. + */ + ParameterSets(const ParameterSets& set); + + /** + * Assignment of an instance. + * Not allowed. + * + * @param[in] set Source instance. + * + * @returns Reference to ParameterSets. + */ + ParameterSets& operator=(const ParameterSets& set); }; /****************************************************************************** diff --git a/lib/APPLineFollower/src/ReadyState.h b/lib/APPLineFollower/src/ReadyState.h index f14b6e64..ec257eea 100644 --- a/lib/APPLineFollower/src/ReadyState.h +++ b/lib/APPLineFollower/src/ReadyState.h @@ -116,9 +116,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 ErrorState instance. + */ + ReadyState& operator=(const ReadyState& state); }; /****************************************************************************** diff --git a/lib/APPLineFollower/src/ReleaseTrackState.h b/lib/APPLineFollower/src/ReleaseTrackState.h index 1a92031b..e66e9faf 100644 --- a/lib/APPLineFollower/src/ReleaseTrackState.h +++ b/lib/APPLineFollower/src/ReleaseTrackState.h @@ -111,9 +111,23 @@ class ReleaseTrackState : public IState { } - /* Not allowed. */ - ReleaseTrackState(const ReleaseTrackState& state); /**< Copy construction of an instance. */ - ReleaseTrackState& operator=(const ReleaseTrackState& state); /**< Assignment of an instance. */ + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] state Source instance. + */ + ReleaseTrackState(const ReleaseTrackState& state); + + /** + * Assignment of an instance. + * Not allowed. + * + * @param[in] state Source instance. + * + * @returns Reference to ReleaseTrackState. + */ + ReleaseTrackState& operator=(const ReleaseTrackState& state); /** * Show choosen parameter set on LCD. diff --git a/lib/APPLineFollower/src/StartupState.h b/lib/APPLineFollower/src/StartupState.h index e50cc304..44aea30e 100644 --- a/lib/APPLineFollower/src/StartupState.h +++ b/lib/APPLineFollower/src/StartupState.h @@ -128,9 +128,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/APPRemoteControl/src/App.h b/lib/APPRemoteControl/src/App.h index c9405b0a..9f9f21c2 100644 --- a/lib/APPRemoteControl/src/App.h +++ b/lib/APPRemoteControl/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/APPRemoteControl/src/DrivingState.h b/lib/APPRemoteControl/src/DrivingState.h index 92f48a94..b50d2377 100644 --- a/lib/APPRemoteControl/src/DrivingState.h +++ b/lib/APPRemoteControl/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/APPRemoteControl/src/ErrorState.h b/lib/APPRemoteControl/src/ErrorState.h index 0679e9a3..b560f3d3 100644 --- a/lib/APPRemoteControl/src/ErrorState.h +++ b/lib/APPRemoteControl/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/APPRemoteControl/src/LineSensorsCalibrationState.h b/lib/APPRemoteControl/src/LineSensorsCalibrationState.h index 1ee29963..d6dcafe6 100644 --- a/lib/APPRemoteControl/src/LineSensorsCalibrationState.h +++ b/lib/APPRemoteControl/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/APPRemoteControl/src/StartupState.h b/lib/APPRemoteControl/src/StartupState.h index b8d40db3..29d3e00b 100644 --- a/lib/APPRemoteControl/src/StartupState.h +++ b/lib/APPRemoteControl/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/APPSensorFusion/src/App.h b/lib/APPSensorFusion/src/App.h index 24bb8f95..43df8dd6 100644 --- a/lib/APPSensorFusion/src/App.h +++ b/lib/APPSensorFusion/src/App.h @@ -125,9 +125,23 @@ class App */ void sendSensorData(); - /* 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/APPSensorFusion/src/DrivingState.h b/lib/APPSensorFusion/src/DrivingState.h index 2c67fdb5..e75cfb6e 100644 --- a/lib/APPSensorFusion/src/DrivingState.h +++ b/lib/APPSensorFusion/src/DrivingState.h @@ -193,7 +193,7 @@ class DrivingState : public IState bool m_isStartStopLineDetected; /**< Is the start/stop line detected? */ uint8_t m_lastSensorIdSawTrack; /**< The sensor id of the sensor which saw the track as last. */ int16_t m_lastPosition; /**< Last position, used to decide strategy in case of a track gap. */ - bool m_isTrackLost; /**< Is the track lost? Lost means the line sensors didn't detect it. */ + bool m_isTrackLost; /**< Is the track lost? Lost means the line sensors didn't detect it. */ /** * Default constructor. @@ -207,9 +207,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. + */ + DrivingState& operator=(const DrivingState& state); /** * Calculate the position with the inner 3 line sensors. @@ -226,16 +240,17 @@ class DrivingState : public IState * Evaluate the situation by line sensor values and position and determine * the track status. The result influences the measures to keep track on * the line. - * + * * @param[in] lineSensorValues The line sensor values as array. * @param[in] length The number of line sensor values. * @param[in] position The position calculated with all sensors. * @param[in] position3 The position calculated with the inner 3 sensors only. * @param[in] isTrackLost Information whether the track is lost or not. - * + * * @return The track status result. */ - TrackStatus evaluateSituation(const uint16_t* lineSensorValues, uint8_t length, int16_t position, int16_t position3, bool isTrackLost) const; + TrackStatus evaluateSituation(const uint16_t* lineSensorValues, uint8_t length, int16_t position, int16_t position3, + bool isTrackLost) const; /** * Is the start/stop line detected? diff --git a/lib/APPSensorFusion/src/ErrorState.h b/lib/APPSensorFusion/src/ErrorState.h index be0bd212..fd48ff4f 100644 --- a/lib/APPSensorFusion/src/ErrorState.h +++ b/lib/APPSensorFusion/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/APPSensorFusion/src/LineSensorsCalibrationState.h b/lib/APPSensorFusion/src/LineSensorsCalibrationState.h index 1ee29963..d6dcafe6 100644 --- a/lib/APPSensorFusion/src/LineSensorsCalibrationState.h +++ b/lib/APPSensorFusion/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/APPSensorFusion/src/ParameterSets.h b/lib/APPSensorFusion/src/ParameterSets.h index a046236a..56fd9b81 100644 --- a/lib/APPSensorFusion/src/ParameterSets.h +++ b/lib/APPSensorFusion/src/ParameterSets.h @@ -132,9 +132,23 @@ class ParameterSets */ ~ParameterSets(); - /* Not allowed. */ - ParameterSets(const ParameterSets& set); /**< Copy construction of an instance. */ - ParameterSets& operator=(const ParameterSets& set); /**< Assignment of an instance. */ + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] set Source instance. + */ + ParameterSets(const ParameterSets& set); + + /** + * Assignment of an instance. + * Not allowed. + * + * @param[in] set Source instance. + * + * @returns Reference to ParameterSets. + */ + ParameterSets& operator=(const ParameterSets& set); }; /****************************************************************************** diff --git a/lib/APPSensorFusion/src/ReadyState.h b/lib/APPSensorFusion/src/ReadyState.h index f14b6e64..ec257eea 100644 --- a/lib/APPSensorFusion/src/ReadyState.h +++ b/lib/APPSensorFusion/src/ReadyState.h @@ -116,9 +116,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 ErrorState instance. + */ + ReadyState& operator=(const ReadyState& state); }; /****************************************************************************** diff --git a/lib/APPSensorFusion/src/ReleaseTrackState.h b/lib/APPSensorFusion/src/ReleaseTrackState.h index 1a92031b..e66e9faf 100644 --- a/lib/APPSensorFusion/src/ReleaseTrackState.h +++ b/lib/APPSensorFusion/src/ReleaseTrackState.h @@ -111,9 +111,23 @@ class ReleaseTrackState : public IState { } - /* Not allowed. */ - ReleaseTrackState(const ReleaseTrackState& state); /**< Copy construction of an instance. */ - ReleaseTrackState& operator=(const ReleaseTrackState& state); /**< Assignment of an instance. */ + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] state Source instance. + */ + ReleaseTrackState(const ReleaseTrackState& state); + + /** + * Assignment of an instance. + * Not allowed. + * + * @param[in] state Source instance. + * + * @returns Reference to ReleaseTrackState. + */ + ReleaseTrackState& operator=(const ReleaseTrackState& state); /** * Show choosen parameter set on LCD. diff --git a/lib/APPSensorFusion/src/StartupState.h b/lib/APPSensorFusion/src/StartupState.h index c09f981e..1902bb95 100644 --- a/lib/APPSensorFusion/src/StartupState.h +++ b/lib/APPSensorFusion/src/StartupState.h @@ -105,9 +105,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/APPTest/src/App.h b/lib/APPTest/src/App.h index 4580d13e..9b6c104b 100644 --- a/lib/APPTest/src/App.h +++ b/lib/APPTest/src/App.h @@ -82,10 +82,23 @@ class App void loop(); private: + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] app Source instance. + */ + App(const App& app); - /* Not allowed. */ - App(const App& app); /**< Copy construction of an instance. */ - App& operator=(const App& app); /**< Assignment of an instance. */ + /** + * 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/Service/src/DifferentialDrive.h b/lib/Service/src/DifferentialDrive.h index f6be652a..328a88da 100644 --- a/lib/Service/src/DifferentialDrive.h +++ b/lib/Service/src/DifferentialDrive.h @@ -238,9 +238,23 @@ class DifferentialDrive /* Never called. */ } - /* Not allowed. */ - DifferentialDrive(const DifferentialDrive& diffDrive); /**< Copy construction of an instance. */ - DifferentialDrive& operator=(const DifferentialDrive& diffDrive); /**< Assignment of an instance. */ + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] diffDrive Source instance. + */ + DifferentialDrive(const DifferentialDrive& diffDrive); + + /** + * Assignment of an instance. + * Not allowed. + * + * @param[in] diffDrive Source instance. + * + * @return Reference to DifferentialDrive instance. + */ + DifferentialDrive& operator=(const DifferentialDrive& diffDrive); /** * Calculate the linear speed left and right from the linear speed center and diff --git a/lib/Service/src/MovAvg.hpp b/lib/Service/src/MovAvg.hpp index 79678b81..fada3d00 100644 --- a/lib/Service/src/MovAvg.hpp +++ b/lib/Service/src/MovAvg.hpp @@ -151,9 +151,23 @@ class MovAvg uint8_t m_written; /**< The number of written values to the list of values, till length is reached. */ T m_sum; /**< Sum of all values */ - /* Not allowed. */ - MovAvg(const MovAvg& avg); /**< Copy construction of an instance. */ - MovAvg& operator=(const MovAvg& avg); /**< Assignment of an instance. */ + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] avg source instance + */ + MovAvg(const MovAvg& avg); + + /** + * Assignment operation. + * Not allowed. + * + * @param[in] avg Right hand side instance. + * + * @return Reference to MovAvg instance + */ + MovAvg& operator=(const MovAvg& avg); }; /****************************************************************************** diff --git a/lib/Service/src/Odometry.h b/lib/Service/src/Odometry.h index 1a88c947..920cabb8 100644 --- a/lib/Service/src/Odometry.h +++ b/lib/Service/src/Odometry.h @@ -250,17 +250,32 @@ class Odometry { } - /* Not allowed. */ - Odometry(const Odometry& value); /**< Copy construction of an instance. */ - Odometry& operator=(const Odometry& value); /**< Assignment of an instance. */ + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] value source instance + */ + Odometry(const Odometry& value); + + /** + * Assignment operation. + * Not allowed. + * + * @param[in] value Right hand side instance. + * + * @return Reference to Odometry instance + */ + Odometry& operator=(const Odometry& value); /** * Is the robot standstill? * * @param[in] absStepsLeft Absolute steps left * @param[in] absStepsRight Absolute steps right + * + * @return If standstill, it will return true otherwise false. */ - bool detectStandStill(uint16_t absStepsLeft, uint16_t absStepsRight); /** diff --git a/lib/Service/src/RelativeEncoders.h b/lib/Service/src/RelativeEncoders.h index 00ca2317..72c30f88 100644 --- a/lib/Service/src/RelativeEncoders.h +++ b/lib/Service/src/RelativeEncoders.h @@ -128,10 +128,29 @@ class RelativeEncoders */ int16_t m_referencePointRight; - /* Not allowed. */ - RelativeEncoders(); /**< Default constructor. */ - RelativeEncoders(const RelativeEncoders& relEncoder); /**< Copy construction of an instance. */ - RelativeEncoders& operator=(const RelativeEncoders& relEncoder); /**< Assignment of an instance. */ + /** + * Default constructor. + * Not allowed. + */ + RelativeEncoders(); + + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] relEncoder Relative encoders instance, which shall be copied. + */ + RelativeEncoders(const RelativeEncoders& relEncoder); + + /** + * Assignment of an instance. + * Not allowed. + * + * @param[in] relEncoder Relative encoders instance, which shall be assigned. + * + * @return Reference to relative encoders instance + */ + RelativeEncoders& operator=(const RelativeEncoders& relEncoder); }; /****************************************************************************** diff --git a/lib/Service/src/SimpleTimer.h b/lib/Service/src/SimpleTimer.h index 7c01bb61..a4c9f83a 100644 --- a/lib/Service/src/SimpleTimer.h +++ b/lib/Service/src/SimpleTimer.h @@ -27,7 +27,7 @@ /** * @brief Simple timer * @author Andreas Merkle - * + * * @addtogroup Service * * @{ @@ -81,6 +81,8 @@ class SimpleTimer * Default assignment operator. * * @param[in] timer The timer to be assigned. + * + * @return Reference of this timer. */ SimpleTimer& operator=(const SimpleTimer& timer) { @@ -138,6 +140,8 @@ class SimpleTimer /** * Get current duration in ms, till the timer was started. * It is independed of whether the timer is stopped or timeout. + * + * @return Current duration in ms */ uint32_t getCurrentDuration() const; diff --git a/lib/Service/src/Speedometer.h b/lib/Service/src/Speedometer.h index 4d2d3f06..d5f01248 100644 --- a/lib/Service/src/Speedometer.h +++ b/lib/Service/src/Speedometer.h @@ -159,9 +159,23 @@ class Speedometer { } - /* Not allowed. */ - Speedometer(const Speedometer& value); /**< Copy construction of an instance. */ - Speedometer& operator=(const Speedometer& value); /**< Assignment of an instance. */ + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] value Source instance. + */ + Speedometer(const Speedometer& value); + + /** + * Assignment operation. + * Not allowed. + * + * @param[in] value Right hand side instance. + * + * @returns Reference to Speedometerinstance. + */ + Speedometer& operator=(const Speedometer& value); /** * Get the direction of movement left. diff --git a/lib/Service/src/StateMachine.h b/lib/Service/src/StateMachine.h index 24da1d25..a59163a2 100644 --- a/lib/Service/src/StateMachine.h +++ b/lib/Service/src/StateMachine.h @@ -101,9 +101,23 @@ class StateMachine IState* m_currentState; /**< Current active state */ IState* m_nextState; /**< Next state */ - /* Not allowed. */ - StateMachine(const StateMachine& sm); /**< Copy construction of an instance. */ - StateMachine& operator=(const StateMachine& sm); /**< Assignment of an instance. */ + /** + * Copy construction of an instance. + * Not allowed. + * + * @param[in] sm Source instance. + */ + StateMachine(const StateMachine& sm); + + /** + * Assignment operation. + * Not allowed. + * + * @param[in] sm Right hand side instance. + * + * @returns Reference to StateMachine instance. + */ + StateMachine& operator=(const StateMachine& sm); }; /******************************************************************************