doxygen .h classes

Author: brentru

src/AdafruitIO_Dashboard.h

@@ -29,6 +29,12 @@
 class AdafruitIO;
 class AdafruitIO_Feed;
 
+/**************************************************************************/
+/*! 
+    @brief  Class for interacting with Adafruit IO Dashboards.
+            https://io.adafruit.com/api/docs/#dashboards
+*/
+/**************************************************************************/
 class AdafruitIO_Dashboard {
 
 public:

src/AdafruitIO_Data.h

@@ -18,6 +18,12 @@
 // forward decl
 class AdafruitIO_Feed;
 
+/**************************************************************************/
+/*! 
+    @brief  Class for interacting with Adafruit IO Data Records.
+            https://io.adafruit.com/api/docs/#data
+*/
+/**************************************************************************/
 class AdafruitIO_Data {
 
 public:

src/AdafruitIO_Ethernet.h

@@ -24,7 +24,11 @@
 
 #include "AdafruitIO.h"
 
-// all logic in .h to avoid auto compile
+/**************************************************************************/
+/*! 
+    @brief  Class for interfacing with the Adafruit Ethernet FeatherWing
+*/
+/**************************************************************************/
 class AdafruitIO_Ethernet : public AdafruitIO {
 
 public:

src/AdafruitIO_FONA.h

@@ -25,7 +25,12 @@
 #define FONA_RI 7
 #define FONA_BAUD 4800
 
-// all logic in .h to avoid auto compile
+
+/**************************************************************************/
+/*! 
+    @brief  Class for interfacing with an Adafruit FONA Ceullar Module
+*/
+/**************************************************************************/
 class AdafruitIO_FONA : public AdafruitIO {
 
 public:

src/AdafruitIO_Feed.h

@@ -21,6 +21,13 @@
 // forward declaration
 class AdafruitIO;
 
+/**************************************************************************/
+/*! 
+    @brief  Class that provides methods for interfacing with
+            Adafruit IO feed topics.
+            https://io.adafruit.com/api/docs/mqtt.html#mqtt-topics
+*/
+/**************************************************************************/
 class AdafruitIO_Feed : public AdafruitIO_MQTT {
 
 public:

src/AdafruitIO_Group.h

@@ -21,6 +21,12 @@
 // forward declaration
 class AdafruitIO;
 
+/**************************************************************************/
+/*! 
+    @brief  Class for interacting with Adafruit IO Grouped Feeds
+            https://io.adafruit.com/api/docs/mqtt.html#group-topics
+*/
+/**************************************************************************/
 class AdafruitIO_Group : public AdafruitIO_MQTT {
 
 public:

src/AdafruitIO_MQTT.h

@@ -14,6 +14,11 @@
 
 #include "Arduino.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Class that contains MQTT subscription callbacks.
+*/
+/**************************************************************************/
 class AdafruitIO_MQTT {
 
 public:

src/AdafruitIO_Time.h

@@ -22,6 +22,13 @@ class AdafruitIO;
 
 typedef void (*AdafruitIOTimeCallbackType)(char *value, uint16_t len);
 
+/**************************************************************************/
+/*! 
+    @brief  Class that contains functions for interacting with
+            the Adafruit IO Time Service.
+*/
+/**************************************************************************/
+class Adafruit_TSL2561_Unified : public Adafruit_Sensor {
 class AdafruitIO_Time : public AdafruitIO_MQTT {
 
 public: