Update doxygen comments

lib/NtripClient/ntripClient.cpp

@@ -1,7 +1,7 @@
 /**
  * @file NTRIPClient.cpp
  * @author Alexander Klein (alex@kleiax.de)
- * @brief 
+ * @brief Contains the implementation of the class NTRIPClient.
  * @version 0.1
  * @date 2022-09-18
  * 
@@ -11,15 +11,8 @@
 
 #include "ntripClient.h"
 
-NTRIPClient::NTRIPClient() {
-    
-}
 
-NTRIPClient::~NTRIPClient() {
-    delete this->ntripClient;
-}
-
-void NTRIPClient::init(SFE_UBLOX_GNSS* gps, const char* host, uint16_t port, const char* mountPoint, const char* user, const char* password) {
+NTRIPClient::NTRIPClient(SFE_UBLOX_GNSS* gps, const char* host, uint16_t port, const char* mountPoint, const char* user, const char* password) {
     this->gps = gps;
     strcpy(this->host, host);
     this->port = port;
@@ -31,6 +24,10 @@ void NTRIPClient::init(SFE_UBLOX_GNSS* gps, const char* host, uint16_t port, con
     this->state = NTRIPClientStates::closeConnection;
 }
 
+NTRIPClient::~NTRIPClient() {
+    delete this->ntripClient;
+}
+
 void NTRIPClient::loop() {
     if (millis() - this->lastLoopTime < this->delayTime)
         return;

lib/NtripClient/ntripClient.h

@@ -1,3 +1,14 @@
+/**
+ * @file ntripClient.h
+ * @author Alexander Klein (alex@kleiax.de)
+ * @brief Contains the class NTRIPClient
+ * @version 0.1
+ * @date 2023-02-13
+ * 
+ * @copyright Copyright (c) 2023
+ * 
+ */
+
 #ifndef NTRIP_CLIENT
 #define NTRIP_CLIENT
 
@@ -9,6 +20,10 @@
 
 #include "debugTimes.h"
 
+/**
+ * @brief States for the state machine. 
+ * 
+ */
 enum NTRIPClientStates {
         openConnection,
         pushData,
@@ -16,23 +31,72 @@ enum NTRIPClientStates {
         wait,
         notAvailable
 };
+
+/**
+ * @brief Ntrip Client
+ * 
+ * This class can connect to a ntrip server to pull correction
+ * data and push it to a given gnss module. This module have to be compatible
+ * with the SparkFun u-blox GNSS Arduino Library.
+ */
 class NTRIPClient {
     public:
-        NTRIPClient();
+        /**
+         * @brief Construct a new NTRIPClient object
+         * 
+         * @param gps The Gnss module
+         * @param host 
+         * @param port 
+         * @param mountPoint 
+         * @param user 
+         * @param password 
+         */
+        NTRIPClient(SFE_UBLOX_GNSS* gps, const char* host, uint16_t port, const char* mountPoint, const char* user, const char* password);
         ~NTRIPClient();
 
-        void init(SFE_UBLOX_GNSS* gps, const char* host, uint16_t port, const char* mountPoint, const char* user, const char* password);
+        /**
+         * @brief Runs the state machine.
+         * 
+         * See NTRIPClientStates for more information.
+         * Should be called ever main loop.
+         */
         void loop();
 
+        /**
+         * @brief Configure the Gnss module to accept correction data
+         * 
+         */
         void gpsConfiguration();
 
+        /**
+         * @brief Activate or deactivate the location transmission
+         * 
+         * Some server need the position of the Gnss module to send the
+         * right correction data.
+         * 
+         * @param b 
+         */
         void setTransmitLocation(bool b) { this->transmitLocation = b; }
+
+        /**
+         * @brief Activate or deactivate the connection to the server.
+         * 
+         * @param b 
+         * @return true success
+         * @return false failure
+         */
         bool setActivated(bool b);
 
         bool isConnected();
-        NTRIPClientStates getClientState() { return this->state; }
 
-        
+        /**
+         * @brief Get the Client State object
+         * 
+         * Returns the state of the State machine
+         * 
+         * @return NTRIPClientStates 
+         */
+        NTRIPClientStates getClientState() { return this->state; }
 
     private:
         void pushGPGGA(NMEA_GGA_data_t *nmeaData);