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 -1
View File
@@ -1,7 +1,7 @@
/**
* @file menuGPS.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains an implementation of the class MenuGPS
* @version 0.1
* @date 2022-01-29
*
+54 -10
View File
@@ -1,7 +1,7 @@
/**
* @file menuGPS.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a class to print informations about the GPS object
* @version 0.1
* @date 2022-01-29
*
@@ -16,19 +16,63 @@
#include "menuControl.h"
/**
* @brief A class to print informations about the GPS object
*
*/
class MenuGPS : public MenuControl {
public:
/**
* @brief Construct a new Menu GPS object
*
* @param gps
*/
MenuGPS(TinyGPSPlus* gps);
void down();
void up();
void right();
void left();
void no();
void yes();
void printMenu();
void update();
/**
* @brief Next page
*/
void down() override;
/**
* @brief Previous page
*/
void up() override;
/**
* @brief Update information
*/
void right() override;
/**
* @brief Go to the parent menu
*/
void left() override;
/**
* @brief Go to the parent menu
*/
void no() override;
/**
* @brief Update information
*/
void yes() override;
/**
* @brief Prints the Information to display and console
*
* Prints the selected page.
* The informations are only printed to the display if it
* set.
*/
void printMenu() override;
/**
* @brief can be called to update shown data
*/
void update() override;
private:
const uint8_t countPages = 7;
@@ -41,4 +85,4 @@ class MenuGPS : public MenuControl {
uint32_t last_millis = 0;
};
#endif // MENU_GPS_H
#endif // MENU_GPS_H