docs: update

Author: leonardocavagnis

Diff for: src/AnalogInClass.cpp

@@ -140,5 +140,4 @@ uint16_t AnalogInClass::read(int channel) {
 }
 
 AnalogInClass MachineControl_AnalogIn;
-
 /**** END OF FILE ****/

Diff for: src/AnalogInClass.h

@@ -6,6 +6,7 @@
  * This library allows to set the resistor configuration for the type of connected analog sensor (0-10V, 4-20mA or NTC)
  * and to capture the analog values acquired by the ANALOG IN channels.
  */
+
 #ifndef __ANALOGIN_CLASS_H
 #define __ANALOGIN_CLASS_H
 
@@ -36,6 +37,12 @@ class AnalogInClass {
          * @param ai2_pin The analog pin number of the channel 2
          */
         AnalogInClass(PinName ai0_pin = PC_3C, PinName ai1_pin = PC_2C, PinName ai2_pin = PA_1C);
+        
+        /**
+         * @brief Destruct the AnalogInClass object.
+         *
+         * This destructor releases any resources used by the AnalogInClass object.
+         */
         ~AnalogInClass();
 
         /**
@@ -56,9 +63,9 @@ class AnalogInClass {
         uint16_t read(int channel);
 
     private:
-        PinName _ai0;
-        PinName _ai1;
-        PinName _ai2;
+        PinName _ai0;   // Analog input pin for channel 0
+        PinName _ai1;   // Analog input pin for channel 1
+        PinName _ai2;   // Analog input pin for channel 2
 };
 
 extern AnalogInClass MachineControl_AnalogIn;

Diff for: src/AnalogOutClass.cpp

@@ -70,5 +70,4 @@ void AnalogOutClass::write(int channel, float voltage) {
 }
 
 AnalogOutClass MachineControl_AnalogOut;
-
 /**** END OF FILE ****/

Diff for: src/AnalogOutClass.h

@@ -5,6 +5,7 @@
  *
  * This library allows to configure the analog channels as PWM, to set frequency and value.
  */
+
 #ifndef __ANALOGOUT_CLASS_H
 #define __ANALOGOUT_CLASS_H
 
@@ -29,6 +30,12 @@ class AnalogOutClass {
          * @param ao3_pin The analog pin number of the channel 2
          */
         AnalogOutClass(PinName ao0_pin = PJ_11, PinName ao1_pin = PK_1, PinName ao2_pin = PG_7, PinName ao3_pin = PC_7);
+        
+        /**
+         * @brief Destruct the AnalogOutClass object.
+         *
+         * This destructor releases any resources used by the AnalogOutClass object.
+         */
         ~AnalogOutClass();
 
         /**
@@ -55,10 +62,10 @@ class AnalogOutClass {
         void write(int channel, float voltage);
 
     private:
-        mbed::PwmOut _ao0;
-        mbed::PwmOut _ao1;
-        mbed::PwmOut _ao2;
-        mbed::PwmOut _ao3;
+        mbed::PwmOut _ao0;   // PWM output for Analog Out channel 0
+        mbed::PwmOut _ao1;   // PWM output for Analog Out channel 1
+        mbed::PwmOut _ao2;   // PWM output for Analog Out channel 2
+        mbed::PwmOut _ao3;   // PWM output for Analog Out channel 3
 };
 
 extern AnalogOutClass MachineControl_AnalogOut;

Diff for: src/DigitalOutputsClass.h

@@ -5,6 +5,7 @@
  *
  * This library allows to interface with the IO Expander and set the digital outputs.
  */
+
 #ifndef __DIGITALOUTPUTS_CLASS_H
 #define __DIGITALOUTPUTS_CLASS_H
 
@@ -44,6 +45,12 @@ class DigitalOutputsClass {
                             PinName do6_pin = PD_3,
                             PinName do7_pin = PA_14,
                             PinName latch_pin = PB_2);
+
+        /**
+         * @brief Destruct the DigitalOutputsClass object.
+         *
+         * This destructor releases any resources used by the DigitalOutputsClass object.
+         */               
         ~DigitalOutputsClass();
 
         /**
@@ -71,16 +78,17 @@ class DigitalOutputsClass {
          * - To set all channels to LOW: val_mask = 0 (0b00000000)
          */
         void writeAll(uint8_t val_mask);
-private:
-        PinName _do0;
-        PinName _do1;
-        PinName _do2;
-        PinName _do3;
-        PinName _do4;
-        PinName _do5;
-        PinName _do6;
-        PinName _do7;
-        PinName _latch;
+        
+    private:
+        PinName _do0;      // Digital output pin for DO (Digital Out) channel 0
+        PinName _do1;      // Digital output pin for DO (Digital Out) channel 1
+        PinName _do2;      // Digital output pin for DO (Digital Out) channel 2
+        PinName _do3;      // Digital output pin for DO (Digital Out) channel 3
+        PinName _do4;      // Digital output pin for DO (Digital Out) channel 4
+        PinName _do5;      // Digital output pin for DO (Digital Out) channel 5
+        PinName _do6;      // Digital output pin for DO (Digital Out) channel 6
+        PinName _do7;      // Digital output pin for DO (Digital Out) channel 7
+        PinName _latch;    // Latch control pin
 
         /**
          * @brief Configures the thermal shutdown of the high-side switches (TPS4H160) to operate in latch mode. 

Diff for: src/ProgrammableDINClass.h

@@ -23,21 +23,29 @@
  * This class extends the ArduinoIOExpanderClass to interface with the IO Expander and provides methods to configure digital inputs.
  */
 class ProgrammableDINClass : public ArduinoIOExpanderClass {
-public:
-    /**
-     * @brief Construct a ProgrammableDINClass object.
-     */
-    ProgrammableDINClass();
-	~ProgrammableDINClass();
-
-    /**
-     * @brief Initialize the ProgrammableDIN module.
-     *
-     * Test connection with the IOExpander and set all the pins to the default mode.
-     *
-     * @return true If the ProgrammableDIN module is successfully initialized, false otherwise.
-     */
-    bool begin();
+    public:
+        /**
+         * @brief Construct a ProgrammableDINClass object.
+         *
+         * This constructor initializes a ProgrammableDINClass object.
+         */
+        ProgrammableDINClass();
+
+        /**
+         * @brief Destruct the ProgrammableDINClass object.
+         *
+         * This destructor releases any resources used by the ProgrammableDINClass object.
+         */
+	    ~ProgrammableDINClass();
+
+        /**
+         * @brief Initialize the ProgrammableDIN module.
+         *
+         * Test connection with the IOExpander and set all the pins to the default mode.
+         *
+         * @return true If the ProgrammableDIN module is successfully initialized, false otherwise.
+         */
+        bool begin();
 };
 
 extern ProgrammableDINClass MachineControl_DigitalInputs;

Diff for: src/ProgrammableDIOClass.h

@@ -32,6 +32,12 @@ class ProgrammableDIOClass : public ArduinoIOExpanderClass {
      * @param latch_pin The pin number for the latch mode control.
      */
     ProgrammableDIOClass(PinName latch_pin = PH_14);
+
+    /**
+     * @brief Destruct the ProgrammableDIOClass object.
+     *
+     * This destructor releases any resources used by the ProgrammableDIOClass object.
+     */
     ~ProgrammableDIOClass();
 
     /**
@@ -43,7 +49,7 @@ class ProgrammableDIOClass : public ArduinoIOExpanderClass {
     bool begin(bool latch_mode = true);
 
 private:
-    PinName _latch;
+    PinName _latch; // Latch control pin
 
     /**
      * @brief Configures the thermal shutdown of the high-side switches (TPS4H160) to operate in latch mode.

Diff for: src/TempProbesClass.h

@@ -43,6 +43,12 @@ class TempProbesClass {
      * @param rtd_th_pin The pin number for the RTD connection.
      */
     TempProbesClass(PinName ch_sel0_pin = PD_6, PinName ch_sel1_pin = PI_4, PinName ch_sel2_pin = PG_10, PinName rtd_th_pin = PC_15);
+   
+    /**
+     * @brief Destruct the TempProbesClass object.
+     *
+     * This destructor releases any resources used by the TempProbesClass object.
+     */
     ~TempProbesClass();
 
     /**