doxy mapblock

Author: brentru

src/blocks/MapBlock.cpp

@@ -14,6 +14,15 @@
  */
 #include "MapBlock.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Creates a new map Block on an Adafruit IO Dashboard.
+    @param  d
+            Adafruit IO Dashboard name.
+    @param f
+            Adafruit IO Feed to display on the map.
+*/
+/**************************************************************************/
 MapBlock::MapBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f)
     : AdafruitIO_Block(d, f) {
   historyHours = 0;
@@ -22,6 +31,13 @@ MapBlock::MapBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f)
 
 MapBlock::~MapBlock() {}
 
+
+/**************************************************************************/
+/*! 
+    @brief  Sets map block properties.
+    @return String containing properties of the map block.
+*/
+/**************************************************************************/
 String MapBlock::properties() {
 
   if ((strcmp(tile, "contrast") != 0) && (strcmp(tile, "street") != 0) &&

src/blocks/MapBlock.h

@@ -23,22 +23,58 @@ class MapBlock : public AdafruitIO_Block {
   MapBlock(AdafruitIO_Dashboard *d, AdafruitIO_Feed *f);
   ~MapBlock();
 
-  String props;
-  int historyHours;
-  const char *tile;
+  String props;      /*!< Map block properties. */
+  int historyHours;  /*!< Time displayed by map block in hours. */
+  const char *tile;  /*!< Map block title. */
 
-  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 = "map";
+  const char *_visual_type = "map";  /*!< 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; }
 };