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

grove.h: Improve docstrings on GroveTemp

Browse Source 
Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Sarah Knepper 2014-12-04 10:59:17 +00:00 committed by Brendan Le Foll
parent 39e6065046
commit c3d5b95576
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/grove/grove.h
View File

@ -66,9 +66,9 @@ class GroveLed: public Grove {
}; };
/** /**
* @brief C++ API for Grove Temperature sensor * @brief C++ API for Grove temperature sensor
* *
* Very basic UPM module for grove temperature sensor on analog * Very basic UPM module for Grove temperature sensor on analog
* *
* @ingroup grove analog * @ingroup grove analog
* @snippet grovetemp.cxx Interesting * @snippet grovetemp.cxx Interesting
@ -78,7 +78,7 @@ class GroveTemp: public Grove {
/** /**
* Grove analog temperature sensor constructor * Grove analog temperature sensor constructor
* *
* @param analog pin to use * @param pin analog pin to use
*/ */
GroveTemp(unsigned int pin); GroveTemp(unsigned int pin);
/** /**
@ -92,9 +92,9 @@ class GroveTemp: public Grove {
*/ */
float raw_value(); float raw_value();
/** /**
* Get the temperature from the sensor * Get the temperature in Celsius from the sensor
* *
* @return the normalised temperature * @return the normalized temperature in Celsius
*/ */
int value(); int value();
private: private: