upm: updated headers of sensors in home automation kit

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-06-24 13:39:09 -07:00
parent 6c7928fc92
commit 32921ff2b1
12 changed files with 18 additions and 12 deletions

View File

@ -41,7 +41,7 @@ namespace upm {
* sampling, threshold checking, a basic printing function and a standard read function.
*
* @defgroup gas libupm-gas
* @ingroup seeed analog gaseous eak
* @ingroup seeed analog gaseous eak hak
*/
class Gas {
public:

View File

@ -35,6 +35,7 @@ namespace upm {
* @type gaseous
* @man seeed
* @con analog
* @kit hak
*
* @brief API for MQ2 Gas Sensor
*

View File

@ -36,6 +36,7 @@ namespace upm {
* @type gaseous
* @man seeed
* @con analog
* @kit hak
*
* @brief API for Grove TP401 Air Quality Sensor
*

View File

@ -34,7 +34,7 @@ namespace upm {
/**
* @brief generic library for basic grove sensors
* @defgroup grove libupm-grove
* @ingroup seeed gpio pwm ainput button led light relay temp touch gsk eak
* @ingroup seeed gpio pwm ainput button led light relay temp touch gsk eak hak
*/
class Grove {
public:

View File

@ -30,7 +30,7 @@
* @type relay
* @man seeed
* @con gpio
* @kit gsk eak
* @kit gsk eak hak
*
* @brief API for Grove Relay
*

View File

@ -31,6 +31,7 @@
* @type ainput
* @man seeed
* @con analog
* @kit gsk
*
* @brief API for Grove Rotary Angle Sensor (Knob)
*

View File

@ -30,7 +30,7 @@ namespace upm {
/**
* @brief Grove Moisture sensor library
* @defgroup grovemoisture libupm-grovemoisture
* @ingroup seeed analog liquid eak
* @ingroup seeed analog liquid eak hak
*/
/**
@ -40,7 +40,7 @@ namespace upm {
* @type liquid
* @man seeed
* @con analog
* @kit eak
* @kit eak hak
*
* @brief API for the Grove Moisture Sensor
*

View File

@ -35,7 +35,7 @@ namespace upm {
/**
* @brief Grove Speaker library
* @defgroup grovespeaker libupm-grovespeaker
* @ingroup seeed gpio sound
* @ingroup seeed gpio sound hak
*/
typedef struct
{
@ -53,6 +53,7 @@ typedef struct
* @type sound
* @man seeed
* @con gpio
* @kit hak
*
* @brief API for the GroveSpeaker speaker
*

View File

@ -31,7 +31,7 @@ namespace upm {
/**
* @brief OTP538U IR Temperature Sensor library
* @defgroup otp538u libupm-otp538u
* @ingroup seeed analog light
* @ingroup seeed analog light hak
*/
/**
* @library otp538u
@ -41,6 +41,7 @@ namespace upm {
* @type light
* @man generic
* @con analog
* @kit hak
*
* @brief API for the OTP538U IR Temperature Sensor
*

View File

@ -33,7 +33,7 @@ namespace upm {
/**
* @brief Grove Rotary Encoder library
* @defgroup rotaryencoder libupm-rotaryencoder
* @ingroup seeed gpio other
* @ingroup seeed gpio other hak
*/
/**
* @library rotaryencoder
@ -43,7 +43,7 @@ namespace upm {
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Encoder
* @con gpio
* @kit gsk
* @kit hak
*
* @brief API for the Grove Rotary Encoder
*

View File

@ -31,7 +31,7 @@ namespace upm {
/**
* @brief RPR220 IR reflective sensor library
* @defgroup rpr220 libupm-rpr220
* @ingroup seeed gpio light tsk
* @ingroup seeed gpio light tsk hak
*/
/**
* @library rpr220
@ -42,7 +42,7 @@ namespace upm {
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Infrared_Reflective_Sensor
* @con gpio
* @kit tsk
* @kit tsk hak
*
* @brief API for the RPR220 based Grove IR Reflective Sensor
*

View File

@ -30,7 +30,7 @@ namespace upm {
/**
* @brief YG1006 flame sensor library
* @defgroup yg1006 libupm-yg1006
* @ingroup seeed gpio light
* @ingroup seeed gpio light hak
*/
/**
* @library yg1006
@ -41,6 +41,7 @@ namespace upm {
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Flame_Sensor
* @con gpio
* @kit hak
*
* @brief API for the YG1006 flame sensor
*