kissbac
/
upm
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

grovecollision: header updated with new tags 

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu 9 years ago
parent
5b4edc8631
commit
8d931fbf74
1 changed files with 11 additions and 3 deletions
Unified View Show Diff Stats
  1. 11
    3
      src/grovecollision/grovecollision.h

+ 11
- 3
src/grovecollision/grovecollision.h View File

27
27
28 
 namespace upm {
 28 
 namespace upm {
29 
   /**
 29 
   /**
30 
-   * @brief UPM module for the Grove Collision
30 
+   * @brief UPM library for the Grove Collision Sensor
31 
    * @defgroup grovecollision libupm-grovecollision
 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 
    * The Grove Collision Sensor can detect whether any
 45 
    * The Grove Collision Sensor can detect whether any
37 
    * collision movement or vibration happens.
 46 
    * collision movement or vibration happens.
38 
    * It will output a low pulse signal when vibration is detected.
47 
    * It will output a low pulse signal when vibration is detected.
39 
    *
 48 
    *
40 
-   * @ingroup gpio grovecollision
41 
    * @snippet grovecollision.cxx Interesting
 49 
    * @snippet grovecollision.cxx Interesting
42 
    */
 50 
    */
43 
   class GroveCollision {
 51 
   class GroveCollision {