diff --git a/examples/CheckDistance/CheckDistance.ino b/examples/CheckDistance/CheckDistance.ino index 551b2ca..9d2f6a4 100644 --- a/examples/CheckDistance/CheckDistance.ino +++ b/examples/CheckDistance/CheckDistance.ino @@ -1,7 +1,5 @@ /*! @file CheckDistance.ino - @mainpage Example program for the VCNL4010 Library - @section CheckDistance Description Example program for using the VCNL4010 library which allows the Arduino to use the VCNL4010 Fully Integrated diff --git a/src/VCNL4010.cpp b/src/VCNL4010.cpp index be08531..b426da7 100644 --- a/src/VCNL4010.cpp +++ b/src/VCNL4010.cpp @@ -46,7 +46,6 @@ bool VCNL4010::begin(const uint8_t deviceAddress, const uint32_t i2CSpeed) /*! * @brief Starts the I2C communications with the VCNL4010 (overloaded) * @details Uses the default address specified in VCNL4010_ADDRESS if one is not given and standard I2C Speed -* @param[in] deviceAddress I2C device address */ bool VCNL4010::begin(void) { @@ -138,8 +137,7 @@ void VCNL4010::writeByte(const uint8_t addr, const uint8_t data) * 110 | 125 * 111 | 250 * These roughly equate to Hz (2,4,8,16,32,64,128 and 256) -* @param[in] addr Address of the I2C device -* @param[in] data Single byte to write +* @param[in] Hz Herz code value, described in details */ void VCNL4010::setProximityHz(const uint8_t Hz) { diff --git a/src/VCNL4010.h b/src/VCNL4010.h index 27c7c70..a939518 100644 --- a/src/VCNL4010.h +++ b/src/VCNL4010.h @@ -54,12 +54,13 @@ Version| Date | Developer | Comments #include "Arduino.h" // Arduino data type definitions #include // Standard I2C "Wire" library #ifndef VCNL4010_h // Guard code definition + /*! @brief Guard code definition for the VCNL4010 Library */ #define VCNL4010_h // Define the name inside guard code /******************************************** ** Declare all constants used in the class ** ********************************************/ #ifndef I2C_MODES // I2C related constants - /** @brief Guard code definition */ + /*! @brief Guard code definition for the various I2C modes */ #define I2C_MODES // Guard code to prevent multiple declarations const uint32_t I2C_STANDARD_MODE = 100000; ///< Default normal I2C 100KHz speed const uint32_t I2C_FAST_MODE = 400000; ///< Fast mode