Updated: Doxygen Documentation

include/sta/bus/i2c/device.hpp

@@ -16,7 +16,9 @@ namespace sta
     public:
         /**
          * @param intf      %I2C hardware interface
-         * @param csPin     The peripheral's address.
+         * @param address   Device address
+         * @param master    Whether the mcu is a master or slave
+         * @param blocking  Whether to use blocking or non-blocking transmits / receives
          */
         I2CDevice(I2C * intf, int address, bool master=true, bool blocking=true);
 

include/sta/bus/i2c/i2c.hpp

@@ -19,6 +19,11 @@ namespace sta
     class I2C : public Interface
     {
     public:
+        /**
+         * @brief Construct a new %I2C object.
+         *
+         * @param mutex		Mutex object for managing shared access. Pass nullptr for no access control.
+         */
         I2C(Mutex * mutex=nullptr);
 
         /**
@@ -31,8 +36,11 @@ namespace sta
         void setSettings(uint16_t address, bool master, bool blocking);
 
     protected:
+    	/// @brief The peripheral's address to communicate with.
     	uint16_t address_;
+        /// @brief Whether the mcu is a master or slave.
         bool master_;
+        /// @brief Whether to use blocking or non-blocking transmits / receives.
         bool blocking_;
     };
 } // namespace sta