documentation checked and edit

for all files in lib folder

lib/Network/network.h

@@ -20,10 +20,20 @@
 #include <esp_now.h>
 #include <esp_wifi.h>
 
-typedef void (*recieveCallbackPtr)(const uint8_t *mac, const uint8_t *incomingData, int len);
+/**
+ * @brief Typedef to easy handle the receive Callback
+ */
+typedef void (*receiveCallbackPtr)(const uint8_t *mac, const uint8_t *incomingData, int len);
+
+/**
+ * @brief Typedef to easy handle the send Callback
+ */
 typedef void (*sendCallbackPtr)(const uint8_t *mac_addr, esp_now_send_status_t status);
 
-struct NetworkAdresses
+/**
+ * @brief A Struct to hold all network addresses
+ */
+struct NetworkAddresses
 {
     IPAddress localIP;
     IPAddress gateway;
@@ -33,17 +43,58 @@ struct NetworkAdresses
     uint16_t mqttPort = 1883;
 };
 
+/**
+ * @brief A class to manage the wireless connections
+ */
 class Network : public Component
 {
 public:
+    /**
+     * @brief Construct a new Network object
+     *
+     * With this constructor the esp gets its ip from a Dhcp server
+     *
+     * @param ssid
+     * @param passphrase
+     */
     Network(const char *ssid, const char *passphrase);
-    Network(const char *ssid, const char *passphrase, NetworkAdresses adresses);
+
+    /**
+     * @brief Construct a new Network object
+     *
+     * This constructor is used for a static ip setup
+     *
+     * @param ssid
+     * @param passphrase
+     * @param addresses
+     */
+    Network(const char *ssid, const char *passphrase, NetworkAddresses addresses);
 
     ~Network();
 
-    bool activateEspNow(recieveCallbackPtr reci, sendCallbackPtr send);
+    /**
+     * @brief Activate ESP-NOW to communicate with the remote Control
+     *
+     * @param receive
+     * @param send
+     * @return true
+     * @return false
+     */
+    bool activateEspNow(receiveCallbackPtr receive, sendCallbackPtr send);
+
+    /**
+     * @brief Activate MQTT to send debug messages
+     *
+     * @param user
+     * @param passphrase
+     * @return true
+     * @return false
+     */
     bool activateMqtt(const char *user = nullptr, const char *passphrase = nullptr);
 
+    /**
+     * @brief Print the current used IPs
+     */
     const void printIPs();
 
     bool isWifiConnected() const { return this->wifiConnected; }
@@ -61,11 +112,11 @@ private:
     void checkMqtt();
     bool connectMqtt();
 
-    NetworkAdresses adresses;
+    NetworkAddresses addresses;
     WiFiClient wifiClient;
     PubSubClient *mqttClient = nullptr;
 
-    bool initSucessful = false;
+    bool initSuccessful = false;
     bool wifiConnected = false;
     bool mqttConnected = false;
 
@@ -73,8 +124,8 @@ private:
     const char *mqttPassphrase = nullptr;
 
     uint8_t broadcastAddress[6] = {0xC8, 0xC9, 0xA3, 0xC8, 0x57, 0x10};
-    uint32_t lastWifiRecoonectAttemp = 0;
-    uint32_t lastMqttReconnectAttemp = 0;
+    uint32_t lastWifiReconnectAttempt = 0;
+    uint32_t lastMqttReconnectAttempt = 0;
 
     static constexpr uint8_t wifiConnectTimeout = 20;
     static constexpr uint16_t wifiConnectLoopTime = 500;