Complete comments for doxygen

Author: Bolukan

Adafruit_PWMServoDriver.cpp

@@ -200,7 +200,7 @@ void Adafruit_PWMServoDriver::setOutputMode(bool totempole) {
 
 /*!
  *  @brief  Reads set Prescale from PCA9685
- *  @param  void
+ *  @return prescale value
  */
 uint8_t Adafruit_PWMServoDriver::readPrescale(void)
 {

Adafruit_PWMServoDriver.h

@@ -28,10 +28,10 @@
 // REGISTER ADDRESSES
 #define PCA9685_MODE1        0x00 /**< Mode Register 1 */
 #define PCA9685_MODE2        0x01 /**< Mode Register 2 */
-#define PCA9685_SUBADR1      0x02 /**< i2c bus address 1 */
-#define PCA9685_SUBADR2      0x03 /**< i2c bus address 2 */
-#define PCA9685_SUBADR3      0x04 /**< i2c bus address 3 */
-#define PCA9685_ALLCALLADR   0x05
+#define PCA9685_SUBADR1      0x02 /**< I2C-bus subaddress 1 */
+#define PCA9685_SUBADR2      0x03 /**< I2C-bus subaddress 2 */
+#define PCA9685_SUBADR3      0x04 /**< I2C-bus subaddress 3 */
+#define PCA9685_ALLCALLADR   0x05 /**< LED All Call I2C-bus address */
 #define PCA9685_LED0_ON_L    0x06 /**< LED0 output and brightness control byte 0 */
 #define PCA9685_LED0_ON_H    0x07 /**< LED0 output and brightness control byte 1 */
 #define PCA9685_LED0_OFF_L   0x08 /**< LED0 output and brightness control byte 2 */
@@ -42,33 +42,32 @@
 #define PCA9685_ALLLED_OFF_L 0xFC /**< load all the LEDn_OFF registers, byte 0 */
 #define PCA9685_ALLLED_OFF_H 0xFD /**< load all the LEDn_OFF registers, byte 1 */
 #define PCA9685_PRESCALE     0xFE /**< Prescaler for PWM output frequency */
-#define PCA9685_TESTMODE     0xFF
+#define PCA9685_TESTMODE     0xFF /**< defines the test mode to be entered */
 
 // MODE1 bits
-#define MODE1_ALLCAL         0x01
-#define MODE1_SUB3           0x02
-#define MODE1_SUB2           0x04
-#define MODE1_SUB1           0x08
-#define MODE1_SLEEP          0x10
-#define MODE1_AI             0x20
-#define MODE1_EXTCLK         0x40
-#define MODE1_RESTART        0x80
+#define MODE1_ALLCAL         0x01 /**< respond to LED All Call I2C-bus address */
+#define MODE1_SUB3           0x02 /**< respond to I2C-bus subaddress 3 */
+#define MODE1_SUB2           0x04 /**< respond to I2C-bus subaddress 2 */
+#define MODE1_SUB1           0x08 /**< respond to I2C-bus subaddress 1 */
+#define MODE1_SLEEP          0x10 /**< Low power mode. Oscillator off */
+#define MODE1_AI             0x20 /**< Auto-Increment enabled */
+#define MODE1_EXTCLK         0x40 /**< Use EXTCLK pin clock */
+#define MODE1_RESTART        0x80 /**< Restart enabled */
 // MODE2 bits
-#define MODE2_OUTNE_0        0x01
-#define MODE2_OUTNE_1        0x02
-#define MODE2_OUTDRV         0x04
-#define MODE2_OCH            0x08
-#define MODE2_INVRT          0x10
+#define MODE2_OUTNE_0        0x01 /**< Active LOW output enable input */
+#define MODE2_OUTNE_1        0x02 /**< Active LOW output enable input - high impedience */
+#define MODE2_OUTDRV         0x04 /**< totem pole structure vs open-drain */
+#define MODE2_OCH            0x08 /**< Outputs change on ACK vs STOP */
+#define MODE2_INVRT          0x10 /**< Output logic state inverted */
 
-// Default PCA9685 I2C Slave Address if A0-A5 are not set
-#define PCA9685_I2C_ADDRESS  0x40
+#define PCA9685_I2C_ADDRESS  0x40 /**< Default PCA9685 I2C Slave Address */
 
-#define FREQUENCY_OSCILLATOR 25000000
-#define FREQUENCY_CALIBRATED 26075000 // measured 104.3% compared to official 25 MHz
-#define FREQUENCY_LEGACY     27777778 // Effect of freq /= 0,9
+#define FREQUENCY_OSCILLATOR 25000000 /**< Oscillator frequency cf satasheet */
+#define FREQUENCY_CALIBRATED 26075000 /**< Oscillator frequency measured at 104.3% */
+#define FREQUENCY_LEGACY     27777778 /**< Oscillator frequency using freq /= 0,9 */
 
-#define PCA9685_PRESCALE_MIN 3
-#define PCA9685_PRESCALE_MAX 255
+#define PCA9685_PRESCALE_MIN 3 /**< minimum prescale value */
+#define PCA9685_PRESCALE_MAX 255 /**< maximum prescale value */
 
 /*! 
  *  @brief  Class that stores state and functions for interacting with PCA9685 PWM chip