Update doxygen comments

src/SpecialMenus/Route/menuRoute.cpp

@@ -1,7 +1,7 @@
 /**
  * @file menuRoute.cpp
  * @author Alexander Klein (alex@kleiax.de)
- * @brief 
+ * @brief Contains the implementation of the classes MenuActionRoute, MenuRoute and MenuRouteWrapper. 
  * @version 0.1
  * @date 2022-12-28
  * 

src/SpecialMenus/Route/menuRoute.h

@@ -1,7 +1,7 @@
 /**
  * @file menuRoute.h
  * @author Alexander Klein (alex@kleiax.de)
- * @brief 
+ * @brief Contains a classes to handles routes with the user input.
  * @version 0.1
  * @date 2022-12-28
  * 
@@ -28,9 +28,25 @@
 class MenuRoute;
 typedef void (MenuRoute::*DataFunction)(uint8_t);
 
+/**
+ * @brief MenuActionWrapper to call DataFunctions
+ * 
+ * This class should be used to call importRoute,
+ * exportRoute and clearRoute over the Menu.
+ */
 class MenuActionRoute : public MenuActionWrapper {
     public:
+        /**
+         * @brief Construct a new Menu Action Route object
+         * 
+         * @param menuRoute 
+         * @param dataFunction like exportRoute
+         */
         MenuActionRoute(MenuRoute* menuRoute, DataFunction dataFunction);
+
+        /**
+         * @brief Runs the given DataFunction
+         */
         void action() override;
 
     private:
@@ -38,21 +54,66 @@ class MenuActionRoute : public MenuActionWrapper {
         DataFunction dataFunction;
 };
 
+/**
+ * @brief Handles routes
+ * 
+ * With this menu the user can import, export and delete routes. 
+ */
 class MenuRoute : public MenuControl {
     public:
+        /**
+         * @brief Construct a new Menu Route object
+         * 
+         * @param route 
+         */
         MenuRoute(Route* route);
         ~MenuRoute();
+
+        /**
+         * @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;
 
+        /**
+         * @name User Inputs
+         * @brief Inputs given by the parentMenu
+         */
+        ///@{
         void down() override;
         void up() override;
         void right() override;
         void left() override;
         void yes() override;
         void no() override;
+        ///@}
 
+        /**
+         * @brief Import a Route.
+         * 
+         * The functions tries to pull the given route id from the RoverApi.
+         * 
+         * @param routeNumber id
+         */
         void importRoute(uint8_t routeNumber);
+
+        /**
+         * @brief Export a Route.
+         * 
+         * The functions tries to push the current route to the RoverApi.
+         * 
+         * @param routeNumber id
+         */
         void exportRoute(uint8_t routeNumber);
+
+        /**
+         * @brief Delete the current Route.
+         * 
+         * @param none this param is not be used.
+         */
         void clearRoute(uint8_t none);
         
     private:
@@ -65,11 +126,26 @@ class MenuRoute : public MenuControl {
         bool blockInput = false;
 };
 
-
+/**
+ * @brief MenuRouteWrapper to call DataFunctions with numeric user input
+ * 
+ */
 class MenuRouteWrapper : public MenuIntInputWrapper {
     public:
+        /**
+         * @brief Construct a new Menu Route Wrapper object.
+         * 
+         * @param menuRoute 
+         * @param dataFunction 
+         */
         MenuRouteWrapper(MenuRoute* menuRoute, DataFunction dataFunction);
 
+        /**
+         * @brief Calls the given DataFunction.
+         * 
+         * @param values The value to be given to the DataFunction.
+         * @param length Number of values, should be 1.
+         */
         void action(int16_t* values, uint8_t length) override;
 
     private:

src/SpecialMenus/Route/menuRoutePoints.cpp

@@ -1,7 +1,7 @@
 /**
  * @file menuRoutePoints.cpp
  * @author Alexander Klein (alex@kleiax.de)
- * @brief 
+ * @brief Contains the implementation of the class MenuRoutePoints.
  * @version 0.1
  * @date 2022-12-28
  * 

src/SpecialMenus/Route/menuRoutePoints.h

@@ -1,7 +1,7 @@
 /**
  * @file menuRoutePoints.h
  * @author Alexander Klein (alex@kleiax.de)
- * @brief 
+ * @brief Contains a class to print the coordinates of a Route.
  * @version 0.1
  * @date 2022-12-28
  * 
@@ -16,11 +16,29 @@
 #include "route.h"
 #include "menuInformationSites.h"
 
+/**
+ * @brief Prints coordinates of Route side by side.
+ * 
+ */
 class MenuRoutePoints : public MenuInformationSites {
     public:
+        /**
+         * @brief Construct a new Menu Route Points object
+         * 
+         * @param route 
+         */
         MenuRoutePoints(Route *route);
+
+        /**
+         * @brief Configure the base class MenuInformationSites
+         * 
+         * Set the amount of pages.
+         */
         void init () override;
 
+        /**
+         * @brief Prints the the coordinates of the current Point. 
+         */
         void printPage() const override;
 
     private:

src/SpecialMenus/Systeminformation/menuSysteminformation.h

@@ -18,8 +18,19 @@
 #include "menuInformationSites.h"
 #include "battery.h"
 
+/**
+ * @brief Prints information about the current system status.
+ * 
+ * The informations are about the batteries, memory and uptime.
+ */
 class MenuSysteminformation : public MenuInformationSites {
     public:
+        /**
+         * @brief Construct a new Menu Systeminformation object
+         * 
+         * @param mainBattery 
+         * @param gamepad 
+         */
         MenuSysteminformation(Battery* mainBattery, Ps3Controller* gamepad);
 
     private:

src/SpecialMenus/driveModi/TestMode/menuTestMode.cpp

@@ -1,7 +1,7 @@
 /**
  * @file menuTestMode.cpp
  * @author Alexander Klein (alex@kleiax.de)
- * @brief 
+ * @brief Contains the implementation of the class MenuTestMode.
  * @version 0.1
  * @date 2022-09-08
  * 

src/SpecialMenus/driveModi/TestMode/menuTestMode.h

@@ -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; }

src/SpecialMenus/driveModi/menuDriveMode.h

@@ -30,8 +30,17 @@ class MenuDriveMode : public MenuControl {
         void down() override {}
         void up() override {}
         void right() override {}
+
+        /**
+         * @brief Goes back to the parentMenu.
+         */
         void left() override;
+
+        /**
+         * @brief Calls left.
+         */
         void no() override;
+        
         void yes() override {}
 
         virtual void printMenu() = 0;