docs: updated headers for a few sensors as example

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-03-11 17:10:22 -07:00
parent 10d1975bc2
commit 8f969d42f4
4 changed files with 43 additions and 11 deletions

View File

@ -35,14 +35,25 @@
namespace upm { namespace upm {
/** /**
* @brief C++ API for the ADXL335 3-axis analog acclerometer * @brief ADXL335 accelerometer library
* @defgroup adxl335 libupm-adxl335
* @ingroup seeed analog accelerometer
*/
/**
* @library adxl335
* @sensor adxl335
* @comname ADXL335 3-Axis Analog Accelerometer
* @type accelerometer
* @man seeed
* @con analog
*
* @brief C++ API for the ADXL335 3-axis Analog Accelerometer
* *
* UPM module for the ADXL335 3-axis analog accelerometer. This * UPM module for the ADXL335 3-axis analog accelerometer. This
* was tested on a Grove 3-axis Analog Accelerometer. It uses 3 * was tested on a Grove 3-axis Analog Accelerometer. It uses 3
* analog pins, one each for X, Y, and Z axis. * analog pins, one each for X, Y, and Z axis.
* *
* @ingroup grove analog
* @defgroup adxl335 libupm-adxl335
* @snippet adxl335.cxx Interesting * @snippet adxl335.cxx Interesting
*/ */
class ADXL335 { class ADXL335 {

View File

@ -32,9 +32,17 @@ namespace upm {
/** /**
* @brief Adxl345 accelerometer library * @brief Adxl345 accelerometer library
* @defgroup adxl345 libupm-adxl345 * @defgroup adxl345 libupm-adxl345
* @ingroup seeed i2c accelerometer
*/ */
/** /**
* @library adxl345
* @sensor adxl345
* @comname Adxl345 3-Axis Digital Accelerometer
* @type accelerometer
* @man seeed
* @con i2c
*
* @brief C++ API for Adxl345 (3-axis digital accelerometer) * @brief C++ API for Adxl345 (3-axis digital accelerometer)
* *
* The Adxl345 is a 3-axis digital accelerometer. * The Adxl345 is a 3-axis digital accelerometer.
@ -43,9 +51,8 @@ namespace upm {
* Note that the sensor it is incompatible and will not be detected on the I2C bus * Note that the sensor it is incompatible and will not be detected on the I2C bus
* by the Intel Edison using the Arduino breakout board at 5V (3V3 will work fine). * by the Intel Edison using the Arduino breakout board at 5V (3V3 will work fine).
* *
* @ingroup adxl345 i2c
* @snippet adxl345.cxx Interesting
* @image html adxl345.jpeg * @image html adxl345.jpeg
* @snippet adxl345.cxx Interesting
*/ */
class Adxl345 { class Adxl345 {
public: public:

View File

@ -31,12 +31,20 @@
namespace upm { namespace upm {
/** /**
* @brief HMC5883l magnometer library * @brief Hmc5883l magnometer library
* @defgroup hmc5883l libupm-hmc5883l * @defgroup hmc5883l libupm-hmc5883l
* @ingroup seeed i2c compass
*/ */
/** /**
* @brief C++ API for HMC5883l (3-axis digital compass) * @library hmc5883l
* @sensor hmc5883l
* @comname Hmc5883l 3-Axis Digital Compass
* @type compass
* @man seeed
* @con i2c
*
* @brief C++ API for Hmc5883l (3-axis digital compass)
* *
* The Honeywell [HMC5883L] * The Honeywell [HMC5883L]
* (http://www.adafruit.com/datasheets/HMC5883L_3-Axis_Digital_Compass_IC.pdf) * (http://www.adafruit.com/datasheets/HMC5883L_3-Axis_Digital_Compass_IC.pdf)
@ -44,9 +52,8 @@ namespace upm {
* all done through an I2C interface. Different breakout boards are available, * all done through an I2C interface. Different breakout boards are available,
* typically a 3V supply is all that is needed to power the sensor. * typically a 3V supply is all that is needed to power the sensor.
* *
* @ingroup hmc5883l i2c
* @snippet hmc5883l.cxx Interesting
* @image html hmc5883l.jpeg * @image html hmc5883l.jpeg
* @snippet hmc5883l.cxx Interesting
*/ */
class Hmc5883l { class Hmc5883l {
public: public:

View File

@ -32,9 +32,17 @@ namespace upm {
/** /**
* @brief Itg3200 gyroscope library * @brief Itg3200 gyroscope library
* @defgroup itg3200 libupm-itg3200 * @defgroup itg3200 libupm-itg3200
* @ingroup seeed i2c compass
*/ */
/** /**
* @library itg3200
* @sensor itg3200
* @comname Itg3200 3-Axis Digital Gyroscope
* @type compass
* @man seeed
* @con i2c
*
* @brief C++ API for Itg3200 (3-axis digital gyroscope) * @brief C++ API for Itg3200 (3-axis digital gyroscope)
* *
* The InvenSense Itg3200 is a 3-axis digital gyroscope. * The InvenSense Itg3200 is a 3-axis digital gyroscope.
@ -43,9 +51,8 @@ namespace upm {
* <strong>However</strong>, it is incompatible and will not be detected on the I2C bus * <strong>However</strong>, it is incompatible and will not be detected on the I2C bus
* by the Intel Edison using the Arduino breakout board. * by the Intel Edison using the Arduino breakout board.
* *
* @ingroup itg3200 i2c
* @snippet itg3200.cxx Interesting
* @image html itg3200.jpeg * @image html itg3200.jpeg
* @snippet itg3200.cxx Interesting
*/ */
class Itg3200 { class Itg3200 {
public: public: