doxy chartblock,colorblock,sliderblock

Author: brentru

src/blocks/ChartBlock.h

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

src/blocks/ColorBlock.h

@@ -17,24 +17,65 @@
 
 #include "AdafruitIO_Block.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Class for interacting with the Adafruit IO Dashboard
+            Color Block.
+*/
+/**************************************************************************/
 class ColorBlock : public AdafruitIO_Block {
 
 public:
   ColorBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f)
       : AdafruitIO_Block(d, f) {}
   ~ColorBlock() {}
 
-  int width = 4;
-  int height = 4;
+  int width = 4;  /*!< Dashboard block width. */
+  int height = 4; /*!< Dashboard block height. */
 
+  /******************************************/
+  /*! 
+      @brief  Returns block type 
+      @return Block type.
+  */
+  /******************************************/
   const char *type() { return _visual_type; }
 
 protected:
-  const char *_visual_type = "color_picker";
+  const char *_visual_type = "color_picker"; /*!< 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/SliderBlock.h

@@ -29,13 +29,13 @@ class SliderBlock : public AdafruitIO_Block {
   SliderBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f);
   ~SliderBlock();
 
-  int min;  /*!< Minimum slider data value. */
-  int max;  /*!< Maximum slider data value. */
-  int step; /*!< Slider data step value. */
-  const char *label; /*!< Slider title. */
+  int min;            /*!< Minimum slider data value. */
+  int max;            /*!< Maximum slider data value. */
+  int step;           /*!< Slider data step value. */
+  const char *label;  /*!< Slider title. */
 
-  int width = 4;  /*!< Dashboard block width. */
-  int height = 2; /*!< Dashboard block height. */
+  int width = 4;   /*!< Dashboard block width. */
+  int height = 2;  /*!< Dashboard block height. */
 
   String properties();