everywhere same code header

reformatings
cdoc

inc/Config.h

@@ -1,14 +1,14 @@
-//
-// Created by lukas on 11.02.20.
-//
+/**
+ * A static class to manage the configuration file, read/write parameters to it.
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 11.02.2020
+ */
 
 #pragma once
 
 #include <string>
 
-/**
- * A static class to manage the configuration file, read/write parameters to it.
- */
 class Config {
 public:
     /**
@@ -75,11 +75,12 @@ private:
      */
     static bool telegramSupport;
 
+    /**
+     * helper variables for storing keys and ids
+     */
     static std::string dynuapikey;
-
     static std::string domainid; //id of the dynu domain
     static std::string domainname;
-
     static std::string telegramApiKey;
     static std::string chatId;
 };

inc/FileLogger.h

@@ -1,6 +1,9 @@
-//
-// Created by lukas on 05.05.19.
-//
+/**
+ * Read and write current ip to a temp file to remember last ip until restart
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 05.05.2019
+ */
 
 #pragma once
 

inc/IPRefresher.h

@@ -1,6 +1,11 @@
-//
-// Created by lukas on 02.08.19.
-//
+/**
+ * IPrefresher library
+ * - start checking ip once
+ * - or in loop mode
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 06.04.2019
+ */
 
 #pragma once
 

inc/IpHelper.h

@@ -1,14 +1,14 @@
-//
-// Created by lukas on 07.05.20.
-//
+/**
+ * A helper class for general IP String actions
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 07.05.2020
+ */
 
 #pragma once
 
 #include <string>
 
-/**
- * General helper class for IP actions
- */
 class IpHelper {
 public:
     /**

inc/Logger.h

@@ -1,6 +1,10 @@
-//
-// Created by lukas on 26.10.19.
-//
+/**
+ * Fancy console log output format
+ * todo log level support
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 26.10.2019
+ */
 
 #pragma once
 

inc/api/API.h

@@ -1,6 +1,11 @@
-//
-// Created by lukas on 06.04.19.
-//
+/**
+ * API class
+ * - manages all curl download stuff
+ * - easy POST/GET requests
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 06.04.2019
+ */
 
 #pragma once
 

inc/api/DynuAPI.h

@@ -1,6 +1,9 @@
-//
-// Created by lukas on 18.06.19.
-//
+/**
+ * Dynu API - Refresh the IP
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 18.06.2019
+ */
 
 #pragma once
 
@@ -24,8 +27,18 @@ public:
     void init(const std::string &dynuApiKey, const std::string &domainId, const std::string &domainName);
 
 private:
-    std::string dynuapikey; // Dynu API key
+    /**
+     * Dynu API Key
+     */
+    std::string dynuapikey;
 
-    std::string domainid; //id of the dynu domain
+    /**
+     * Dynu Domain ID
+     */
+    std::string domainid;
+
+    /**
+     * Domain name eg. "mydomain.dynu.net"
+     */
     std::string domainname;
 };

inc/api/Hashmap.h

@@ -1,6 +1,9 @@
-//
-// Created by lukas on 07.04.19.
-//
+/**
+ * A Hashmap class for easier Key-Value maps
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 07.04.2019
+ */
 
 #pragma once
 

inc/api/IPAPI.h

@@ -1,6 +1,9 @@
-//
-// Created by lukas on 18.06.19.
-//
+/**
+ * IPAPI for getting global ip of current network
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 18.06.2019
+ */
 
 #pragma once
 

inc/api/TelegramAPI.h

@@ -1,6 +1,9 @@
-//
-// Created by lukas on 08.05.19.
-//
+/**
+ * Telegram API for sending message to specific chat
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 08.05.2019
+ */
 
 #pragma once