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 menuAutopilot.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains an implementation of the class MenuAutopilot
* @version 0.1
* @date 2022-02-03
*
@@ -1,7 +1,7 @@
/**
* @file menuAutopilot.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a class to print informations about the Autopilot
* @version 0.1
* @date 2022-02-03
*
@@ -14,10 +14,33 @@
#include "SpecialMenus/driveModi/menuDriveMode.h"
/**
* @brief A class to print informations about the Autopilot
*
*/
class MenuAutopilot : public MenuDriveMode {
public:
/**
* @brief Construct a new Menu Autopilot object
*
* @param driveManager for MenuDriveMode
*/
MenuAutopilot(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 Autopilot if it is the first time called
* and save the Autopilot object.
*/
void printMenu();
/**
* @brief can be called to update shown data
*/
void update();
private:
@@ -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
@@ -1,7 +1,7 @@
/**
* @file menuManualDrive.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains an implementation of the class MenuManualDrive
* @version 0.1
* @date 2022-01-20
*
@@ -1,7 +1,7 @@
/**
* @file menuManualDrive.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a class to print information about the class ManualControl
* @version 0.1
* @date 2022-01-20
*
@@ -14,10 +14,28 @@
#include "SpecialMenus/driveModi/menuDriveMode.h"
/**
* @brief A class to print informations about the class ManualControl
*
*/
class MenuManualControl : public MenuDriveMode {
public:
/**
* @brief Construct a new Menu Manual Control object
*
* @param driveManager
*/
MenuManualControl(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 Autopilot if it is the first time called.
*/
void printMenu();
};
#endif // MENU_MANUAL_DRIVE_H
#endif // MENU_MANUAL_DRIVE_H
+2 -2
View File
@@ -1,7 +1,7 @@
/**
* @file menuDriveMode.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains an implementation of the class MenuDriveMode
* @version 0.1
* @date 2022-01-31
*
@@ -24,4 +24,4 @@ void MenuDriveMode::left() {
void MenuDriveMode::no() {
this->left();
}
}
+21 -8
View File
@@ -1,7 +1,7 @@
/**
* @file menuDriveMode.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a base class for Menus about DriveModi
* @version 0.1
* @date 2022-01-31
*
@@ -14,18 +14,31 @@
#include "menuControl.h"
#include "driveModi/driveManager.h"
/**
* @brief A base class for Menus about DriveModi
*
*/
class MenuDriveMode : public MenuControl {
public:
/**
* @brief Construct a new Menu Drive Mode object
*
* @param driveManager
*/
MenuDriveMode(DriveManager* driveManager);
void down(){}
void up(){}
void right(){}
void left();
void no();
void yes(){}
void down() override {}
void up() override {}
void right() override {}
void left() override;
void no() override;
void yes() override {}
virtual void printMenu() = 0;
/**
* @brief can be called to update shown data
*/
void update(){}
protected:
@@ -33,4 +46,4 @@ class MenuDriveMode : public MenuControl {
bool firstPrint = true;
};
#endif // MENU_DRIVE_MODI_H
#endif // MENU_DRIVE_MODI_H