add stream block

Author: brentru

src/blocks/MomentaryBlock.cpp

@@ -14,6 +14,15 @@
  */
 #include "MomentaryBlock.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Creates a new Momentary Block on an Adafruit IO Dashboard.
+    @param  d
+            Adafruit IO Dashboard name.
+    @param f
+            Adafruit IO Feed to display on the momentary.
+*/
+/**************************************************************************/
 MomentaryBlock::MomentaryBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f)
     : AdafruitIO_Block(d, f) {
   text = "RESET";
@@ -23,6 +32,12 @@ MomentaryBlock::MomentaryBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f)
 
 MomentaryBlock::~MomentaryBlock() {}
 
+/**************************************************************************/
+/*! 
+    @brief  Sets momentary block properties.
+    @return String containing properties of the momentary block.
+*/
+/**************************************************************************/
 String MomentaryBlock::properties() {
   String props = "{\"text\":\"";
   props += text;

src/blocks/StreamBlock.cpp

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

src/blocks/StreamBlock.h

@@ -23,24 +23,60 @@ class StreamBlock : public AdafruitIO_Block {
   StreamBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f);
   ~StreamBlock();
 
-  const char *fontSize;
-  const char *fontColor;
-  bool showErrors;
-  bool showTimestamp;
-  bool showName;
+  const char *fontSize;   /*!< Block's text font size. */
+  const char *fontColor;  /*!< Block's text font color. */
+  bool showErrors;        /*!< Display Adafruit IO errors .*/
+  bool showTimestamp;     /*!< Display timestamp metadata. */
+  bool showName;          /*!< Display value name.. */
 
-  int width = 6;
-  int height = 4;
+  int width = 6;          /*!< 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 = "stream";
+  const char *_visual_type = "stream";  /*!< 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; }
 };