Finish documention until someone change something

This commit is contained in:
2022-02-15 20:12:50 +01:00
parent 3a2e51713b
commit c8e3344b27
50 changed files with 991 additions and 223 deletions
@@ -1,7 +1,7 @@
/**
* @file menuCaptureRoute.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains an implementation of the class MenuCaptureRoute
* @version 0.1
* @date 2022-01-31
*
@@ -1,7 +1,7 @@
/**
* @file menuCaptureRoute.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a class to print informations about CaptureRoute
* @version 0.1
* @date 2022-01-31
*
@@ -13,10 +13,33 @@
#include "SpecialMenus/driveModi/menuDriveMode.h"
/**
* @brief A class to print informations about the Autopilot
*
*/
class MenuCaptureRoute : public MenuDriveMode {
public:
/**
* @brief Construct a new Menu Capture Route object
*
* @param driveManager
*/
MenuCaptureRoute(DriveManager* driveManager) : MenuDriveMode(driveManager) {}
/**
* @brief Prints the Information to display and console
*
* The informations are only printed to the display if it
* set.
*
* Changes the DriveModi to CaptureRoute if it is the first time called
* and save the CaptureRoute object.
*/
void printMenu();
/**
* @brief can be called to update shown data
*/
void update();
private:
@@ -26,4 +49,4 @@ class MenuCaptureRoute : public MenuDriveMode {
RouteInfo routeInfo;
};
#endif // MENU_MANUAL_DRIVE_H
#endif // MENU_MANUAL_DRIVE_H