documentation checked and edit

for all files in lib folder

src/OutputBuf/outputBuf.cpp

@@ -1,5 +1,5 @@
 /**
- * @file outputBufMqtt.cpp
+ * @file outputBuf.cpp
  * @author Alexander Klein (alex@kleiax.de)
  * @brief Contains the implementation of the class OutputBufMqtt
  * @version 0.1

src/OutputBuf/outputBuf.h

@@ -1,5 +1,5 @@
 /**
- * @file outputBufMqtt.h
+ * @file outputBuf.h
  * @author Alexander Klein (alex@kleiax.de)
  * @brief Contains a small class that provide a streambuf
  * 
@@ -38,6 +38,7 @@ class OutputBuf : public std::streambuf {
          * @brief Construct a new Output Buf Mqtt object
          * 
          * @param debugMqtt 
+         * @param serialBT
          */
         OutputBuf(DebugMqtt* debugMqtt = nullptr, BluetoothSerial* serialBT = nullptr);
 

src/SpecialMenus/Systeminformation/menuSysteminformation.h

@@ -31,8 +31,7 @@ class MenuSysteminformation : public MenuInformationSites {
         /**
          * @brief Construct a new Menu Systeminformation object
          * 
-         * @param mainBattery 
-         * @param gamepad 
+         * @param mainBattery
          */
         MenuSysteminformation(Battery* mainBattery);
 

src/SpecialMenus/driveModi/CalibrateCompass/menuCalibrateCompass.cpp

@@ -81,23 +81,23 @@ void MenuCalibrateCompass::printPage() const {
 
         case 8:
             lineOne = "X min: ";
-            lineOne.concat(this->caliCompass->getCallibrationData().data[0][0]);
+            lineOne.concat(this->caliCompass->getCalibrationData().data[0][0]);
             lineTwo = "X max: ";
-            lineTwo.concat(this->caliCompass->getCallibrationData().data[0][1]);
+            lineTwo.concat(this->caliCompass->getCalibrationData().data[0][1]);
             break;
 
         case 9:
             lineOne = "Y min: ";
-            lineOne.concat(this->caliCompass->getCallibrationData().data[1][0]);
+            lineOne.concat(this->caliCompass->getCalibrationData().data[1][0]);
             lineTwo = "Y max: ";
-            lineTwo.concat(this->caliCompass->getCallibrationData().data[1][1]);
+            lineTwo.concat(this->caliCompass->getCalibrationData().data[1][1]);
             break;
 
         case 10:
             lineOne = "Z min: ";
-            lineOne.concat(this->caliCompass->getCallibrationData().data[2][0]);
+            lineOne.concat(this->caliCompass->getCalibrationData().data[2][0]);
             lineTwo = "Z max: ";
-            lineTwo.concat(this->caliCompass->getCallibrationData().data[2][1]);
+            lineTwo.concat(this->caliCompass->getCalibrationData().data[2][1]);
             break;
 
         default:

src/SpecialMenus/driveModi/TestMode/menuTestMode.cpp

@@ -164,7 +164,7 @@ void MenuTestMode::init() {
     auto *lightBlueAction = new MenuAction("Blue", dummy);
     auto *lightOffAction = new MenuAction("Off", dummy);    
 
-    // Add entrys to the menus
+    // Add entries to the menus
     this->mainMenu->addEntry(engineAction);
     this->mainMenu->addEntry(drivingAction);
     this->mainMenu->addEntry(encoderAction);

src/SpecialMenus/driveModi/TestMode/speedometerTest.cpp

@@ -1,5 +1,5 @@
 /**
- * @file menuTest.cpp
+ * @file speedometerTest.cpp
  * @author Alexander Klein (alex@kleiax.de)
  * @brief Contains the implementation of the class SpeedometerTest.
  * @version 0.1

src/SpecialMenus/driveModi/TestMode/speedometerTest.h

@@ -1,5 +1,5 @@
 /**
- * @file menuTest.h
+ * @file speedometerTest.h
  * @author Alexander Klein (alex@kleiax.de)
  * @brief Contains a class to test the wheel encoder.
  * @version 0.1

src/driveModi/driveManager.h

@@ -22,14 +22,21 @@
 
 class DriveManager : public Component {
     public:
+
         /**
          * @brief Construct a new Drive Manager object
          * 
-         * Creates a Navigation object
-         * 
          * @param moveControl 
+         * @param sensorData 
+         * @param input 
          */
         DriveManager(MoveControl *moveControl, const SensorData* sensorData, const ControlPadInput *input);
+
+        /**
+         * @brief Construct a new Drive Manager object
+         * 
+         * @param params 
+         */
         DriveManager(DriveModiParams params);
 
         /**

src/main.cpp

@@ -70,7 +70,7 @@ void restart();
 void receiveCallback(const uint8_t *mac, const uint8_t *incomingData, int len);
 void sendCallback(const uint8_t *mac_addr, esp_now_send_status_t status);
 void lcdWrapperCallback(const char data[][LcdWrapper::totalRows], uint8_t lines, uint8_t rows);
-NetworkAdresses setIPs();
+NetworkAddresses setIPs();
 
 void setup()
 {
@@ -130,7 +130,7 @@ void setup()
                             static_cast<const char*>(NtripConfig::mountPoint),
                             static_cast<const char*>(NtripConfig::user), 
                             static_cast<const char*>(NtripConfig::password));
-    // sensorData->enableGyroskop();
+    // sensorData->enableGyroscope();
     driveManager = new DriveManager(&moveController, sensorData, controlPad->getControlPadDataPtr());
 
     char wifiIndicator = 'X';
@@ -355,9 +355,9 @@ void lcdWrapperCallback(const char data[][LcdWrapper::totalRows], uint8_t lines,
     }
 }
 
-NetworkAdresses setIPs()
+NetworkAddresses setIPs()
 {
-    NetworkAdresses adresses;
+    NetworkAddresses adresses;
     adresses.localIP.fromString(static_cast<const char *>(NetworkConfig::ip));
     adresses.subnet.fromString(static_cast<const char *>(NetworkConfig::subnet));
     adresses.gateway.fromString(static_cast<const char *>(NetworkConfig::gateway));