doxy

Author: brentru

src/components/i2c/drivers/drvOut7Seg.h

@@ -25,11 +25,13 @@
 #include <Adafruit_LEDBackpack.h>
 #include <Arduino.h>
 
-#define LED_BACKPACK_ALIGNMENT_UNSPECIFIED 0
-#define LED_BACKPACK_ALIGNMENT_LEFT 1
-#define LED_BACKPACK_ALIGNMENT_RIGHT 2
-#define LED_BACKPACK_ALIGNMENT_DEFAULT LED_BACKPACK_ALIGNMENT_LEFT
-#define LED_MAX_CHARS 4
+#define LED_BACKPACK_ALIGNMENT_UNSPECIFIED 0 ///< Unspecified alignment
+#define LED_BACKPACK_ALIGNMENT_LEFT 1        ///< Left alignment
+#define LED_BACKPACK_ALIGNMENT_RIGHT 2       ///< Right alignment
+#define LED_BACKPACK_ALIGNMENT_DEFAULT                                         \
+  LED_BACKPACK_ALIGNMENT_LEFT ///< Default alignment
+#define LED_MAX_CHARS                                                          \
+  4 ///< Maximum number of characters to display on the 7-segment display
 
 /*!
     @brief  Class that provides a driver for an Adafruit 7-Segment LED matrix

src/components/i2c/drivers/drvOutCharLcd.h

@@ -69,8 +69,12 @@ class drvOutCharLcd : public drvOutputBase {
   /*!
       @brief    Writes a message to the LCD.
       @note     MUST be called prior to begin() to configure the LCD's size
-      @param    message
-                The message to be displayed.
+      @param   rows
+                The number of rows in the LCD.
+      @param   cols
+              The number of columns in the LCD.
+      @param   enable_backlight
+              True if the backlight is enabled, False otherwise.
   */
   void ConfigureCharLcd(uint8_t rows, uint8_t cols, bool enable_backlight) {
     _rows = rows;

src/components/i2c/drivers/drvOutQuadAlphaNum.h

@@ -1,5 +1,5 @@
 /*!
- * @file drvQuadAlphaNum.h
+ * @file drvOutQuadAlphaNum.h
  *
  * Device driver for Quad Alphanumeric Displays w/I2C Backpack
  *
@@ -20,11 +20,13 @@
 #include <Adafruit_LEDBackpack.h>
 #include <Arduino.h>
 
-#define LED_BACKPACK_ALIGNMENT_UNSPECIFIED 0
-#define LED_BACKPACK_ALIGNMENT_LEFT 1
-#define LED_BACKPACK_ALIGNMENT_RIGHT 2
-#define LED_BACKPACK_ALIGNMENT_DEFAULT LED_BACKPACK_ALIGNMENT_LEFT
-#define LED_MAX_CHARS 4
+#define LED_BACKPACK_ALIGNMENT_UNSPECIFIED 0 ///< Unspecified alignment
+#define LED_BACKPACK_ALIGNMENT_LEFT 1        ///< Left alignment
+#define LED_BACKPACK_ALIGNMENT_RIGHT 2       ///< Right alignment
+#define LED_BACKPACK_ALIGNMENT_DEFAULT                                         \
+  LED_BACKPACK_ALIGNMENT_LEFT ///< Default alignment
+#define LED_MAX_CHARS                                                          \
+  4 ///< Maximum number of characters to display on the alphanumeric display
 
 /*!
     @brief  Class that provides a driver interface for Quad Alphanumeric

src/components/i2c/drivers/drvOutputBase.h

@@ -50,7 +50,8 @@ class drvOutputBase : public drvBase {
 
   /*!
       @brief    Initializes the I2C output device and begins I2C.
-      @returns  True if initialized successfully, False otherwise.
+      @param    message
+                The message to be displayed.
   */
   virtual void WriteMessage(const char *message) {
     // noop
@@ -105,6 +106,7 @@ class drvOutputBase : public drvBase {
       @brief    Writes a message to the LCD.
       @param    write_char_lcd
                 Pointer to a wippersnapper_i2c_output_CharLCDWrite message.
+      @returns  True if the message was written successfully, False otherwise.
   */
   bool
   WriteMessageCharLCD(wippersnapper_i2c_output_CharLCDWrite *write_char_lcd) {