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

docs: final batch of header files reviewed

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-10 18:53:31 +03:00
committed by Mihai Tudor Panu
parent 04edb9be04
commit 1fe9b9eb1d
53 changed files with 1182 additions and 1191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/yg1006/yg1006.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief YG1006 flame sensor library
* @brief YG1006 Flame Sensor library
* @defgroup yg1006 libupm-yg1006
* @ingroup seeed gpio light hak
*/
@ -43,10 +43,10 @@ namespace upm {
* @con gpio
* @kit hak
*
* @brief API for the YG1006 flame sensor
* @brief 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.
* UPM module for the YG1006 flame sensor. It detects a flame or any
* other light source in the 760-1,100 nm wavelength range.
*
* @image html yg1006.jpg
* @snippet yg1006.cxx Interesting
@ -54,19 +54,19 @@ namespace upm {
class YG1006 {
public:
/**
* YG1006 digital flame sensor constructor
* YG1006 constructor
*
* @param pin digital pin to use
* @param pin Digital pin to use
*/
YG1006(int pin);
/**
* YG1006 Destructor
* YG1006 destructor
*/
~YG1006();
/**
* Determine whether a flame has been detected
* Determines whether a flame has been detected
*
* @return True if a flame or other comparable light source is detected
* @return True if a flame or another comparable light source has been detected
*/
bool flameDetected();