gas: header updates with new tags

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-04-09 13:10:33 -07:00
parent cdfdbc3678
commit 90019cdc62
6 changed files with 94 additions and 63 deletions

View File

@ -34,7 +34,6 @@ struct thresholdContext {
}; };
namespace upm { namespace upm {
/** /**
* @brief Gas Sensor Library * @brief Gas Sensor Library
* *
@ -42,6 +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
*/ */
class Gas { class Gas {
public: public:

View File

@ -28,18 +28,24 @@
#include "gas.h" #include "gas.h"
namespace upm { namespace upm {
/** /**
* @brief C++ API for MQ2 gas sensor * @library gas
* * @sensor mq2
* The Grove - Gas Sensor (MQ2) module is useful for gas leakage detecting * @comname Grove MQ2 gas sensor
* (in home and industry). It can detect LPG, i-butane, methane, alcohol, * @type gaseous
* Hydrogen, smoke and other combustible gases. It's a medium sensitivity * @man seeed
* sensor with a detect concentration of 300-10000 ppm. * @con analog
* *
* @ingroup gas analog * @brief C++ API for MQ2 gas sensor
* @snippet mq2.cxx Interesting *
* @image html mq2-5.jpeg * The Grove - Gas Sensor (MQ2) module is useful for gas leakage detecting
*/ * (in home and industry). It can detect LPG, i-butane, methane, alcohol,
* Hydrogen, smoke and other combustible gases. It's a medium sensitivity
* sensor with a detect concentration of 300-10000 ppm.
*
* @image html mq2-5.jpeg
* @snippet mq2.cxx Interesting
*/
class MQ2 : public Gas { class MQ2 : public Gas {
public: public:
/** /**

View File

@ -28,18 +28,24 @@
#include "gas.h" #include "gas.h"
namespace upm { namespace upm {
/** /**
* @brief C++ API for MQ3 gas sensor * @library gas
* * @sensor mq3
* The Grove MQ3 Gas Sensor module is useful for gas leakage detecting (in * @comname Grove MQ3 gas sensor
* home and industry). It can detect Alcohol Vapour and Benzine. It's * @type gaseous
* highly sensitive but has a long warm-up time of about 1 minute. It's * @man seeed
* detect rate is of 0.04-4 mg/L Alcohol. * @con analog
* *
* @ingroup gas analog * @brief C++ API for MQ3 gas sensor
* @snippet mq3.cxx Interesting *
* @image html mq3-9.jpeg * The Grove MQ3 Gas Sensor module is useful for gas leakage detecting (in
*/ * home and industry). It can detect Alcohol Vapour and Benzine. It's
* highly sensitive but has a long warm-up time of about 1 minute. It's
* detect rate is of 0.04-4 mg/L Alcohol.
*
* @image html mq3-9.jpeg
* @snippet mq3.cxx Interesting
*/
class MQ3 : public Gas { class MQ3 : public Gas {
public: public:
/** /**

View File

@ -28,18 +28,24 @@
#include "gas.h" #include "gas.h"
namespace upm { namespace upm {
/** /**
* @brief C++ API for MQ5 gas sensor * @library gas
* * @sensor mq5
* The Grove - Gas Sensor (MQ5) module is useful for gas leakage detecting * @comname Grove MQ5 gas sensor
* (in home and industry). It can detect LPG, natural gas, town gas and so * @type gaseous
* on. It is highly sensitive and has a detection concentration of * @man seeed
* 300-10000 ppm. * @con analog
* *
* @ingroup gas analog * @brief C++ API for MQ5 gas sensor
* @snippet mq5.cxx Interesting *
* @image html mq2-5.jpeg * The Grove - Gas Sensor (MQ5) module is useful for gas leakage detecting
*/ * (in home and industry). It can detect LPG, natural gas, town gas and so
* on. It is highly sensitive and has a detection concentration of
* 300-10000 ppm.
*
* @image html mq2-5.jpeg
* @snippet mq5.cxx Interesting
*/
class MQ5 : public Gas { class MQ5 : public Gas {
public: public:
/** /**

View File

@ -28,17 +28,23 @@
#include "gas.h" #include "gas.h"
namespace upm { namespace upm {
/** /**
* @brief C++ API for MQ9 gas sensor * @library gas
* * @sensor mq9
* The Grove MQ9 Gas Sensor module is useful for gas leakage detecting (in * @comname Grove MQ9 gas sensor
* home and industry). It can detect Carbon Monoxide, Coal Gas and * @type gaseous
* Liquefied Gas. It's sensitivity is 10-1000 ppm CO, 100-10000 ppm Gas. * @man seeed
* * @con analog
* @ingroup gas analog *
* @snippet mq9.cxx Interesting * @brief C++ API for MQ9 gas sensor
* @image html mq3-9.jpeg *
*/ * The Grove MQ9 Gas Sensor module is useful for gas leakage detecting (in
* home and industry). It can detect Carbon Monoxide, Coal Gas and
* Liquefied Gas. It's sensitivity is 10-1000 ppm CO, 100-10000 ppm Gas.
*
* @image html mq3-9.jpeg
* @snippet mq9.cxx Interesting
*/
class MQ9 : public Gas { class MQ9 : public Gas {
public: public:
/** /**

View File

@ -28,21 +28,28 @@
#include "gas.h" #include "gas.h"
namespace upm { namespace upm {
/** /**
* @brief C++ API for Grove TP401 Air Quality Sensor * @library gas
* * @sensor tp401
* The Grove TP401 Air Quality Sensor module is useful for monitoring air purity indoors. * @comname Grove Air Quality Sensor
* It can detect CO and a wide range of other harmful gases, but due to limited sensing * @altname TP401
* range should be used only when qualitative results are needed. Example applications * @type gaseous
* are air recirculation, ventilation systems, and refreshing sprayers. * @man seeed
* The sensor is linear and should be roughly sensitive to 0 ~ 20 ppm CO from 0 ~ 4V. * @con analog
* Also note that the sensor requires 2-3 minutes to warm up initially and 48 hours of *
* operation to stabilize completely. * @brief C++ API for Grove TP401 Air Quality Sensor
* *
* @ingroup gas analog * The Grove TP401 Air Quality Sensor module is useful for monitoring air purity indoors.
* @snippet tp401.cxx Interesting * It can detect CO and a wide range of other harmful gases, but due to limited sensing
* @image html tp401.jpeg * range should be used only when qualitative results are needed. Example applications
*/ * are air recirculation, ventilation systems, and refreshing sprayers.
* The sensor is linear and should be roughly sensitive to 0 ~ 20 ppm CO from 0 ~ 4V.
* Also note that the sensor requires 2-3 minutes to warm up initially and 48 hours of
* operation to stabilize completely.
*
* @image html tp401.jpeg
* @snippet tp401.cxx Interesting
*/
class TP401 : public Gas { class TP401 : public Gas {
public: public:
/** /**