Add documentation for return types

Author: sebromero

src/I2CDevice.h

@@ -144,6 +144,7 @@ class I2CDevice {
     /**
      * @brief Makes the value of a given register persistent.
      * @param registerInfo The register to make persistent.
+     * @return Whether or not the register value was successfully persisted.
      */
     bool persistRegister(RegisterInfo registerInfo);
 

src/IndoorAirQualitySensor.h

@@ -118,7 +118,7 @@ class IndoorAirQualitySensor : public I2CDevice {
      * @param sensorMode The mode to set. See the IndoorAirQualitySensorMode enum class for possible values.
      * @param persist If true, the change will be saved to flash memory.
      *                When persist is true, the mode setting of OutdoorAirQualitySensor and TemperatureHumiditySensor will also be persisted.
-     * 
+     * @return True if the mode was set successfully, false otherwise.
      */
     bool setMode(IndoorAirQualitySensorMode sensorMode, bool persist);
 
@@ -142,6 +142,7 @@ class IndoorAirQualitySensor : public I2CDevice {
      * @param isEnabled True to enable the sensor, false to disable it.
      * @param persist If true, the change will be saved to flash memory.
      *                When persist is true, the mode setting of IndoorAirQualitySensor and TemperatureHumiditySensor will also be persisted.
+     * @return True if the the sensor was enabled successfully.
      */
     bool setEnabled(bool isEnabled, bool persist = false);
 };

src/NiclaSenseEnv.h

@@ -166,6 +166,7 @@ class NiclaSenseEnv : public I2CDevice {
      * @param baudRate The desired baud rate for the UART communication.
      The supported values are: 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200
      * @param persist Set to true to store the setting in flash, to false otherwise.
+     * @return True if the baud rate was set successfully, false otherwise.
      */
     bool setUARTBaudRate(int baudRate, bool persist);
 
@@ -194,6 +195,7 @@ class NiclaSenseEnv : public I2CDevice {
      * @param enabled True to enable UART CSV output, false to disable.
      * @param persist True to store the setting in flash, false otherwise.
      *                When set to True, it will also persist the value set via `setDebuggingEnabled`.
+     * @return True if the CSV output mode was set successfully, false otherwise.
      */
     bool setUARTCSVOutputEnabled(bool enabled, bool persist = false);
 
@@ -208,6 +210,7 @@ class NiclaSenseEnv : public I2CDevice {
      * @brief Sets the CSV delimiter for parsing CSV data.
      * @param delimiter The character to be used as the CSV delimiter.
      * @param persist If true, the change will be saved to flash memory.
+     * @return True if the delimiter was set successfully, false otherwise.
      */
     bool setCSVDelimiter(char delimiter, bool persist = false);
 
@@ -224,6 +227,7 @@ class NiclaSenseEnv : public I2CDevice {
      * @param enabled A boolean value indicating whether debugging is enabled or not.
      * @param persist If true, the change will be saved to flash memory.
      * When setting this to true the value set via `setUARTCSVOutputEnabled` will also be persisted.
+     * @return True if the debugging mode was set successfully, false otherwise.
      */
     bool setDebuggingEnabled(bool enabled, bool persist = false);
 
@@ -232,6 +236,7 @@ class NiclaSenseEnv : public I2CDevice {
      * 
      * @param address The new I2C address. Valid values are 0 to 127.
      * @param persist If true, the change will be saved to flash memory.
+     * @return True if the address was set successfully, false otherwise.
      */
     bool setDeviceAddress(int address, bool persist = false);
 

src/OrangeLED.h

@@ -35,6 +35,7 @@ class OrangeLED : public I2CDevice {
      * When persist is true, the `errorStatusEnabled` setting will also be persisted.
      * @param brightness : The brightness of the orange LED. Range is 0 to 255.
      * @param persist : If true, the brightness setting will be saved to flash memory.
+     * @return True if the brightness was set successfully, false otherwise.
      */
     bool setBrightness(uint8_t brightness, bool persist = false);
 
@@ -50,6 +51,7 @@ class OrangeLED : public I2CDevice {
      * When persist is true, the brightness setting will also be saved to flash memory.
      * @param enabled : Whether to enable or disable the orange LED error status.
      * @param persist : If true, the change will be saved to flash memory.
+     * @return True if the mode was set successfully, false otherwise.
      */
     bool setErrorStatusEnabled(bool enabled, bool persist = false);
 };

src/OutdoorAirQualitySensor.h

@@ -107,6 +107,7 @@ class OutdoorAirQualitySensor : public I2CDevice {
      * @param sensorMode The mode to set for the sensor.
      * @param persist If true, the change will be saved to flash memory.
      *                When persist is true, the mode setting of IndoorAirQualitySensor and TemperatureHumiditySensor will also be persisted.
+     * @return True if the mode was set successfully, false otherwise.
      */
     bool setMode(OutdoorAirQualitySensorMode sensorMode, bool persist = false);
 
@@ -131,6 +132,7 @@ class OutdoorAirQualitySensor : public I2CDevice {
      * @param isEnabled True to enable the sensor, false to disable it.
      * @param persist If true, the change will be saved to flash memory.
      *                When persist is true, the mode setting of IndoorAirQualitySensor and TemperatureHumiditySensor will also be persisted.
+     * @return True if the enabled state was set successfully, false otherwise.
      */
     bool setEnabled(bool isEnabled, bool persist = false);
 };

src/RGBLED.h

@@ -39,7 +39,7 @@ class RGBLED : public I2CDevice {
      * @param brightness The brightness level of the indicator (0-255).
      * @param persist If true, the change will be saved to flash memory.
      *                When persist is True, the brightness will also be persisted.
-     * 
+     * @return True if the mode was set successfully, false otherwise.
      */
     bool enableIndoorAirQualityStatus(uint8_t brightness = 255, bool persist = false);
 
@@ -53,6 +53,7 @@ class RGBLED : public I2CDevice {
      * @param b The blue value (0-255).
      * @param persist If true, the change will be saved to flash memory.
      *                When persist is True, the brightness will also be persisted.
+     * @return True if the color was set successfully, false otherwise.
      */
     bool setColor(uint8_t r, uint8_t g, uint8_t b, bool persist = false);
 
@@ -64,6 +65,7 @@ class RGBLED : public I2CDevice {
      * @param brightness The brightness value (0-255).
      * @param persist If true, the change will be saved to flash memory.
      *                When persist is True, the brightness will also be persisted.
+     * @return True if the color was set successfully, false otherwise.
      */
     bool setColor(uint8_t r, uint8_t g, uint8_t b, uint8_t brightness, bool persist = false); ;
 
@@ -74,6 +76,7 @@ class RGBLED : public I2CDevice {
      * @param color The RGB color to set.
      * @param persist If true, the change will be saved to flash memory.
      *                When persist is True, the brightness will also be persisted.
+     * @return True if the color was set successfully, false otherwise.
      */
     bool setColor(Color color, bool persist = false);
 
@@ -83,6 +86,7 @@ class RGBLED : public I2CDevice {
      * @param brightness The desired brightness level (0-255).
      * @param persist If true, the change will be saved to flash memory.
      *                When persist is True, the brightness will also be persisted.
+     * @return True if the color was set successfully, false otherwise.
      */
     bool setColor(Color color, uint8_t brightness, bool persist = false);
 
@@ -105,6 +109,7 @@ class RGBLED : public I2CDevice {
      * This function allows you to adjust the brightness of the RGB LED.
      * @param brightness The brightness level to set (0-255).
      * @param persist If true, the change will be saved to flash memory.
+     * @return True if the brightness was set successfully, false otherwise.
      */
     bool setBrightness(uint8_t brightness, bool persist = false);
 };