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
+50 -11
View File
@@ -1,7 +1,7 @@
/**
* @file pidSettings.h
* @file menuPidSettings.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a class to tune the PID settings
* @version 0.1
* @date 2022-01-19
*
@@ -18,19 +18,58 @@
#define NUM_VAL 3
/**
* @brief A class to tune the PID settings
*
*/
class MenuPidSettings : public MenuControl {
public:
/**
* @brief Construct a new Menu Pid Settings object
*
* @param pid
*/
MenuPidSettings(PID* pid);
void down();
void up();
void right();
void left();
void no();
void yes();
/**
* @brief Decrement selected value
*/
void down() override;
void printMenu();
void update(){};
/**
* @brief Increment selected value
*/
void up() override;
/**
* @brief Select next value
*/
void right() override;
/**
* @brief Select previous value
*/
void left() override;
/**
* @brief Leave menu without saving
*/
void no() override;
/**
* @brief Leave menu with saving
*/
void yes() override;
/**
* @brief Prints the Information to display and console
*
* The informations are only printed to the display if it
* set.
*/
void printMenu() override;
void update() override {};
private:
PID* pid;
@@ -39,4 +78,4 @@ class MenuPidSettings : public MenuControl {
};
#endif // PID_SETTINGS_H
#endif // PID_SETTINGS_H