doxy /wifi

Author: brentru

src/wifi/AdafruitIO_AIRLIFT.h

@@ -26,7 +26,7 @@
 #include "SPI.h"
 #include "WiFiNINA.h"
 
-#define NINAFWVER "1.0.0"
+#define NINAFWVER "1.0.0"  /*!< nina-fw version compatible with this library. */
 
 /****************************************************************************/
 /*!
@@ -134,15 +134,18 @@ class AdafruitIO_AIRLIFT : public AdafruitIO {
   const char *connectionType() { return "AIRLIFT"; }
 
 protected:
-  const char *_ssid;
-  const char *_pass;
-  String _fv = "0.0.0";
-  int _ssPin, _ackPin, _rstPin, _gpio0Pin = -1;
-
-  WiFiSSLClient *_http_client;
-  WiFiSSLClient *_mqtt_client;
-
-  SPIClass *_wifi;
+  const char *_ssid;     /*!< WiFi network SSID. */
+  const char *_pass;     /*!< WiFi network password. */
+  String _fv = "0.0.0";  /*!< nina-fw version, read from ESP32. */
+  int _ssPin = -1;       /*!< ESP32 slave-select pin. */
+  int _ackPin = -1;      /*!< ESP32 ACK pin. */
+  int  _rstPin = -1;     /*!< ESP32 RESET pin. */
+  int _gpio0Pin = -1;    /*!< ESP32 GPIO0 pin. */
+
+  WiFiSSLClient *_http_client;  /*!< Instance of HTTP client. */
+  WiFiSSLClient *_mqtt_client;  /*!< Instance of MQTT client. */
+
+  SPIClass *_wifi;  /*!< Instance of WiFi. */
 
   /**************************************************************************/
   /*!

src/wifi/AdafruitIO_ESP8266.cpp

@@ -1,5 +1,5 @@
 /*!
- * @file AdafruitIO_8266.cpp
+ * @file AdafruitIO_ESP8266.h
  *
  * Adafruit invests time and resources providing this open source code.
  * Please support Adafruit and open source hardware by purchasing