Update doxygen comments

This commit is contained in:
2023-02-13 20:36:04 +01:00
parent 1604cb0026
commit deecf7724c
23 changed files with 497 additions and 70 deletions
+6
View File
@@ -23,7 +23,13 @@
*/
#define NO_GLOBAL_INSTANCES
/**
* @name SPI-Pins
* @brief Pins for SPI communication with the gnss module
*/
///@{
#define UBLOX_GNSS_SPI_CS 17
#define UBLOX_GNSS_SPI_COPI 16
#define UBLOX_GNSS_SPI_CIPO 4
#define UBLOX_GNSS_SPI_SCK 5
///@}
+27
View File
@@ -98,7 +98,22 @@ class MoveControl {
*/
void setRotationSpeed(double speed);
/**
* @brief Set Raw Power Left
*
* This value has only an effect if DrivingStatus is raw.
*
* @param power between -100 and 100
*/
void setRawPowerLeft(int16_t power);
/**
* @brief Set the Raw Power Right
*
* This value has only an effect if DrivingStatus is raw.
*
* @param power between -100 and 100
*/
void setRawPowerRight(int16_t power);
/**
@@ -118,7 +133,19 @@ class MoveControl {
* @return PID*
*/
PID* getPID(uint8_t side);
/**
* @brief Get the Speedometer Left object
*
* @return Speedometer*
*/
Speedometer* getSpeedometerLeft() const { return this->left_speedometer; }
/**
* @brief Get the Speedometer Right object
*
* @return Speedometer*
*/
Speedometer* getSpeedometerRight() const { return this->right_speedometer; }
/**