alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +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

22
src/th02/th02.h
View File

@ -45,7 +45,7 @@
namespace upm {
/**
* @brief TH02 temperature & humidity sensor library
* @brief TH02 Temperature & Humidity Sensor library
* @defgroup th02 libupm-th02
* @ingroup seeed i2c temp
*/
@ -53,18 +53,18 @@ namespace upm {
* @library th02
* @sensor th02
* @comname TH02 Temperature & Humidity Sensor
* @altname Grove Temperature & Humidity Sensor (High Accuracy & Mini)
* @altname Grove Temperature & Humidity Sensor (High-Accuracy & Mini)
* @type temp
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Tempture%26Humidity_Sensor_(High-Accuracy_%26Mini)_v1.0
* @con i2c
*
* @brief API for th02 temperature & humidity sensor library
* @brief API for the TH02 Temperature & Humidity Sensor
*
* This file defines the TH02 interface for libth02
*
* NOTE: For use on the Edison with the Arduino breakout board, the
* Edison must be set to 3v rather than 5v.
* Note: For use on Intel(R) Edison with an Arduino* breakout board, Intel
* Edison must be set to 3 V rather than 5 V.
*
* @image html th02.jpg
* @snippet th02.cxx Interesting
@ -72,32 +72,32 @@ namespace upm {
class TH02 {
public:
/**
* Instanciates a TH02 object
* Instantiates a TH02 object
*/
TH02 (int bus=0, uint8_t addr=TH02_ADDR);
/**
* TH02 object destructor, basicaly it close i2c connection.
* TH02 object destructor; basically, it closes the I2C connection.
*/
~TH02 ();
/**
* Get the temperature value from sensor.
* Gets the temperature value from the sensor.
*/
float getTemperature ();
/**
* Get the humidity value from sensor.
* Gets the humidity value from the sensor.
*/
float getHumidity ();
/**
* Get the sensor's status.
* Gets the sensor status.
*/
bool getStatus ();
/**
* Return name of the component
* Returns the name of the component
*/
std::string name()
{