clang and doxygen

Author: brentru

src/components/display/assets/icons.h

@@ -1,45 +1,73 @@
+/*!
+ * @file src/components/display/assets/icons.h
+ *
+ * Icon assets for displays.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Brent Rubell 2025 for Adafruit Industries.
+ *
+ * BSD license, all text here must be included in any redistribution.
+ *
+ */
 #ifndef _ICONS_H_
 #define _ICONS_H_
 #include <Arduino.h>
 
-const unsigned char epd_bmp_cloud_online[] PROGMEM = {
-    // 'cloud-thin-full, 16x16px
+/**
+ * @brief cloud-thin-full icon from FontAwesome (16x16px)
+ */
+const unsigned char epd_bmp_cloud_online[] = {
     0x00, 0x00, 0x00, 0x00, 0x07, 0x80, 0x0d, 0xc0, 0x18, 0x78, 0x10,
     0x0c, 0x30, 0x04, 0x70, 0x0c, 0xc0, 0x06, 0xc0, 0x03, 0xc0, 0x03,
     0x40, 0x03, 0x70, 0x06, 0x3f, 0xfc, 0x00, 0x00, 0x00, 0x00};
 
+/**
+ * @brief cloud-xmark-thin-full icon from FontAwesome (16x16px)
+ */
 const unsigned char epd_bmp_cloud_offline[] PROGMEM = {
-    // 'cloud-xmark-thin-full, 16x16px
     0x00, 0x00, 0x00, 0x00, 0x07, 0x80, 0x0d, 0xc0, 0x18, 0x78, 0x10,
     0x0c, 0x30, 0x04, 0x73, 0xcc, 0xe3, 0x86, 0xc3, 0xc3, 0xc3, 0xc3,
     0x40, 0x03, 0x70, 0x06, 0x3f, 0xfc, 0x00, 0x00, 0x00, 0x00};
 
-const unsigned char epd_bmp_wifi_full[] PROGMEM = {
-    // 'wifi-thin-full, 16x16px
+/**
+ * @brief wifi-thin-full icon from FontAwesome (16x16px)
+ */
+const unsigned char epd_bmp_wifi_full[] = {
     0x00, 0x00, 0x00, 0x00, 0x07, 0xe0, 0x3c, 0x3c, 0x70, 0x0e, 0xc0,
     0x03, 0x03, 0xc0, 0x0f, 0xf0, 0x1c, 0x38, 0x18, 0x18, 0x00, 0x00,
     0x03, 0xc0, 0x03, 0xc0, 0x03, 0xc0, 0x00, 0x00, 0x00, 0x00};
 
-const unsigned char epd_bmp_wifi_fair[] PROGMEM = {
-    // 'wifi-fair-thin-full, 16x16px
+/**
+ * @brief wifi-fair-thin-full icon from FontAwesome (16x16px)
+ */
+const unsigned char epd_bmp_wifi_fair[] = {
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x03, 0xc0, 0x0f, 0xf0, 0x1c, 0x38, 0x18, 0x18, 0x00, 0x00,
     0x03, 0xc0, 0x03, 0xc0, 0x03, 0xc0, 0x00, 0x00, 0x00, 0x00};
 
-const unsigned char epd_bmp_wifi_weak[] PROGMEM = {
-    // 'wifi-weak-thin-full, 16x16px
+/**
+ * @brief wifi-weak-thin-full icon from FontAwesome (16x16px)
+ */
+const unsigned char epd_bmp_wifi_weak[] = {
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x03, 0xc0, 0x03, 0xc0, 0x03, 0x80, 0x00, 0x00, 0x00, 0x00};
 
-const unsigned char epd_bmp_wifi_no_signal[] PROGMEM = {
-    // 'wifi-slash-thin-full, 16x16px
+/**
+ * @brief wifi-slash-thin-full icon from FontAwesome (16x16px)
+ */
+const unsigned char epd_bmp_wifi_no_signal[] = {
     0x00, 0x00, 0x40, 0x00, 0x27, 0xc0, 0x1e, 0x38, 0x68, 0x00, 0x44,
     0x03, 0x03, 0x00, 0x01, 0xe0, 0x08, 0x90, 0x00, 0x40, 0x00, 0x20,
     0x01, 0x90, 0x03, 0x88, 0x01, 0x84, 0x00, 0x02, 0x00, 0x00};
 
-const unsigned char epd_bmp_bat_full[] PROGMEM = {
-    // 'battery-full-thin-full, 16x16px
+/**
+ * @brief battery-full-thin-full icon from FontAwesome (16x16px)
+ */
+const unsigned char epd_bmp_bat_full[] = {
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7f, 0xfe, 0xc0, 0x06, 0xff,
     0xfa, 0xf0, 0x0b, 0xf0, 0x0b, 0xf0, 0x0b, 0xf0, 0x0b, 0xff, 0xfa,
     0xc0, 0x06, 0x7f, 0xfe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};

src/components/display/assets/splash.h

@@ -1,9 +1,25 @@
+/*!
+ * @file src/components/display/assets/splash.h
+ *
+ * Splash screen assets for displays.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Brent Rubell 2025 for Adafruit Industries.
+ *
+ * BSD license, all text here must be included in any redistribution.
+ *
+ */
 #ifndef _SPLASH_H_
 #define _SPLASH_H_
 #include <Arduino.h>
 
-const unsigned char tft_bmp_logo_240135[] PROGMEM = {
-    // 'adafruit_wippersnapper_logo, 240x135px
+/**
+ * @brief Wippersnapper logo, 296x128px
+ */
+const unsigned char tft_bmp_logo_240135[] = {
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
@@ -343,9 +359,10 @@ const unsigned char tft_bmp_logo_240135[] PROGMEM = {
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
 
-// 'adafruit_wippersnapper_logo', 240x240px
+/**
+ * @brief Wippersnapper logo, 240x240px
+ */
 const unsigned char tft_bmp_logo_240240[] PROGMEM = {
-    // 'adafruit_wippersnapper_logo, 240x240px
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,

src/components/display/drivers/dispDrvSt7789.h

@@ -120,6 +120,8 @@ class dispDrvSt7789 : public dispDrvBase {
 
   /*!
       @brief  Draws a status bar at the top of the display.
+        @param  io_username
+                The Adafruit IO username to display on the status bar.
   */
   virtual void drawStatusBar(const char *io_username) override {
     if (!_display)

src/components/display/drivers/dispDrvThinkInkGrayscale4Eaamfgn.h

@@ -96,6 +96,8 @@ class drvDispThinkInkGrayscale4Eaamfgn : public dispDrvBase {
 
   /*!
       @brief  Draws a status bar at the top of the display.
+        @param  io_username
+                The Adafruit IO username to display on the status bar.
   */
   virtual void drawStatusBar(const char *io_username) override {
     if (!_display)

src/components/display/hardware.cpp

@@ -152,7 +152,7 @@ wippersnapper_display_v1_DisplayType DisplayHardware::getType() {
 }
 
 /*!
-    @brief  Parses a pin string (e.g., "D5") and returns the corresponding pin
+@brief  Parses a pin string (e.g., "D5") and returns the corresponding pin
    number.
     @param  pinStr
             The pin string to parse.
@@ -250,18 +250,36 @@ bool DisplayHardware::beginEPD(
   return true;
 }
 
+/*!
+    @brief  Displays the splash screen on the display.
+*/
 void DisplayHardware::showSplash() {
   if (!_drvDisp)
     return;
   _drvDisp->showSplash();
 }
 
+/*!
+    @brief  Draws a status bar at the top of the display.
+    @param  io_username
+            The Adafruit IO username to display on the status bar.
+*/
 void DisplayHardware::drawStatusBar(const char *io_username) {
   if (!_drvDisp)
     return;
   _drvDisp->drawStatusBar(io_username);
 }
 
+/*!
+    @brief  Updates the status bar with the latest RSSI, battery, and MQTT
+   connection status.
+    @param  rssi
+            The current WiFi RSSI value.
+    @param  bat
+            The current battery percentage (0-100).
+    @param  mqtt_connected
+            True if connected to MQTT, False otherwise.
+*/
 void DisplayHardware::updateStatusBar(int8_t rssi, uint8_t bat,
                                       bool mqtt_connected) {
   if (!_drvDisp)