Update doxygen comments

2023-02-13 20:36:04 +01:00
parent 1604cb0026
commit deecf7724c
23 changed files with 497 additions and 70 deletions
@@ -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;