Browse Source

gas: header updates with new tags

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu 9 years ago
parent
commit
90019cdc62
6 changed files with 94 additions and 63 deletions
  1. 1
    1
      src/gas/gas.h
  2. 18
    12
      src/gas/mq2.h
  3. 18
    12
      src/gas/mq3.h
  4. 18
    12
      src/gas/mq5.h
  5. 17
    11
      src/gas/mq9.h
  6. 22
    15
      src/gas/tp401.h

+ 1
- 1
src/gas/gas.h View File

@@ -34,7 +34,6 @@ struct thresholdContext {
34 34
 };
35 35
 
36 36
 namespace upm {
37
-
38 37
 /**
39 38
  * @brief Gas Sensor Library
40 39
  *
@@ -42,6 +41,7 @@ namespace upm {
42 41
  * sampling, threshold checking, a basic printing function and a standard read function.
43 42
  *
44 43
  * @defgroup gas libupm-gas
44
+ * @ingroup seeed analog gaseous
45 45
  */
46 46
 class Gas {
47 47
     public:

+ 18
- 12
src/gas/mq2.h View File

@@ -28,18 +28,24 @@
28 28
 #include "gas.h"
29 29
 
30 30
 namespace upm {
31
-    /**
32
-     * @brief C++ API for MQ2 gas sensor
33
-     *
34
-     * The Grove - Gas Sensor (MQ2) module is useful for gas leakage detecting
35
-     * (in home and industry). It can detect LPG, i-butane, methane, alcohol,
36
-     * Hydrogen, smoke and other combustible gases. It's a medium sensitivity
37
-     * sensor with a detect concentration of 300-10000 ppm.
38
-     *
39
-     * @ingroup gas analog
40
-     * @snippet mq2.cxx Interesting
41
-     * @image html mq2-5.jpeg
42
-     */
31
+  /**
32
+   * @library gas
33
+   * @sensor mq2
34
+   * @comname Grove MQ2 gas sensor
35
+   * @type gaseous
36
+   * @man seeed
37
+   * @con analog
38
+   *
39
+   * @brief C++ API for MQ2 gas sensor
40
+   *
41
+   * The Grove - Gas Sensor (MQ2) module is useful for gas leakage detecting
42
+   * (in home and industry). It can detect LPG, i-butane, methane, alcohol,
43
+   * Hydrogen, smoke and other combustible gases. It's a medium sensitivity
44
+   * sensor with a detect concentration of 300-10000 ppm.
45
+   *
46
+   * @image html mq2-5.jpeg
47
+   * @snippet mq2.cxx Interesting
48
+   */
43 49
     class MQ2 : public Gas {
44 50
         public:
45 51
             /**

+ 18
- 12
src/gas/mq3.h View File

@@ -28,18 +28,24 @@
28 28
 #include "gas.h"
29 29
 
30 30
 namespace upm {
31
-    /**
32
-     * @brief C++ API for MQ3 gas sensor
33
-     *
34
-     * The Grove MQ3 Gas Sensor module is useful for gas leakage detecting (in
35
-     * home and industry). It can detect Alcohol Vapour and Benzine. It's
36
-     * highly sensitive but has a long warm-up time of about 1 minute. It's
37
-     * detect rate is of 0.04-4 mg/L Alcohol.
38
-     *
39
-     * @ingroup gas analog
40
-     * @snippet mq3.cxx Interesting
41
-     * @image html mq3-9.jpeg
42
-     */
31
+  /**
32
+   * @library gas
33
+   * @sensor mq3
34
+   * @comname Grove MQ3 gas sensor
35
+   * @type gaseous
36
+   * @man seeed
37
+   * @con analog
38
+   *
39
+   * @brief C++ API for MQ3 gas sensor
40
+   *
41
+   * The Grove MQ3 Gas Sensor module is useful for gas leakage detecting (in
42
+   * home and industry). It can detect Alcohol Vapour and Benzine. It's
43
+   * highly sensitive but has a long warm-up time of about 1 minute. It's
44
+   * detect rate is of 0.04-4 mg/L Alcohol.
45
+   *
46
+   * @image html mq3-9.jpeg
47
+   * @snippet mq3.cxx Interesting
48
+   */
43 49
     class MQ3 : public Gas {
44 50
         public:
45 51
             /**

+ 18
- 12
src/gas/mq5.h View File

@@ -28,18 +28,24 @@
28 28
 #include "gas.h"
29 29
 
30 30
 namespace upm {
31
-    /**
32
-     * @brief C++ API for MQ5 gas sensor
33
-     *
34
-     * The Grove - Gas Sensor (MQ5) module is useful for gas leakage detecting
35
-     * (in home and industry). It can detect LPG, natural gas, town gas and so
36
-     * on. It is highly sensitive and has a detection concentration of
37
-     * 300-10000 ppm.
38
-     *
39
-     * @ingroup gas analog
40
-     * @snippet mq5.cxx Interesting
41
-     * @image html mq2-5.jpeg
42
-     */
31
+  /**
32
+   * @library gas
33
+   * @sensor mq5
34
+   * @comname Grove MQ5 gas sensor
35
+   * @type gaseous
36
+   * @man seeed
37
+   * @con analog
38
+   *
39
+   * @brief C++ API for MQ5 gas sensor
40
+   *
41
+   * The Grove - Gas Sensor (MQ5) module is useful for gas leakage detecting
42
+   * (in home and industry). It can detect LPG, natural gas, town gas and so
43
+   * on. It is highly sensitive and has a detection concentration of
44
+   * 300-10000 ppm.
45
+   *
46
+   * @image html mq2-5.jpeg
47
+   * @snippet mq5.cxx Interesting
48
+   */
43 49
     class MQ5 : public Gas {
44 50
         public:
45 51
             /**

+ 17
- 11
src/gas/mq9.h View File

@@ -28,17 +28,23 @@
28 28
 #include "gas.h"
29 29
 
30 30
 namespace upm {
31
-    /**
32
-     * @brief C++ API for MQ9 gas sensor
33
-     *
34
-     * The Grove MQ9 Gas Sensor module is useful for gas leakage detecting (in
35
-     * home and industry). It can detect Carbon Monoxide, Coal Gas and
36
-     * Liquefied Gas. It's sensitivity is 10-1000 ppm CO, 100-10000 ppm Gas.
37
-     *
38
-     * @ingroup gas analog
39
-     * @snippet mq9.cxx Interesting
40
-     * @image html mq3-9.jpeg
41
-     */
31
+  /**
32
+   * @library gas
33
+   * @sensor mq9
34
+   * @comname Grove MQ9 gas sensor
35
+   * @type gaseous
36
+   * @man seeed
37
+   * @con analog
38
+   *
39
+   * @brief C++ API for MQ9 gas sensor
40
+   *
41
+   * The Grove MQ9 Gas Sensor module is useful for gas leakage detecting (in
42
+   * home and industry). It can detect Carbon Monoxide, Coal Gas and
43
+   * Liquefied Gas. It's sensitivity is 10-1000 ppm CO, 100-10000 ppm Gas.
44
+   *
45
+   * @image html mq3-9.jpeg
46
+   * @snippet mq9.cxx Interesting
47
+   */
42 48
     class MQ9 : public Gas {
43 49
         public:
44 50
             /**

+ 22
- 15
src/gas/tp401.h View File

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