Browse Source

enc03r: header update

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu 9 years ago
parent
commit
b218d01248
1 changed files with 14 additions and 1 deletions
  1. 14
    1
      src/enc03r/enc03r.h

+ 14
- 1
src/enc03r/enc03r.h View File

29
 namespace upm {
29
 namespace upm {
30
 
30
 
31
   /**
31
   /**
32
+   * @brief ENC03R Single Axis Gyro library
33
+   * @defgroup enc03r libupm-enc03r
34
+   * @ingroup seeed analog compass
35
+   */
36
+
37
+  /**
38
+   * @library enc03r
39
+   * @sensor enc03r
40
+   * @comname Grove Single Axis Analog Gyro
41
+   * @altname ENC03R
42
+   * @type compass
43
+   * @man seeed
44
+   * @con analog
45
+   *
32
    * @brief C++ API for the ENC03R Single Axis Analog Gyro
46
    * @brief C++ API for the ENC03R Single Axis Analog Gyro
33
    *
47
    *
34
    * UPM module for the ENC03R Single Axis Analog Gyro.
48
    * UPM module for the ENC03R Single Axis Analog Gyro.
36
    * how fast the sensor is rotating around the x-axis.
50
    * how fast the sensor is rotating around the x-axis.
37
    * Calibration of the sensor is necessary for accurate readings.
51
    * Calibration of the sensor is necessary for accurate readings.
38
    *
52
    *
39
-   * @ingroup grove analog
40
    * @snippet enc03r.cxx Interesting
53
    * @snippet enc03r.cxx Interesting
41
    */
54
    */
42
   class ENC03R {
55
   class ENC03R {