瀏覽代碼

grovecollision: header updated with new tags

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu 9 年之前
父節點
當前提交
8d931fbf74
共有 1 個文件被更改,包括 11 次插入3 次删除
  1. 11
    3
      src/grovecollision/grovecollision.h

+ 11
- 3
src/grovecollision/grovecollision.h 查看文件

@@ -27,17 +27,25 @@
27 27
 
28 28
 namespace upm {
29 29
   /**
30
-   * @brief UPM module for the Grove Collision
30
+   * @brief UPM library for the Grove Collision Sensor
31 31
    * @defgroup grovecollision libupm-grovecollision
32
+   * @ingroup seeed gpio acceleration
32 33
    */
34
+
33 35
   /**
34
-   * @brief C++ API for the Grove Collision
36
+   * @library grovecollision
37
+   * @sensor grovecollision
38
+   * @comname Grove Collision Sensor
39
+   * @type acceleration
40
+   * @man seeed
41
+   * @con gpio
42
+   *
43
+   * @brief C++ API for the Grove Collision Sensor
35 44
    * 
36 45
    * The Grove Collision Sensor can detect whether any
37 46
    * collision movement or vibration happens.
38 47
    * It will output a low pulse signal when vibration is detected. 
39 48
    *
40
-   * @ingroup gpio grovecollision
41 49
    * @snippet grovecollision.cxx Interesting
42 50
    */
43 51
   class GroveCollision {