doxygen!

Author: brentru

src/Wippersnapper.cpp

@@ -522,6 +522,7 @@ bool encodeI2CResponse(wippersnapper_signal_v1_I2CResponse *msgi2cResponse) {
               Protobuf message's tag type.
     @param    arg
               Optional arguments from decoder calling function.
+    @returns  True if decoded successfully, False otherwise.
 */
 /******************************************************************************************/
 bool cbDecodeSignalRequestI2C(pb_istream_t *stream, const pb_field_t *field,

src/Wippersnapper.h

@@ -55,7 +55,7 @@
 #endif
 
 // Uncomment the following use the staging IO server //
-#define USE_STAGING
+#define USE_STAGING ///< Use Adafruit IO staging certificate
 #define IO_MQTT_SERVER "io.adafruit.us" ///< Adafruit IO MQTT Server
 
 //#define IO_MQTT_SERVER "io.adafruit.com" ///< Adafruit IO MQTT Server
@@ -313,7 +313,7 @@ class Wippersnapper {
                             milliseconds. */
   char *_topic_signal_i2c_device; /*!< Topic carries messages from a broker to a
                                      device. */
-  bool pinCfgCompleted = false;
+  bool pinCfgCompleted = false; /*!< Did initial pin sync complete? */
 
 private:
   void _init();

src/components/i2c/WipperSnapper_I2C.cpp

@@ -74,7 +74,8 @@ WipperSnapper_Component_I2C::~WipperSnapper_Component_I2C() {
 
 /*****************************************************/
 /*!
-    @brief    Returns if port is already initialized.
+    @brief    Returns if i2c port is initialized.
+    @returns  True if initialized, False otherwise.
 */
 /*****************************************************/
 bool WipperSnapper_Component_I2C::isInitialized() { return _isInit; }

src/components/i2c/WipperSnapper_I2C.h

@@ -25,6 +25,11 @@
 class Wippersnapper;
 class I2C_Driver;
 
+/**************************************************************************/
+/*!
+    @brief  Class that provides an interface with the I2C bus.
+*/
+/**************************************************************************/
 class WipperSnapper_Component_I2C {
 public:
   WipperSnapper_Component_I2C(

src/drivers/I2C_Driver.cpp

@@ -19,7 +19,7 @@
     @brief    Creates a generic I2C Driver object.
     @param    deviceAddress
               The i2c device's address.
-    @param    _i2c
+    @param    i2c
               The desired i2c port.
 */
 /*******************************************************************************/
@@ -44,6 +44,10 @@ I2C_Driver::~I2C_Driver() {
 /*!
     @brief    Sets an I2C device's
                 polling period, in seconds.
+    @param    Period
+            The time elapsed between
+            polling the I2C sensor for new
+            data.
 */
 /*******************************************/
 void I2C_Driver::setPeriod(float period) { _pollPeriod = period; }

src/drivers/I2C_Driver.h

@@ -19,6 +19,11 @@
 
 #include <Adafruit_AHTX0.h>
 
+/**************************************************************************/
+/*!
+    @brief  Class that provides a sensor driver interface for the AHTX0.
+*/
+/**************************************************************************/
 class I2C_Driver {
 public:
   // GENERIC, shared