alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-01 01:11:10 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: updated headers for a few sensors as example

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

11
src/adxl345/adxl345.h
View File

@ -32,9 +32,17 @@ namespace upm {
/**
* @brief Adxl345 accelerometer library
* @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)
*
* 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
* 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
* @snippet adxl345.cxx Interesting
*/
class Adxl345 {
public: