alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-01 17:31:13 +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

15
src/hmc5883l/hmc5883l.h
View File

@ -31,12 +31,20 @@
namespace upm {
/**
* @brief HMC5883l magnometer library
* @brief Hmc5883l magnometer library
* @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]
* (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,
* typically a 3V supply is all that is needed to power the sensor.
*
* @ingroup hmc5883l i2c
* @snippet hmc5883l.cxx Interesting
* @image html hmc5883l.jpeg
* @snippet hmc5883l.cxx Interesting
*/
class Hmc5883l {
public: