doxy gauge, text blocks

Author: brentru

src/blocks/GaugeBlock.cpp

@@ -14,6 +14,15 @@
  */
 #include "GaugeBlock.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Creates a new Gauge Block on an Adafruit IO Dashboard.
+    @param  d
+            Adafruit IO Dashboard name.
+    @param f
+            Adafruit IO Feed to display on the Gauge.
+*/
+/**************************************************************************/
 GaugeBlock::GaugeBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f)
     : AdafruitIO_Block(d, f) {
   min = 0;
@@ -24,6 +33,12 @@ GaugeBlock::GaugeBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f)
 
 GaugeBlock::~GaugeBlock() {}
 
+/**************************************************************************/
+/*! 
+    @brief  Sets Gauge block properties.
+    @return String containing properties of the Gauge block.
+*/
+/**************************************************************************/
 String GaugeBlock::properties() {
   int w = 0;
 

src/blocks/GaugeBlock.h

@@ -17,30 +17,73 @@
 
 #include "AdafruitIO_Block.h"
 
+
+/**************************************************************************/
+/*! 
+    @brief  Class for interacting with the Adafruit IO Dashboard
+            Gauge Block.
+*/
+/**************************************************************************/
 class GaugeBlock : public AdafruitIO_Block {
 
 public:
   GaugeBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f);
   ~GaugeBlock();
 
-  int min;
-  int max;
+  int min;                /*!< Min. value displayed on gauge. */
+  int max;                /*!< Max. value displayed on gauge. */
 
-  const char *ringWidth;
-  const char *label;
+  const char *ringWidth;  /*!< Width of gauge's ring. */
+  const char *label;      /*!< Gauge text label. */
 
-  int width = 4;
-  int height = 4;
+  int width = 4;          /*!< Dashboard block width. */
+  int height = 4;         /*!< Dashboard block height. */
 
   String properties();
+
+  /******************************************/
+  /*! 
+      @brief  Returns block type 
+      @return Block type.
+  */
+  /******************************************/
   const char *type() { return _visual_type; }
 
 protected:
-  const char *_visual_type = "gauge";
+  const char *_visual_type = "gauge";  /*!< 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/TextBlock.cpp

@@ -14,13 +14,28 @@
  */
 #include "TextBlock.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Creates a new Text Block on an Adafruit IO Dashboard.
+    @param  d
+            Adafruit IO Dashboard name.
+    @param f
+            Adafruit IO Feed to display on the Text.
+*/
+/**************************************************************************/
 TextBlock::TextBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f)
     : AdafruitIO_Block(d, f) {
   fontSize = "small";
 }
 
 TextBlock::~TextBlock() {}
 
+/**************************************************************************/
+/*! 
+    @brief  Sets Text block properties.
+    @return String containing properties of the Text block.
+*/
+/**************************************************************************/
 String TextBlock::properties() {
   int s = 0;
 

src/blocks/TextBlock.h

@@ -29,7 +29,7 @@ class TextBlock : public AdafruitIO_Block {
   TextBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f);
   ~TextBlock();
 
-  const char *fontSize;
+  const char *fontSize;  /*!< Dashboard block text font size. */
 
   int width = 2;   /*!< Dashboard block width. */
   int height = 1;  /*!< Dashboard block height. */