alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

mma7660: Adding doxygen comments

Browse Source 
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-04-14 15:01:17 -07:00
parent a6a405be31
commit 5e6fdb5c30
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/mma7660/mma7660.h
View File

@ -33,19 +33,29 @@
namespace upm {
/**
* @brief MMA7660 I2C 3-axis digital accelerometer library
* @defgroup mma7660 libupm-mma7660
* @ingroup generic i2c gpio accelerometer
*/
/**
* @library libupm-mma7660
* @sensor mma7660
* @comname mma7660 I2C 3-axis digital accelerometer
* @type accelerometer
* @man generic
* @con i2c gpio
*
* @brief C++ API for the MMA7660 I2C 3-axis digital accelerometer
*
* UPM module for the MMA7660 I2C 3-axis digital accelerometer.
* This device supports a variety of capabilities, including the
* generation of interrupts for various conditions, tilt and basic
* gesture detection, and of course X/Y/Z measurements of g-forces
* being applied (up to 1.5g).
* being applied (up to 1.5g)
*
* This module was tested with the Grove 3-Axis Digital
* Accelerometer (1.5g)
*
* @ingroup i2c gpio mma7660
* @defgroup mma7660 libupm-mma7660
* @snippet mma7660.cxx Interesting
*/
class MMA7660 {