style: Fix indent and add functions definitions (brief)

Author: jgauchia

lib/battery/battery.cpp

@@ -6,78 +6,82 @@
  * @date 2025-06
  */
 
-
 #include "battery.hpp"
 
 /**
- * @brief Battery Class constructor
- *
+ * @brief Constructs a Battery monitoring object for voltage measurement and percentage calculation.
  */
 Battery::Battery() {}
 
 /**
- * @brief Configure ADC Channel for battery reading
+ * @brief Initializes the ADC channel(s) required for battery voltage measurement.
  *
+ * Configures the hardware ADC based on the ESP32 chip (ADC1 or ADC2).
  */
 void Battery::initADC()
 {
 #ifdef ADC1
-  adc1_config_width(ADC_WIDTH_BIT_12);
-  adc1_config_channel_atten(BATT_PIN, ADC_ATTEN_DB_12);
+    adc1_config_width(ADC_WIDTH_BIT_12);
+    adc1_config_channel_atten(BATT_PIN, ADC_ATTEN_DB_12);
 #endif
 
 #ifdef ADC2
-  adc2_config_channel_atten(BATT_PIN, ADC_ATTEN_DB_12);
+    adc2_config_channel_atten(BATT_PIN, ADC_ATTEN_DB_12);
 #endif
 }
 
 /**
- * @brief Set battery voltage levels
+ * @brief Sets the maximum and minimum voltage levels for battery charge calculation.
  *
- * @param maxVoltage -> Full Charge voltage
- * @param minVoltage -> Min Charge voltage
+ * @param maxVoltage Voltage considered as fully charged.
+ * @param minVoltage Voltage considered as minimum safe level.
  */
 void Battery::setBatteryLevels(float maxVoltage, float minVoltage)
 {
-  batteryMax = maxVoltage;
-  batteryMin = minVoltage;
+    batteryMax = maxVoltage;
+    batteryMin = minVoltage;
 }
 
 /**
- * @brief Read battery charge and return %.
+ * @brief Reads and computes the current battery charge as a percentage.
+ *
+ * Takes 100 ADC samples, averages them, compensates for the voltage divider, and calculates the charge percentage.
+ * Returns a value between 0 and 100 (values above 160 are treated as 0).
  *
- * @return float -> % Charge
+ * @return float Percentage of battery charge (0–100% typically).
  */
 float Battery::readBattery() 
 {
-  long sum = 0;        // Sum of samples taken
-  float voltage = 0.0; // Calculated voltage
-  float output = 0.0;  // Output value
 
-  for (int i = 0; i < 100; i++)
-  {
-    #ifdef ADC1
-      sum += static_cast<long>(adc1_get_raw(BATT_PIN));
-    #endif
+    long sum = 0;        /**< Sum of samples taken. */
+    float voltage = 0.0; /**< Calculated voltage. */
+    float output = 0.0;  /**< Output value. */
+
+
+    for (int i = 0; i < 100; i++)
+    {
+        #ifdef ADC1
+            sum += static_cast<long>(adc1_get_raw(BATT_PIN));
+        #endif
 
-    #ifdef ADC2
-      int readRaw;
-      esp_err_t r = adc2_get_raw(BATT_PIN, ADC_WIDTH_BIT_12, &readRaw);
-      if (r == ESP_OK)
-        sum += static_cast<long>(readRaw);
-    #endif
+        #ifdef ADC2
+            int readRaw;
+            esp_err_t r = adc2_get_raw(BATT_PIN, ADC_WIDTH_BIT_12, &readRaw);
+            if (r == ESP_OK)
+                sum += static_cast<long>(readRaw);
+        #endif
 
-    delayMicroseconds(150);
-  }
+        delayMicroseconds(150);
+    }
 
-  voltage = sum / 100.0;
-  // Custom board has a divider circuit
-  constexpr float R1 = 100000.0; // Resistance of R1 (100K)
-  constexpr float R2 = 100000.0; // Resistance of R2 (100K)
-  voltage = (voltage * V_REF) / 4096.0;
-  voltage = voltage / (R2 / (R1 + R2));
-  voltage = roundf(voltage * 100) / 100;
+    voltage = sum / 100.0;
+    /**< Custom board has a divider circuit */
+    constexpr float R1 = 100000.0; /**< Resistance of R1 (100K) */
+    constexpr float R2 = 100000.0; /**< Resistance of R2 (100K) */
+    voltage = (voltage * V_REF) / 4096.0;
+    voltage = voltage / (R2 / (R1 + R2));
+    voltage = roundf(voltage * 100) / 100;
 
-  output = ((voltage - batteryMin) / (batteryMax - batteryMin)) * 100;
-  return (output <= 160) ? output : 0.0f;
+    output = ((voltage - batteryMin) / (batteryMax - batteryMin)) * 100;
+    return (output <= 160) ? output : 0.0f;
 }

lib/battery/battery.hpp

@@ -12,17 +12,24 @@
 #include <driver/adc.h>
 #include <esp_adc_cal.h>
 
+
+/**
+ * @class Battery
+ * @brief Provides battery voltage monitoring and charge estimation.
+ *
+ * Handles ADC initialization, voltage range configuration, and computes battery charge percentage.
+ */
 class Battery
 {
 private:
-  float batteryMax;
-  float batteryMin;
-  static constexpr float V_REF = 3.9; // ADC reference voltage
+	float batteryMax; 					/**< Maximum (full charge) voltage. */
+	float batteryMin;					/**< Minimum (empty) voltage. */
+	static constexpr float V_REF = 3.9; /**< ADC reference voltage. */
 
 public:
-  Battery();
+  	Battery();
 
-  void initADC();
-  void setBatteryLevels(float maxVoltage, float minVoltage);
-  float readBattery();
+	void initADC();
+	void setBatteryLevels(float maxVoltage, float minVoltage);
+	float readBattery();
 };

lib/bme/bme.cpp

@@ -12,16 +12,13 @@
 
 Adafruit_BME280 bme = Adafruit_BME280();
 
-/**
- * @brief Temperature reading values
- *
- */
-uint8_t tempValue = 0;
-uint8_t tempOld = 0;
+uint8_t tempValue = 0; /**< Stores the current temperature value from the BME280 sensor. */
+uint8_t tempOld = 0; /**< Stores the previous temperature value for comparison. */
 
 /**
- * @brief Init BME sensor
+ * @brief Initializes the BME280 sensor and sets up I2C communication.
  *
+ * Optionally allows advanced configuration for oversampling and filtering.
  */
 void initBME()
 {

lib/bme/bme.hpp

@@ -15,15 +15,10 @@
 #include <Adafruit_Sensor.h>
 #include <Adafruit_BME280.h>
 
-/**
- * @brief BME280 Address
- *
- */
-#define BME_ADDRESS 0x76
-
-extern Adafruit_BME280 bme;
-extern uint8_t tempValue;
-extern uint8_t tempOld;
+#define BME_ADDRESS 0x76          /**< I2C address for the BME280 sensor (default: 0x76). */
+extern Adafruit_BME280 bme;       /**< Global instance of the BME280 sensor driver. */
+extern uint8_t tempValue;         /**< Stores the latest temperature reading from the BME280 sensor. */
+extern uint8_t tempOld;           /**< Stores the previous temperature value to detect changes. */
 
 void initBME();