upm: updated headers of sensors in environmental kit

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-06-24 13:25:29 -07:00
parent fd29a7409e
commit 6c7928fc92
11 changed files with 18 additions and 10 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -30,7 +30,7 @@ namespace upm {
/** /**
* @brief Grove Water sensor library * @brief Grove Water sensor library
* @defgroup grovewater libupm-grovewater * @defgroup grovewater libupm-grovewater
* @ingroup seeed gpio liquid * @ingroup seeed gpio liquid eak
*/ */
/** /**
@ -40,6 +40,7 @@ namespace upm {
* @type liquid * @type liquid
* @man seeed * @man seeed
* @con gpio * @con gpio
* @kit eak
* *
* @brief API for the Grove Water Sensor * @brief API for the Grove Water Sensor
* *

View File

@ -33,7 +33,7 @@ namespace upm {
/** /**
* @brief Grove Water Flow sensor library * @brief Grove Water Flow sensor library
* @defgroup grovewfs libupm-grovewfs * @defgroup grovewfs libupm-grovewfs
* @ingroup seeed gpio liquid * @ingroup seeed gpio liquid eak
*/ */
/** /**
@ -44,6 +44,7 @@ namespace upm {
* @man seeed * @man seeed
* @web http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor * @web http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor
* @con gpio * @con gpio
* @kit eak
* @brief API for the Grove Water Flow Sensor * @brief API for the Grove Water Flow Sensor
* *

View File

@ -30,7 +30,7 @@ namespace upm {
/** /**
* @brief GUVA-S12D UV sensor library * @brief GUVA-S12D UV sensor library
* @defgroup guvas12d libupm-guvas12d * @defgroup guvas12d libupm-guvas12d
* @ingroup seeed analog light * @ingroup seeed analog light eak
*/ */
/** /**
@ -41,6 +41,7 @@ namespace upm {
* @type light * @type light
* @man seeed * @man seeed
* @con analog * @con analog
* @kit eak
* *
* @brief API for the GUVAS12D UV sensor module * @brief API for the GUVAS12D UV sensor module
* *

View File

@ -40,7 +40,7 @@ namespace upm {
/** /**
* @brief MY9221 led bar library * @brief MY9221 led bar library
* @defgroup my9221 libupm-my9221 * @defgroup my9221 libupm-my9221
* @ingroup seeed display gpio * @ingroup seeed display gpio eak
*/ */
/** /**
* @library my9221 * @library my9221
@ -51,6 +51,7 @@ namespace upm {
* @man seeed * @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_LED_Bar * @web http://www.seeedstudio.com/wiki/Grove_-_LED_Bar
* @con gpio * @con gpio
* @kit eak
* *
* @brief API for MY9221 based LED bars * @brief API for MY9221 based LED bars
* *

View File

@ -39,7 +39,7 @@ typedef struct
/** /**
* @brief PPD42NS dust sensor library * @brief PPD42NS dust sensor library
* @defgroup ppd42ns libupm-ppd42ns * @defgroup ppd42ns libupm-ppd42ns
* @ingroup seeed gpio other * @ingroup seeed gpio other eak
*/ */
/** /**
* @library ppd42ns * @library ppd42ns
@ -50,6 +50,7 @@ typedef struct
* @man seeed * @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Dust_Sensor * @web http://www.seeedstudio.com/wiki/Grove_-_Dust_Sensor
* @con gpio * @con gpio
* @kit eak
* *
* @brief API for the Dust Sensor * @brief API for the Dust Sensor
* *

View File

@ -94,7 +94,7 @@ namespace upm {
/** /**
* @brief TSL2561 digital light sensor library * @brief TSL2561 digital light sensor library
* @defgroup tsl2561 libupm-tsl2561 * @defgroup tsl2561 libupm-tsl2561
* @ingroup seeed i2c light * @ingroup seeed i2c light eak
*/ */
/** /**
* @library tsl2561 * @library tsl2561
@ -105,6 +105,7 @@ namespace upm {
* @man seeed * @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Digital_Light_Sensor * @web http://www.seeedstudio.com/wiki/Grove_-_Digital_Light_Sensor
* @con i2c * @con i2c
* @kit eak
* *
* @brief TSL2561 Digital Light Sensor library * @brief TSL2561 Digital Light Sensor library
* *