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

pulsensor: Adding doxygen comments and image from adafruit website

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 12:22:06 -07:00
parent 3707e359f4
commit 28e5f1ca6e
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/images/pulsensor.jpg Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 219 KiB

16
src/pulsensor/pulsensor.h
View File

@ -39,24 +39,30 @@
#define TRUE HIGH #define TRUE HIGH
#define FALSE LOW #define FALSE LOW
/** /**
* @brief pulsensor pulse sensor library * @brief pulsensor pulse sensor library
* @defgroup pulsensor libupm-pulsensor * @defgroup pulsensor libupm-pulsensor
* @ingroup seeed analog medical
*/ */
/** /**
* @library libupm-pulsensor
* @sensor pulsensor
* @comname Pulse Sensor
* @type medical
* @man seeed
* @web http://www.adafruit.com/products/1093
* @con analog
*
* @brief C++ API for 3-wire pulse sensor * @brief C++ API for 3-wire pulse sensor
* *
* This is a library for the 3-wire pulse sensor sold by several manufacturers. * This is a library for the 3-wire pulse sensor sold by several manufacturers.
* Usually, you can identify the sensor based on the round breakout and the * Usually, you can identify the sensor based on the round breakout and the
* distinctive heart symbol. * distinctive heart symbol.
* *
* @ingroup pulsensor analog * @image html pulsensor.jpg
* @snippet pulsensor.cxx Interesting * @snippet pulsensor.cxx Interesting
*/ */
/*! /*!
* @struct clbk_data * @struct clbk_data
* @brief callback data * @brief callback data