add class dox

Author: brentru

src/blocks/ImageBlock.h

@@ -17,24 +17,65 @@
 
 #include "AdafruitIO_Block.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Class for interacting with the Adafruit IO Dashboard
+            Image Block.
+*/
+/**************************************************************************/
 class ImageBlock : public AdafruitIO_Block {
 
 public:
   ImageBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f)
       : AdafruitIO_Block(d, f) {}
   ~ImageBlock() {}
 
-  int height = 6;
-  int width = 4;
+  int height = 6;  /*!< Dashboard block height. */
+  int width = 4;   /*!< Dashboard block width. */
 
+  /******************************************/
+  /*! 
+      @brief  Returns block type 
+      @return Block type.
+  */
+  /******************************************/
   const char *type() { return _visual_type; }
 
 protected:
-  const char *_visual_type = "image";
+  const char *_visual_type = "image";  /*!< Block type. */
 
+  /******************************************/
+  /*! 
+      @brief  Returns width of block.
+      @return Block width.
+  */
+  /******************************************/
   int _width() { return width; }
+
+  /******************************************/
+  /*! 
+      @brief  Returns height of block.
+      @return Block height.
+  */
+  /******************************************/
   int _height() { return height; }
+
+  /******************************************/
+  /*! 
+      @brief  Returns block's row location
+      on an Adafruit IO dashboard.
+      @return Adafruit IO dashboard row.
+  */
+  /******************************************/
   int _row() { return row; }
+
+  /******************************************/
+  /*! 
+      @brief  Returns block's column location
+      on an Adafruit IO dashboard.
+      @return Adafruit IO dashboard column
+  */
+  /******************************************/
   int _column() { return column; }
 };
 

src/blocks/MapBlock.h

@@ -17,6 +17,12 @@
 
 #include "AdafruitIO_Block.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Class for interacting with the Adafruit IO Dashboard
+            Map Block.
+*/
+/**************************************************************************/
 class MapBlock : public AdafruitIO_Block {
 
 public:

src/blocks/MomentaryBlock.h

@@ -17,6 +17,12 @@
 
 #include "AdafruitIO_Block.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Class for interacting with the Adafruit IO Dashboard
+            Momentary Block.
+*/
+/**************************************************************************/
 class MomentaryBlock : public AdafruitIO_Block {
 
 public:

src/blocks/StreamBlock.h

@@ -17,6 +17,12 @@
 
 #include "AdafruitIO_Block.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Class for interacting with the Adafruit IO Dashboard
+            Stream Block.
+*/
+/**************************************************************************/
 class StreamBlock : public AdafruitIO_Block {
 
 public:

src/blocks/TextBlock.h

@@ -17,6 +17,12 @@
 
 #include "AdafruitIO_Block.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Class for interacting with the Adafruit IO Dashboard
+            Slider Block.
+*/
+/**************************************************************************/
 class TextBlock : public AdafruitIO_Block {
 
 public:
@@ -25,18 +31,54 @@ class TextBlock : public AdafruitIO_Block {
 
   const char *fontSize;
 
-  int width = 2;
-  int height = 1;
+  int width = 2;   /*!< Dashboard block width. */
+  int height = 1;  /*!< Dashboard block height. */
 
   String properties();
+
+  /******************************************/
+  /*! 
+      @brief  Returns block type 
+      @return Block type.
+  */
+  /******************************************/
   const char *type() { return _visual_type; }
 
 protected:
-  const char *_visual_type = "text";
+  const char *_visual_type = "text";  /*!< Block type. */
 
+  /******************************************/
+  /*! 
+      @brief  Returns width of block.
+      @return Block width.
+  */
+  /******************************************/
   int _width() { return width; }
+
+  /******************************************/
+  /*! 
+      @brief  Returns height of block.
+      @return Block height.
+  */
+  /******************************************/
   int _height() { return height; }
+
+  /******************************************/
+  /*! 
+      @brief  Returns block's row location
+      on an Adafruit IO dashboard.
+      @return Adafruit IO dashboard row.
+  */
+  /******************************************/
   int _row() { return row; }
+
+  /******************************************/
+  /*! 
+      @brief  Returns block's column location
+      on an Adafruit IO dashboard.
+      @return Adafruit IO dashboard column
+  */
+  /******************************************/
   int _column() { return column; }
 };