Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed Doxygen #36

Merged
merged 6 commits into from
Nov 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/doxygen/ConvoyLeaderSimDoxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -499,19 +499,19 @@ NUM_PROC_THREADS = 1
# normally produced when WARNINGS is set to YES.
# The default value is: NO.

EXTRACT_ALL = YES
EXTRACT_ALL = NO

# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.

EXTRACT_PRIVATE = NO
EXTRACT_PRIVATE = YES

# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
# The default value is: NO.

EXTRACT_PRIV_VIRTUAL = NO
EXTRACT_PRIV_VIRTUAL = YES

# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
Expand All @@ -523,7 +523,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.

EXTRACT_STATIC = NO
EXTRACT_STATIC = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
Expand Down
8 changes: 4 additions & 4 deletions doc/doxygen/ConvoyLeaderTargetDoxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -499,19 +499,19 @@ NUM_PROC_THREADS = 1
# normally produced when WARNINGS is set to YES.
# The default value is: NO.

EXTRACT_ALL = YES
EXTRACT_ALL = NO

# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.

EXTRACT_PRIVATE = NO
EXTRACT_PRIVATE = YES

# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
# The default value is: NO.

EXTRACT_PRIV_VIRTUAL = NO
EXTRACT_PRIV_VIRTUAL = YES

# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
Expand All @@ -523,7 +523,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.

EXTRACT_STATIC = NO
EXTRACT_STATIC = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
Expand Down
8 changes: 4 additions & 4 deletions doc/doxygen/LineFollowerSimDoxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -499,19 +499,19 @@ NUM_PROC_THREADS = 1
# normally produced when WARNINGS is set to YES.
# The default value is: NO.

EXTRACT_ALL = YES
EXTRACT_ALL = NO

# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.

EXTRACT_PRIVATE = NO
EXTRACT_PRIVATE = YES

# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
# The default value is: NO.

EXTRACT_PRIV_VIRTUAL = NO
EXTRACT_PRIV_VIRTUAL = YES

# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
Expand All @@ -523,7 +523,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.

EXTRACT_STATIC = NO
EXTRACT_STATIC = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
Expand Down
8 changes: 4 additions & 4 deletions doc/doxygen/LineFollowerTargetDoxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -499,19 +499,19 @@ NUM_PROC_THREADS = 1
# normally produced when WARNINGS is set to YES.
# The default value is: NO.

EXTRACT_ALL = YES
EXTRACT_ALL = NO

# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.

EXTRACT_PRIVATE = NO
EXTRACT_PRIVATE = YES

# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
# The default value is: NO.

EXTRACT_PRIV_VIRTUAL = NO
EXTRACT_PRIV_VIRTUAL = YES

# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
Expand All @@ -523,7 +523,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.

EXTRACT_STATIC = NO
EXTRACT_STATIC = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
Expand Down
8 changes: 4 additions & 4 deletions doc/doxygen/RemoteControlSimDoxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -499,19 +499,19 @@ NUM_PROC_THREADS = 1
# normally produced when WARNINGS is set to YES.
# The default value is: NO.

EXTRACT_ALL = YES
EXTRACT_ALL = NO

# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.

EXTRACT_PRIVATE = NO
EXTRACT_PRIVATE = YES

# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
# The default value is: NO.

EXTRACT_PRIV_VIRTUAL = NO
EXTRACT_PRIV_VIRTUAL = YES

# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
Expand All @@ -523,7 +523,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.

EXTRACT_STATIC = NO
EXTRACT_STATIC = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
Expand Down
8 changes: 4 additions & 4 deletions doc/doxygen/RemoteControlTargetDoxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -499,19 +499,19 @@ NUM_PROC_THREADS = 1
# normally produced when WARNINGS is set to YES.
# The default value is: NO.

EXTRACT_ALL = YES
EXTRACT_ALL = NO

# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.

EXTRACT_PRIVATE = NO
EXTRACT_PRIVATE = YES

# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
# The default value is: NO.

EXTRACT_PRIV_VIRTUAL = NO
EXTRACT_PRIV_VIRTUAL = YES

# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
Expand All @@ -523,7 +523,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.

EXTRACT_STATIC = NO
EXTRACT_STATIC = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
Expand Down
14 changes: 5 additions & 9 deletions lib/APPConvoyLeader/App.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* @brief ConvoyLeader application
* @author Andreas Merkle <[email protected]>
*
*
* @addtogroup Application
*
* @{
Expand Down Expand Up @@ -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)
{
}

Expand All @@ -89,7 +85,6 @@ class App
void loop();

private:

/** Differential drive control period in ms. */
static const uint32_t DIFFERENTIAL_DRIVE_CONTROL_PERIOD = 5U;

Expand Down Expand Up @@ -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. */
};

/******************************************************************************
Expand Down
23 changes: 12 additions & 11 deletions lib/APPConvoyLeader/DrivingState.h
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@ class DrivingState : public IState
SimpleTimer m_lapTime; /**< Timer used to calculate the lap time. */
SimpleTimer m_pidProcessTime; /**< Timer used for periodically PID processing. */
PIDController<int16_t> m_pidCtrl; /**< PID controller, used for driving. */
int16_t m_topSpeed; /**< Top speed in [steps/s]. It might be lower or equal to the max. speed! */
LineStatus m_lineStatus; /**< Status of start-/end line detection */
TrackStatus m_trackStatus; /**< Status of track which means on track or track lost, etc. */
uint8_t m_startEndLineDebounce; /**< Counter used for easys debouncing of the start-/end line detection. */
MovAvg<int16_t, 2> m_posMovAvg; /**< The moving average of the position over 2 calling cycles. */
int16_t m_topSpeed; /**< Top speed in [steps/s]. It might be lower or equal to the max. speed! */
LineStatus m_lineStatus; /**< Status of start-/end line detection */
TrackStatus m_trackStatus; /**< Status of track which means on track or track lost, etc. */
uint8_t m_startEndLineDebounce; /**< Counter used for easys debouncing of the start-/end line detection. */
MovAvg<int16_t, 2> m_posMovAvg; /**< The moving average of the position over 2 calling cycles. */

/**
* Default constructor.
Expand All @@ -156,23 +156,24 @@ class DrivingState : public IState
{
}

DrivingState(const DrivingState& state);
DrivingState& operator=(const DrivingState& state);
/* Not allowed. */
DrivingState(const DrivingState& state); /**< Copy construction of an instance. */
DrivingState& operator=(const DrivingState& state); /**< Assignment of an instance. */

/**
* Control driving in case the robot is on track.
*
* @param[in] position Current position on track
* @param[in] lineSensorValue Value of each line sensor
* @param[in] position Current position on track
* @param[in] lineSensorValues Value of each line sensor
*/
void processOnTrack(int16_t position, const uint16_t* lineSensorValues);

/**
* Control driving in case the robot lost the track.
* It handles the track search algorithm.
*
* @param[in] position Current position on track
* @param[in] lineSensorValue Value of each line sensor
* @param[in] position Current position on track
* @param[in] lineSensorValues Value of each line sensor
*/
void processTrackLost(int16_t position, const uint16_t* lineSensorValues);

Expand Down
14 changes: 7 additions & 7 deletions lib/APPConvoyLeader/ErrorState.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* @brief Error state
* @author Andreas Merkle <[email protected]>
*
*
* @addtogroup Application
*
* @{
Expand Down Expand Up @@ -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.
Expand All @@ -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. */
};

/******************************************************************************
Expand Down
5 changes: 3 additions & 2 deletions lib/APPConvoyLeader/LineSensorsCalibrationState.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 3 additions & 2 deletions lib/APPConvoyLeader/MotorSpeedCalibrationState.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 4 additions & 3 deletions lib/APPConvoyLeader/ParameterSets.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* @brief Parameter state
* @author Andreas Merkle <[email protected]>
*
*
* @addtogroup Application
*
* @{
Expand Down Expand Up @@ -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. */
};

/******************************************************************************
Expand Down
7 changes: 4 additions & 3 deletions lib/APPConvoyLeader/ReadyState.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* @brief Ready state
* @author Andreas Merkle <[email protected]>
*
*
* @addtogroup Application
*
* @{
Expand Down Expand Up @@ -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. */
};

/******************************************************************************
Expand Down
Loading