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

yg1006: adding doxygen tags

Browse Source 
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek
2015-03-20 15:46:00 -07:00
parent 9f12002d7a
commit 5c16dd44a7
1 changed files with 25 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
src/yg1006/yg1006.h
View File

@@ -27,16 +27,31 @@
#include <mraa/gpio.h> #include <mraa/gpio.h>
namespace upm { namespace upm {
/**
/** * @brief Library for the YG1006 flame sensor
* @brief C++ API for the YG1006 flame sensor *
* * UPM module for the YG1006 flame sensor. It detects flame or any
* UPM module for the YG1006 flame sensor. It detects flame or any * other light in the 760nm - 1100nm wavelength range.
* other light in the 760nm - 1100nm wavelength range. *
* * @defgroup yg1006 libupm-yg1006
* @ingroup gpio * @ingroup seeed gpio light
* @snippet yg1006.cxx Interesting */
*/ /**
* @library yg1006
* @sensor yg1006
* @comname flame sensor
* @type light
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Flame_Sensor
* @con gpio
*
* @brief C++ API for the YG1006 flame sensor
*
* UPM module for the YG1006 flame sensor. It detects flame or any
* other light in the 760nm - 1100nm wavelength range.
*
* @snippet yg1006.cxx Interesting
*/
class YG1006 { class YG1006 {
public: public:
/** /**