From ef69ab943db54eeed43cd285381b58360e8489d9 Mon Sep 17 00:00:00 2001 From: gabryelreyes Date: Thu, 9 Nov 2023 11:33:56 +0100 Subject: [PATCH] Fixed Doxygen findings --- lib/APPConvoyLeader/App.h | 14 ++--- lib/APPConvoyLeader/DrivingState.h | 23 ++++---- lib/APPConvoyLeader/ErrorState.h | 14 ++--- .../LineSensorsCalibrationState.h | 5 +- .../MotorSpeedCalibrationState.h | 5 +- lib/APPConvoyLeader/ParameterSets.h | 7 +-- lib/APPConvoyLeader/ReadyState.h | 7 +-- lib/APPConvoyLeader/ReleaseTrackState.h | 7 +-- lib/APPConvoyLeader/StartupState.h | 7 +-- lib/APPLineFollower/App.h | 5 +- lib/APPLineFollower/DrivingState.h | 23 ++++---- lib/APPLineFollower/ErrorState.h | 14 ++--- .../LineSensorsCalibrationState.h | 5 +- .../MotorSpeedCalibrationState.h | 5 +- lib/APPLineFollower/ParameterSets.h | 7 +-- lib/APPLineFollower/ReadyState.h | 7 +-- lib/APPLineFollower/ReleaseTrackState.h | 7 +-- lib/APPLineFollower/StartupState.h | 7 +-- lib/APPRemoteControl/App.h | 5 +- lib/APPRemoteControl/ErrorState.h | 14 ++--- .../LineSensorsCalibrationState.h | 5 +- .../MotorSpeedCalibrationState.h | 5 +- lib/APPRemoteControl/RemoteCtrlState.h | 22 ++++---- lib/APPRemoteControl/SerialMuxChannels.h | 10 ++-- lib/APPRemoteControl/StartupState.h | 7 +-- lib/HALConvoyLeaderSim/Board.h | 10 +++- lib/HALLineFollowerSim/Board.h | 10 +++- lib/HALRemoteControlSim/Board.h | 10 +++- lib/Service/DifferentialDrive.h | 6 +-- lib/Service/Logging.h | 52 +++++++++++++++---- lib/Service/MovAvg.hpp | 7 +-- lib/Service/Odometry.h | 21 ++++---- lib/Service/RelativeEncoders.h | 6 +-- lib/Service/Speedometer.h | 9 ++-- lib/Service/StateMachine.h | 7 +-- 35 files changed, 219 insertions(+), 156 deletions(-) diff --git a/lib/APPConvoyLeader/App.h b/lib/APPConvoyLeader/App.h index 8f8cd5af..b5184114 100644 --- a/lib/APPConvoyLeader/App.h +++ b/lib/APPConvoyLeader/App.h @@ -27,7 +27,7 @@ /** * @brief ConvoyLeader application * @author Andreas Merkle - * + * * @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. */ }; /****************************************************************************** diff --git a/lib/APPConvoyLeader/DrivingState.h b/lib/APPConvoyLeader/DrivingState.h index 8067719b..45433d88 100644 --- a/lib/APPConvoyLeader/DrivingState.h +++ b/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 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 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 m_posMovAvg; /**< The moving average of the position over 2 calling cycles. */ /** * Default constructor. @@ -156,14 +156,15 @@ 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); @@ -171,8 +172,8 @@ class DrivingState : public IState * 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); diff --git a/lib/APPConvoyLeader/ErrorState.h b/lib/APPConvoyLeader/ErrorState.h index 83313626..3ded9542 100644 --- a/lib/APPConvoyLeader/ErrorState.h +++ b/lib/APPConvoyLeader/ErrorState.h @@ -27,7 +27,7 @@ /** * @brief Error state * @author Andreas Merkle - * + * * @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. */ }; /****************************************************************************** diff --git a/lib/APPConvoyLeader/LineSensorsCalibrationState.h b/lib/APPConvoyLeader/LineSensorsCalibrationState.h index da2da11c..3f695436 100644 --- a/lib/APPConvoyLeader/LineSensorsCalibrationState.h +++ b/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. diff --git a/lib/APPConvoyLeader/MotorSpeedCalibrationState.h b/lib/APPConvoyLeader/MotorSpeedCalibrationState.h index 772abc8f..356d0204 100644 --- a/lib/APPConvoyLeader/MotorSpeedCalibrationState.h +++ b/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. diff --git a/lib/APPConvoyLeader/ParameterSets.h b/lib/APPConvoyLeader/ParameterSets.h index a92040f5..28b3bd3c 100644 --- a/lib/APPConvoyLeader/ParameterSets.h +++ b/lib/APPConvoyLeader/ParameterSets.h @@ -27,7 +27,7 @@ /** * @brief Parameter state * @author Andreas Merkle - * + * * @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. */ }; /****************************************************************************** diff --git a/lib/APPConvoyLeader/ReadyState.h b/lib/APPConvoyLeader/ReadyState.h index 772b638a..25efd942 100644 --- a/lib/APPConvoyLeader/ReadyState.h +++ b/lib/APPConvoyLeader/ReadyState.h @@ -27,7 +27,7 @@ /** * @brief Ready state * @author Andreas Merkle - * + * * @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. */ }; /****************************************************************************** diff --git a/lib/APPConvoyLeader/ReleaseTrackState.h b/lib/APPConvoyLeader/ReleaseTrackState.h index af39725e..3c408768 100644 --- a/lib/APPConvoyLeader/ReleaseTrackState.h +++ b/lib/APPConvoyLeader/ReleaseTrackState.h @@ -27,7 +27,7 @@ /** * @brief Release track state * @author Andreas Merkle - * + * * @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. diff --git a/lib/APPConvoyLeader/StartupState.h b/lib/APPConvoyLeader/StartupState.h index 4cd0c506..8f3d8b5a 100644 --- a/lib/APPConvoyLeader/StartupState.h +++ b/lib/APPConvoyLeader/StartupState.h @@ -27,7 +27,7 @@ /** * @brief Startup state * @author Andreas Merkle - * + * * @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. */ }; /****************************************************************************** diff --git a/lib/APPLineFollower/App.h b/lib/APPLineFollower/App.h index 7ff60046..47408043 100644 --- a/lib/APPLineFollower/App.h +++ b/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. */ }; /****************************************************************************** diff --git a/lib/APPLineFollower/DrivingState.h b/lib/APPLineFollower/DrivingState.h index 8067719b..45433d88 100644 --- a/lib/APPLineFollower/DrivingState.h +++ b/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 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 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 m_posMovAvg; /**< The moving average of the position over 2 calling cycles. */ /** * Default constructor. @@ -156,14 +156,15 @@ 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); @@ -171,8 +172,8 @@ class DrivingState : public IState * 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); diff --git a/lib/APPLineFollower/ErrorState.h b/lib/APPLineFollower/ErrorState.h index 83313626..3ded9542 100644 --- a/lib/APPLineFollower/ErrorState.h +++ b/lib/APPLineFollower/ErrorState.h @@ -27,7 +27,7 @@ /** * @brief Error state * @author Andreas Merkle - * + * * @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. */ }; /****************************************************************************** diff --git a/lib/APPLineFollower/LineSensorsCalibrationState.h b/lib/APPLineFollower/LineSensorsCalibrationState.h index da2da11c..3f695436 100644 --- a/lib/APPLineFollower/LineSensorsCalibrationState.h +++ b/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. diff --git a/lib/APPLineFollower/MotorSpeedCalibrationState.h b/lib/APPLineFollower/MotorSpeedCalibrationState.h index 772abc8f..356d0204 100644 --- a/lib/APPLineFollower/MotorSpeedCalibrationState.h +++ b/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. diff --git a/lib/APPLineFollower/ParameterSets.h b/lib/APPLineFollower/ParameterSets.h index a92040f5..28b3bd3c 100644 --- a/lib/APPLineFollower/ParameterSets.h +++ b/lib/APPLineFollower/ParameterSets.h @@ -27,7 +27,7 @@ /** * @brief Parameter state * @author Andreas Merkle - * + * * @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. */ }; /****************************************************************************** diff --git a/lib/APPLineFollower/ReadyState.h b/lib/APPLineFollower/ReadyState.h index 772b638a..25efd942 100644 --- a/lib/APPLineFollower/ReadyState.h +++ b/lib/APPLineFollower/ReadyState.h @@ -27,7 +27,7 @@ /** * @brief Ready state * @author Andreas Merkle - * + * * @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. */ }; /****************************************************************************** diff --git a/lib/APPLineFollower/ReleaseTrackState.h b/lib/APPLineFollower/ReleaseTrackState.h index af39725e..3c408768 100644 --- a/lib/APPLineFollower/ReleaseTrackState.h +++ b/lib/APPLineFollower/ReleaseTrackState.h @@ -27,7 +27,7 @@ /** * @brief Release track state * @author Andreas Merkle - * + * * @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. diff --git a/lib/APPLineFollower/StartupState.h b/lib/APPLineFollower/StartupState.h index 4cd0c506..8f3d8b5a 100644 --- a/lib/APPLineFollower/StartupState.h +++ b/lib/APPLineFollower/StartupState.h @@ -27,7 +27,7 @@ /** * @brief Startup state * @author Andreas Merkle - * + * * @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. */ }; /****************************************************************************** diff --git a/lib/APPRemoteControl/App.h b/lib/APPRemoteControl/App.h index cf8acd9b..10912d2e 100644 --- a/lib/APPRemoteControl/App.h +++ b/lib/APPRemoteControl/App.h @@ -124,8 +124,9 @@ class App /** Last remote control response id */ RemoteCtrlState::RspId m_lastRemoteControlRspId; - 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. */ /** * Send remote control command responses on change. diff --git a/lib/APPRemoteControl/ErrorState.h b/lib/APPRemoteControl/ErrorState.h index 83313626..3ded9542 100644 --- a/lib/APPRemoteControl/ErrorState.h +++ b/lib/APPRemoteControl/ErrorState.h @@ -27,7 +27,7 @@ /** * @brief Error state * @author Andreas Merkle - * + * * @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. */ }; /****************************************************************************** diff --git a/lib/APPRemoteControl/LineSensorsCalibrationState.h b/lib/APPRemoteControl/LineSensorsCalibrationState.h index da2da11c..3f695436 100644 --- a/lib/APPRemoteControl/LineSensorsCalibrationState.h +++ b/lib/APPRemoteControl/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. diff --git a/lib/APPRemoteControl/MotorSpeedCalibrationState.h b/lib/APPRemoteControl/MotorSpeedCalibrationState.h index 772abc8f..356d0204 100644 --- a/lib/APPRemoteControl/MotorSpeedCalibrationState.h +++ b/lib/APPRemoteControl/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. diff --git a/lib/APPRemoteControl/RemoteCtrlState.h b/lib/APPRemoteControl/RemoteCtrlState.h index af60b934..dedaeb7a 100644 --- a/lib/APPRemoteControl/RemoteCtrlState.h +++ b/lib/APPRemoteControl/RemoteCtrlState.h @@ -27,7 +27,7 @@ /** * @brief Remote control state * @author Andreas Merkle - * + * * @addtogroup Application * * @{ @@ -58,7 +58,6 @@ class RemoteCtrlState : public IState { public: - /** Remote control commands. */ typedef enum : uint8_t { @@ -112,7 +111,7 @@ class RemoteCtrlState : public IState /** * Execute command. * If a command is pending, it won't be executed. - * + * * @param[in] cmdId The id of the command which to execute. */ void execute(CmdId cmdId) @@ -126,7 +125,7 @@ class RemoteCtrlState : public IState /** * Get command response of current command. - * + * * @return Command response */ RspId getCmdRsp() const @@ -136,16 +135,13 @@ class RemoteCtrlState : public IState protected: private: - - CmdId m_cmdId; /**< Current pending command. */ - RspId m_rspId; /**< Current command response. */ + CmdId m_cmdId; /**< Current pending command. */ + RspId m_rspId; /**< Current command response. */ /** * Default constructor. */ - RemoteCtrlState() : - m_cmdId(CMD_ID_IDLE), - m_rspId(RSP_ID_OK) + RemoteCtrlState() : m_cmdId(CMD_ID_IDLE), m_rspId(RSP_ID_OK) { } @@ -156,12 +152,12 @@ class RemoteCtrlState : public IState { } - RemoteCtrlState(const RemoteCtrlState& state); - RemoteCtrlState& operator=(const RemoteCtrlState& state); + RemoteCtrlState(const RemoteCtrlState& state); /**< Copy construction of an instance. */ + RemoteCtrlState& operator=(const RemoteCtrlState& state); /**< Assignment of an instance. */ /** * Set command response and finish the command execution. - * + * * @param[in] rsp Command response */ void finishCommand(RspId rsp) diff --git a/lib/APPRemoteControl/SerialMuxChannels.h b/lib/APPRemoteControl/SerialMuxChannels.h index d37cccf2..b4b6b643 100644 --- a/lib/APPRemoteControl/SerialMuxChannels.h +++ b/lib/APPRemoteControl/SerialMuxChannels.h @@ -76,26 +76,26 @@ /** Struct of the "Command" channel payload. */ typedef struct _Command { - uint8_t commandId; + uint8_t commandId; /**< Command ID */ } __attribute__((packed)) Command; /** Struct of the "Command Response" channel payload. */ typedef struct _CommandResponse { - uint8_t response; + uint8_t response; /**< Response to the command */ } __attribute__((packed)) CommandResponse; /** Struct of the "Speed" channel payload. */ typedef struct _SpeedData { - int16_t left; - int16_t right; + int16_t left; /**< Left motor speed */ + int16_t right; /**< Right motor speed */ } __attribute__((packed)) SpeedData; /** Struct of the "Line Sensor" channel payload. */ typedef struct _LineSensorData { - uint16_t lineSensorData[5U]; + uint16_t lineSensorData[5U]; /**< Line sensor data */ } __attribute__((packed)) LineSensorData; /****************************************************************************** diff --git a/lib/APPRemoteControl/StartupState.h b/lib/APPRemoteControl/StartupState.h index a4609b1b..c58233fb 100644 --- a/lib/APPRemoteControl/StartupState.h +++ b/lib/APPRemoteControl/StartupState.h @@ -27,7 +27,7 @@ /** * @brief Startup state * @author Andreas Merkle - * + * * @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. */ }; /****************************************************************************** diff --git a/lib/HALConvoyLeaderSim/Board.h b/lib/HALConvoyLeaderSim/Board.h index ccb9ef43..ed84723f 100644 --- a/lib/HALConvoyLeaderSim/Board.h +++ b/lib/HALConvoyLeaderSim/Board.h @@ -205,7 +205,7 @@ class Board : public IBoard /** * Get proximity sensors driver. - * + * * @return Proximity sensors driver */ IProximitySensors& getProximitySensors() final @@ -379,9 +379,15 @@ class Board : public IBoard return m_keyboard; } - /* The main entry needs access to the simulation robot instance. + /** + * The main entry needs access to the simulation robot instance. * But all other application parts shall have no access, which is * solved by this friend. + * + * @param[in] argc Number of arguments + * @param[in] argv Arguments + * + * @return Exit code */ friend int main(int argc, char** argv); }; diff --git a/lib/HALLineFollowerSim/Board.h b/lib/HALLineFollowerSim/Board.h index ccb9ef43..ed84723f 100644 --- a/lib/HALLineFollowerSim/Board.h +++ b/lib/HALLineFollowerSim/Board.h @@ -205,7 +205,7 @@ class Board : public IBoard /** * Get proximity sensors driver. - * + * * @return Proximity sensors driver */ IProximitySensors& getProximitySensors() final @@ -379,9 +379,15 @@ class Board : public IBoard return m_keyboard; } - /* The main entry needs access to the simulation robot instance. + /** + * The main entry needs access to the simulation robot instance. * But all other application parts shall have no access, which is * solved by this friend. + * + * @param[in] argc Number of arguments + * @param[in] argv Arguments + * + * @return Exit code */ friend int main(int argc, char** argv); }; diff --git a/lib/HALRemoteControlSim/Board.h b/lib/HALRemoteControlSim/Board.h index ccb9ef43..ed84723f 100644 --- a/lib/HALRemoteControlSim/Board.h +++ b/lib/HALRemoteControlSim/Board.h @@ -205,7 +205,7 @@ class Board : public IBoard /** * Get proximity sensors driver. - * + * * @return Proximity sensors driver */ IProximitySensors& getProximitySensors() final @@ -379,9 +379,15 @@ class Board : public IBoard return m_keyboard; } - /* The main entry needs access to the simulation robot instance. + /** + * The main entry needs access to the simulation robot instance. * But all other application parts shall have no access, which is * solved by this friend. + * + * @param[in] argc Number of arguments + * @param[in] argv Arguments + * + * @return Exit code */ friend int main(int argc, char** argv); }; diff --git a/lib/Service/DifferentialDrive.h b/lib/Service/DifferentialDrive.h index e09b408e..773d6e6c 100644 --- a/lib/Service/DifferentialDrive.h +++ b/lib/Service/DifferentialDrive.h @@ -107,7 +107,7 @@ class DifferentialDrive * Disable the differential drive control. * It will stop the motors to avoid any unexpected driving behaviour. * After that the motors are not controlled anymore. - * + * * Important: Processing the differential drive control shall not be stopped. */ void disable() @@ -278,8 +278,8 @@ class DifferentialDrive } /* Not allowed. */ - DifferentialDrive(const DifferentialDrive& diffDrive); - DifferentialDrive& operator=(const DifferentialDrive& diffDrive); + DifferentialDrive(const DifferentialDrive& diffDrive); /**< Copy construction of an instance. */ + DifferentialDrive& operator=(const DifferentialDrive& diffDrive); /**< Assignment of an instance. */ /** * Calculate the linear speed left and right from the linear speed center and diff --git a/lib/Service/Logging.h b/lib/Service/Logging.h index 88ab8243..d2387873 100644 --- a/lib/Service/Logging.h +++ b/lib/Service/Logging.h @@ -41,24 +41,29 @@ *****************************************************************************/ #ifndef LOG_FATAL_ENABLE +/** Enable/disable fatal log messages. */ #define LOG_FATAL_ENABLE (1) -#endif /* LOG_FATAL_ENABLE */ +#endif #ifndef LOG_ERROR_ENABLE +/** Enable/disable error log messages. */ #define LOG_ERROR_ENABLE (1) -#endif /* LOG_ERROR_ENABLE */ +#endif #ifndef LOG_WARNING_ENABLE +/** Enable/disable warning log messages. */ #define LOG_WARNING_ENABLE (1) -#endif /* LOG_WARNING_ENABLE */ +#endif #ifndef LOG_INFO_ENABLE +/** Enable/disable info log messages. */ #define LOG_INFO_ENABLE (1) -#endif /* LOG_INFO_ENABLE */ +#endif #ifndef LOG_DEBUG_ENABLE +/** Enable/disable debug log messages. */ #define LOG_DEBUG_ENABLE (0) -#endif /* LOG_DEBUG_ENABLE */ +#endif /****************************************************************************** * Includes @@ -71,10 +76,15 @@ #if (0 == LOG_FATAL_ENABLE) +/** Log fatal error message. */ #define LOG_FATAL(_filename, _msg) +/** Log fatal error message with additional value. */ #define LOG_FATAL_VAL(_filename, _msg, _val) +/** Log fatal error header. */ #define LOG_FATAL_HEAD(_filename) +/** Log fatal error message, without line feed. */ #define LOG_FATAL_MSG(_msg) +/** Log fatal error tail. */ #define LOG_FATAL_TAIL() #else /* (0 == LOG_FATAL_ENABLE) */ @@ -99,10 +109,15 @@ #if (0 == LOG_ERROR_ENABLE) +/** Log error message. */ #define LOG_ERROR(_filename, _msg) +/** Log error message with additional value. */ #define LOG_ERROR_VAL(_filename, _msg, _val) +/** Log error header. */ #define LOG_ERROR_HEAD(_filename) +/** Log error error message, without line feed. */ #define LOG_ERROR_MSG(_msg) +/** Log error tail. */ #define LOG_ERROR_TAIL() #else /* (0 == LOG_ERROR_ENABLE) */ @@ -127,10 +142,15 @@ #if (0 == LOG_WARNING_ENABLE) +/** Log warning message. */ #define LOG_WARNING(_filename, _msg) +/** Log warning message with additional value. */ #define LOG_WARNING_VAL(_filename, _msg, _val) +/** Log warning header. */ #define LOG_WARNING_HEAD(_filename) +/** Log warning message, without line feed. */ #define LOG_WARNING_MSG(_msg) +/** Log warning tail. */ #define LOG_WARNING_TAIL() #else /* (0 == LOG_WARNING_ENABLE) */ @@ -155,10 +175,15 @@ #if (0 == LOG_INFO_ENABLE) +/** Log info message. */ #define LOG_INFO(_filename, _msg) +/** Log info message with additional value. */ #define LOG_INFO_VAL(_filename, _msg, _val) +/** Log info header. */ #define LOG_INFO_HEAD(_filename) +/** Log info message, without line feed. */ #define LOG_INFO_MSG(_msg) +/** Log info tail. */ #define LOG_INFO_TAIL() #else /* (0 == LOG_INFO_ENABLE) */ @@ -183,10 +208,15 @@ #if (0 == LOG_DEBUG_ENABLE) -#define LOG_DEBUG(_filename, _msg) (void)(_filename) -#define LOG_DEBUG_VAL(_filename, _msg, _val) (void)(_filename) -#define LOG_DEBUG_HEAD(_filename) (void)(_filename) +/** Log debug message. */ +#define LOG_DEBUG(_filename, _msg) +/** Log debug message with additional value. */ +#define LOG_DEBUG_VAL(_filename, _msg, _val) +/** Log debug header. */ +#define LOG_DEBUG_HEAD(_filename) +/** Log debug message, without line feed. */ #define LOG_DEBUG_MSG(_msg) +/** Log debug tail. */ #define LOG_DEBUG_TAIL() #else /* (0 == LOG_DEBUG_ENABLE) */ @@ -283,9 +313,9 @@ namespace Logging }; // namespace Logging - /****************************************************************************** - * Functions - *****************************************************************************/ +/****************************************************************************** + * Functions + *****************************************************************************/ #endif /* __LOGGING_H__ */ /** @} */ diff --git a/lib/Service/MovAvg.hpp b/lib/Service/MovAvg.hpp index 410ac9f4..51536d23 100644 --- a/lib/Service/MovAvg.hpp +++ b/lib/Service/MovAvg.hpp @@ -27,7 +27,7 @@ /** * @brief Moving average * @author Andreas Merkle - * + * * @addtogroup Service * * @{ @@ -151,8 +151,9 @@ 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 */ - MovAvg(const MovAvg& avg); - MovAvg& operator=(const MovAvg& avg); + /* Not allowed. */ + MovAvg(const MovAvg& avg); /**< Copy construction of an instance. */ + MovAvg& operator=(const MovAvg& avg); /**< Assignment of an instance. */ }; /****************************************************************************** diff --git a/lib/Service/Odometry.h b/lib/Service/Odometry.h index 71589ef4..ad31b346 100644 --- a/lib/Service/Odometry.h +++ b/lib/Service/Odometry.h @@ -63,15 +63,15 @@ * - Orientation * - Position * - Mileage - * + * * Its following the REP-103: https://ros.org/reps/rep-0103.html - * + * * That means the cartesian representation of geographic locations use the * east-north-up (ENU) convention: * - X east * - Y north * - Z up - * + * * Rotation only about the Z axis (yaw) is supported. * The yaw relates to the X axis. That means if the robot is heading to the * north, the yaw will be 90°. @@ -129,7 +129,7 @@ class Odometry /** * Set the orientation. * Use this to align the Y axis to north. - * + * * @param[in] orientation The orientation in mrad. */ void setOrientation(int32_t orientation) @@ -230,24 +230,25 @@ class Odometry { } - Odometry(const Odometry& value); - Odometry& operator=(const Odometry& value); + /* Not allowed. */ + Odometry(const Odometry& value); /**< Copy construction of an instance. */ + Odometry& operator=(const Odometry& value); /**< Assignment of an instance. */ /** * Is the robot standstill? * - * @param[in] relStepsLeft Relative absolute steps left - * @param[in] relStepsRight Relative absolute steps right + * @param[in] absStepsLeft Absolute steps left + * @param[in] absStepsRight Absolute steps right */ bool detectStandStill(uint16_t absStepsLeft, uint16_t absStepsRight); /** * Calculate the mileage in mm. - * + * * @param[in] mileage Mileage in mm * @param[in] stepsCenter Number of steps center - * + * * @return Mileage in mm */ int32_t calculateMileage(uint32_t mileage, int16_t stepsCenter); diff --git a/lib/Service/RelativeEncoders.h b/lib/Service/RelativeEncoders.h index a8807e65..953f81f5 100644 --- a/lib/Service/RelativeEncoders.h +++ b/lib/Service/RelativeEncoders.h @@ -129,9 +129,9 @@ class RelativeEncoders int16_t m_referencePointRight; /* Not allowed. */ - RelativeEncoders(); - RelativeEncoders(const RelativeEncoders& relEncoder); - RelativeEncoders& operator=(const RelativeEncoders& relEncoder); + RelativeEncoders(); /**< Default constructor. */ + RelativeEncoders(const RelativeEncoders& relEncoder); /**< Copy construction of an instance. */ + RelativeEncoders& operator=(const RelativeEncoders& relEncoder); /**< Assignment of an instance. */ }; /****************************************************************************** diff --git a/lib/Service/Speedometer.h b/lib/Service/Speedometer.h index ea7448c8..477be9cf 100644 --- a/lib/Service/Speedometer.h +++ b/lib/Service/Speedometer.h @@ -159,8 +159,9 @@ class Speedometer { } - Speedometer(const Speedometer& value); - Speedometer& operator=(const Speedometer& value); + /* Not allowed. */ + Speedometer(const Speedometer& value); /**< Copy construction of an instance. */ + Speedometer& operator=(const Speedometer& value); /**< Assignment of an instance. */ /** * Get the direction of movement left. @@ -178,9 +179,9 @@ class Speedometer /** * Determine the direction of the movement by motor speed. - * + * * @param[in] motorSpeed Motor speed in digits - * + * * @return Direction of movement. */ Direction getDirectionByMotorSpeed(int16_t motorSpeed); diff --git a/lib/Service/StateMachine.h b/lib/Service/StateMachine.h index 774476b0..a27cce0c 100644 --- a/lib/Service/StateMachine.h +++ b/lib/Service/StateMachine.h @@ -27,7 +27,7 @@ /** * @brief Statemachine * @author Andreas Merkle - * + * * @addtogroup Application * * @{ @@ -101,8 +101,9 @@ class StateMachine IState* m_currentState; /**< Current active state */ IState* m_nextState; /**< Next state */ - StateMachine(const StateMachine& sm); - StateMachine& operator=(const StateMachine& sm); + /* Not allowed. */ + StateMachine(const StateMachine& sm); /**< Copy construction of an instance. */ + StateMachine& operator=(const StateMachine& sm); /**< Assignment of an instance. */ }; /******************************************************************************