doxygen:

Author: brentru

src/components/i2c/controller.cpp

@@ -848,7 +848,7 @@ bool I2cController::Handle_I2cDeviceAddOrReplace(pb_istream_t *stream) {
 /***********************************************************************/
 /*!
     @brief    Scans the I2C bus for devices and stores the results.
-    @param    defualt_bus
+    @param    default_bus
                 True to scan the default I2C bus, False to scan the
                 alternative I2C bus.
     @returns  True if the I2C bus was successfully scanned, False

src/components/i2c/controller.h

@@ -71,8 +71,8 @@
   "UNKNOWN_SCAN" ///< Name for I2C devices found by an i2c scan
 
 typedef struct {
-  uint32_t address;
-  bool is_initialized;
+  uint32_t address; ///< I2C address of the device
+  bool is_initialized; ///< Flag to indicate if the device is initialized
 } initialized_device_t; ///< Struct to hold initialized device info
 
 class Wippersnapper_V2; ///< Forward declaration

src/components/i2c/drivers/drvBase.h

@@ -161,8 +161,11 @@ class drvBase {
   /*******************************************************************************/
   /*!
       @brief    Configures an i2c device's sensors.
+      @param    use_default_types
+                Use default sensor types from the driver, rather than
+                the cfg file.
       @param    sensor_types
-                Pointer to an array of SensorType objects.
+                The sensor types to use for the device.
       @param    sensor_types_count
                 The number of active sensors to read from the device.
   */
@@ -754,6 +757,14 @@ class drvBase {
   wippersnapper_sensor_SensorType
       _sensors[15]; ///< Sensors attached to the device.
 
+  /***************************************************************************/
+    /*!
+        @brief    Converts a SensorType to a string.
+        @param    type
+                    The SensorType to convert.
+        @returns  The string representation of the SensorType.
+    */
+  /***************************************************************************/
   const char *SensorTypeToString(wippersnapper_sensor_SensorType type) {
     switch (type) {
     case wippersnapper_sensor_SensorType_SENSOR_TYPE_UNSPECIFIED:
@@ -850,6 +861,6 @@ class drvBase {
   wippersnapper_sensor_SensorType
       _default_sensor_types[15];      ///< Default sensor types
   size_t _default_sensor_types_count; ///< Number of default sensor types
-  const char *_sensor_type_strings[15];
+  const char *_sensor_type_strings[15]; ///< Sensor type strings
 };
 #endif // DRV_BASE_H