doxy _dashboard.cpp

Author: brentru

src/AdafruitIO_Dashboard.cpp

@@ -19,6 +19,13 @@ AdafruitIO_Dashboard::AdafruitIO_Dashboard(AdafruitIO *io, const char *n) {
 
 AdafruitIO_Dashboard::~AdafruitIO_Dashboard() {}
 
+/**************************************************************************/
+/*!
+    @brief    Checks if Adafruit IO Dashboard exists.
+              https://io.adafruit.com/api/docs/#return-dashboard
+    @return   HTTP response status code, 200 if OK.
+*/
+/**************************************************************************/
 bool AdafruitIO_Dashboard::exists() {
   String url = "/api/v2/";
   url += _io->_username;
@@ -36,6 +43,13 @@ bool AdafruitIO_Dashboard::exists() {
   return status == 200;
 }
 
+/**************************************************************************/
+/*!
+    @brief    Creates a new dashboard.
+              https://io.adafruit.com/api/docs/#create-a-dashboard
+    @return   HTTP response status code, 201 if OK.
+*/
+/**************************************************************************/
 bool AdafruitIO_Dashboard::create() {
   String url = "/api/v2/";
   url += _io->_username;
@@ -66,46 +80,142 @@ bool AdafruitIO_Dashboard::create() {
   return status == 201;
 }
 
+/**************************************************************************/
+/*!
+    @brief    Returns the dashboard owner.
+    @return   Adafruit IO username.
+*/
+/**************************************************************************/
 const char *AdafruitIO_Dashboard::user() { return _io->_username; }
 
 AdafruitIO *AdafruitIO_Dashboard::io() { return _io; }
 
+/**************************************************************************/
+/*!
+    @brief    Creates a new toggle block element on a dashboard connected
+              to provided feed.
+    @param    *feed
+              Reference to an Adafruit IO feed.
+    @return   Toggle block dashboard element.
+*/
+/**************************************************************************/
 ToggleBlock *AdafruitIO_Dashboard::addToggleBlock(AdafruitIO_Feed *feed) {
   return new ToggleBlock(this, feed);
 }
 
+/**************************************************************************/
+/*!
+    @brief    Creates a new momentary block element on a dashboard
+              connected to provided feed.
+    @param    *feed
+              Reference to an Adafruit IO feed.
+    @return   Momentary block dashboard element.
+*/
+/**************************************************************************/
 MomentaryBlock *AdafruitIO_Dashboard::addMomentaryBlock(AdafruitIO_Feed *feed) {
   return new MomentaryBlock(this, feed);
 }
 
+/**************************************************************************/
+/*!
+    @brief    Creates a new slider block element on a dashboard
+              connected to provided feed.
+    @param    *feed
+              Reference to an Adafruit IO feed.
+    @return   Slider block dashboard element.
+*/
+/**************************************************************************/
 SliderBlock *AdafruitIO_Dashboard::addSliderBlock(AdafruitIO_Feed *feed) {
   return new SliderBlock(this, feed);
 }
 
+/**************************************************************************/
+/*!
+    @brief    Creates a new gauge block element on a dashboard
+              connected to provided feed.
+    @param    *feed
+              Reference to an Adafruit IO feed.
+    @return   Gauge block dashboard element.
+*/
+/**************************************************************************/
 GaugeBlock *AdafruitIO_Dashboard::addGaugeBlock(AdafruitIO_Feed *feed) {
   return new GaugeBlock(this, feed);
 }
 
+/**************************************************************************/
+/*!
+    @brief    Creates a new momentary block element on a dashboard
+              connected to provided feed.
+    @param    *feed
+              Reference to an Adafruit IO feed.
+    @return   Text block dashboard element.
+*/
+/**************************************************************************/
 TextBlock *AdafruitIO_Dashboard::addTextBlock(AdafruitIO_Feed *feed) {
   return new TextBlock(this, feed);
 }
 
+/**************************************************************************/
+/*!
+    @brief    Creates a new chart block element on a dashboard
+              connected to provided feed.
+    @param    *feed
+              Reference to an Adafruit IO feed.
+    @return   Chart block dashboard element.
+*/
+/**************************************************************************/
 ChartBlock *AdafruitIO_Dashboard::addChartBlock(AdafruitIO_Feed *feed) {
   return new ChartBlock(this, feed);
 }
 
+/**************************************************************************/
+/*!
+    @brief    Creates a new color block element on a dashboard
+              connected to provided feed.
+    @param    *feed
+              Reference to an Adafruit IO feed.
+    @return   Color block dashboard element.
+*/
+/**************************************************************************/
 ColorBlock *AdafruitIO_Dashboard::addColorBlock(AdafruitIO_Feed *feed) {
   return new ColorBlock(this, feed);
 }
 
+/**************************************************************************/
+/*!
+    @brief    Creates a new map block element on a dashboard
+              connected to provided feed.
+    @param    *feed
+              Reference to an Adafruit IO feed.
+    @return   Map block dashboard element.
+*/
+/**************************************************************************/
 MapBlock *AdafruitIO_Dashboard::addMapBlock(AdafruitIO_Feed *feed) {
   return new MapBlock(this, feed);
 }
 
+/**************************************************************************/
+/*!
+    @brief    Creates a new stream block element on a dashboard
+              connected to provided feed.
+    @param    *feed
+              Reference to an Adafruit IO feed.
+    @return   Stream block dashboard element.
+*/
+/**************************************************************************/
 StreamBlock *AdafruitIO_Dashboard::addStreamBlock(AdafruitIO_Feed *feed) {
   return new StreamBlock(this, feed);
 }
 
+/**************************************************************************/
+/*!
+    @brief    Creates a new image block element on a dashboard
+              connected to provided feed.
+    @param    *feed
+              Reference to an Adafruit IO feed.
+    @return   Image block dashboard element.
+*/
+/**************************************************************************/
 ImageBlock *AdafruitIO_Dashboard::addImageBlock(AdafruitIO_Feed *feed) {
   return new ImageBlock(this, feed);
 }