add all definition.h macros

Author: brentru

src/AdafruitIO_Definitions.h

@@ -16,9 +16,9 @@
 #ifndef ADAFRUITIO_DEFINITIONS_H_
 #define ADAFRUITIO_DEFINITIONS_H_
 
-#define ADAFRUITIO_VERSION_MAJOR 3
-#define ADAFRUITIO_VERSION_MINOR 2
-#define ADAFRUITIO_VERSION_PATCH 0
+#define ADAFRUITIO_VERSION_MAJOR 3 /// < Adafruit IO Arduino Major Semvar
+#define ADAFRUITIO_VERSION_MINOR 2 /// < Adafruit IO Arduino Minor Semvar
+#define ADAFRUITIO_VERSION_PATCH 0 /// < Adafruit IO Arduino Patch Semvar
 
 // forward declaration
 class AdafruitIO_Data;
@@ -49,22 +49,21 @@ class AdafruitIOGroupCallback {
 // Uncomment/comment to turn on/off error output
 // #define AIO_ERROR
 
-// Where debug messages will be printed
 // note: if you're using something like Zero or Due, change the below to
 // SerialUSB
-#define AIO_PRINTER Serial
+#define AIO_PRINTER Serial /// < Where debug messages will be printed
 
 // Define actual debug output functions when necessary.
 #ifdef AIO_DEBUG
 #define AIO_DEBUG_PRINT(...)                                                   \
-  { AIO_PRINTER.print(__VA_ARGS__); }
+  { AIO_PRINTER.print(__VA_ARGS__); } /// < Debug output for Printer
 #define AIO_DEBUG_PRINTLN(...)                                                 \
-  { AIO_PRINTER.println(__VA_ARGS__); }
+  { AIO_PRINTER.println(__VA_ARGS__); } /// < Println-like debug output for Printer
 #else
 #define AIO_DEBUG_PRINT(...)                                                   \
-  {}
+  {} /// < Prints if AIO_DEBUG is True
 #define AIO_DEBUG_PRINTLN(...)                                                 \
-  {}
+  {} /// < Prints line if AIO_DEBUG is True
 #endif
 
 // Define actual error output functions when necessary.
@@ -80,49 +79,38 @@ class AdafruitIOGroupCallback {
   {}
 #endif
 
-// Adafruit IO Ping Interval, in milliseconds
-#define AIO_PING_INTERVAL 60000
-// Time to wait between re-connecting to Adafruit IO after throttled
-#define AIO_THROTTLE_RECONNECT_INTERVAL 60000
-// Time to wait for a successful reconnection after MQTT disconnect
-#define AIO_MQTT_CONNECTION_TIMEOUT 60000
-// Time to wait for a successful reconnection after network disconnect
-#define AIO_NET_CONNECTION_TIMEOUT 60000
-// Time to wait for a net disconnect to take effect
-#define AIO_NET_DISCONNECT_WAIT 300
+#define AIO_PING_INTERVAL 60000                ///< Adafruit IO Ping Interval, in milliseconds
+#define AIO_THROTTLE_RECONNECT_INTERVAL 60000  ///< Time to wait between re-connecting to Adafruit IO after throttled
+#define AIO_MQTT_CONNECTION_TIMEOUT 60000      ///< Time to wait for a successful reconnection after MQTT disconnect
+#define AIO_NET_CONNECTION_TIMEOUT 60000       ///< Time to wait for a successful reconnection after network disconnect
+#define AIO_NET_DISCONNECT_WAIT 300            ///< Time to wait for a net disconnect to take effect
 
-#define AIO_ERROR_TOPIC "/errors"
-#define AIO_THROTTLE_TOPIC "/throttle"
+#define AIO_ERROR_TOPIC "/errors"              ///< Adafruit IO Error MQTT Topic
+#define AIO_THROTTLE_TOPIC "/throttle"         ///< Adafruit IO Throttle MQTT Topic
 
 // latest fingerprint can be generated with
 // echo | openssl s_client -connect io.adafruit.com:443 | openssl x509
 // -fingerprint -noout
 #define AIO_SSL_FINGERPRINT                                                    \
-  "77 00 54 2D DA E7 D8 03 27 31 23 99 EB 27 DB CB A5 4C 57 18"
+  "77 00 54 2D DA E7 D8 03 27 31 23 99 EB 27 DB CB A5 4C 57 18" ///< Latest Adafruit IO SSL Fingerprint
 
-// Maximum length of an Adafruit IO Feed name
-#define AIO_FEED_NAME_LENGTH 20
-// Maximum length of data sent/recieved from Adafruit IO
-#define AIO_DATA_LENGTH 45
-// Maximum comma-separated-value length from Adafruit IO
-#define AIO_CSV_LENGTH 150
+#define AIO_FEED_NAME_LENGTH 20 ///< Maximum length of an Adafruit IO Feed name
+#define AIO_DATA_LENGTH 45      ///< Maximum length of data sent/recieved from Adafruit IO
+#define AIO_CSV_LENGTH 150      ///< Maximum comma-separated-value length from Adafruit IO
 
 /** aio_status_t offers 13 status states */
 typedef enum {
 
-  // CONNECTING
-  AIO_IDLE = 0,
+  AIO_IDLE = 0,               // Waiting for connection establishement
   AIO_NET_DISCONNECTED = 1,   // Network disconnected
   AIO_DISCONNECTED = 2,       // Disconnected from Adafruit IO
   AIO_FINGERPRINT_UNKOWN = 3, // Unknown AIO_SSL_FINGERPRINT
 
-  // FAILURE
   AIO_NET_CONNECT_FAILED = 10,  // Failed to connect to network
   AIO_CONNECT_FAILED = 11,      // Failed to connect to Adafruit IO
   AIO_FINGERPRINT_INVALID = 12, // Unknown AIO_SSL_FINGERPRINT
-  AIO_AUTH_FAILED = 13, // Invalid Adafruit IO login credentials provided.
-  AIO_SSID_INVALID =
-      14, // SSID is "" or otherwise invalid, connection not attempted
+  AIO_AUTH_FAILED = 13,         // Invalid Adafruit IO login credentials provided.
+  AIO_SSID_INVALID = 14,        // SSID is "" or otherwise invalid, connection not attempted
 
   // SUCCESS
   AIO_NET_CONNECTED = 20,           // Connected to Adafruit IO