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
@@ -1,7 +1,7 @@
/**
* @file menuTestMode.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a class to use and print information about the TestMode.
* @version 0.1
* @date 2022-09-08
*
@@ -17,11 +17,35 @@
#include "menuAction.h"
#include "menuIntInput.h"
/**
* @brief Interact with the TestMode
*
*/
class MenuTestMode : public MenuDriveMode {
public:
/**
* @brief Construct a new Menu Test Mode object
*
* @param driveManager
*/
MenuTestMode(DriveManager *driveManager);
~MenuTestMode();
void printMenu();
/**
* @brief Prints the last informations
*
* On first call this function calls the init function.
* On every call this functions call the printMenu function from
* the mainMenu of this class.
*/
void printMenu() override;
/**
* @brief Prints maneuver Timer
*
* Aside from that the function looks if the maneuver is done and
* give the user input free.
*/
void printManeuverTime();
void down() override;
@@ -31,6 +55,10 @@ class MenuTestMode : public MenuDriveMode {
void yes() override;
void no() override;
/**
* @brief Calls the printManeuverTime function if a maneuver is in process.
*
*/
void update() override;
TestMode* getTestMode() const { return this->testMode; }