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

groveelectromagnet: header updated with new tags 

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu 9 years ago
parent
728e01c582
commit
3a989a5ed3
1 changed files with 11 additions and 3 deletions
Split View Show Diff Stats
  1. 11
    3
      src/groveelectromagnet/groveelectromagnet.h

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

@@ -30,15 +30,23 @@
30 30
31 31 
 namespace upm {
32 32 
   /**
33 
-   * @brief UPM module for the Grove Electromagnet
33 
+   * @brief UPM library for the Grove Electromagnet
34 34 
    * @defgroup groveelectromagnet libupm-groveelectromagnet
35 
+   * @ingroup seeed gpio electric
35 36 
    */
37 
+
36 38 
   /**
39 
+   * @library groveelectromagnet
40 
+   * @sensor groveelectromagnet
41 
+   * @comname Grove Electromagnet
42 
+   * @type electric
43 
+   * @man seeed
44 
+   * @con gpio
45 
+   *
37 46 
    * @brief C++ API for the Grove Electromagnet
38 47 
    *
39 
-   * The Grove Electromagnet can hold up to 1 KG
48 
+   * The Grove Electromagnet can hold up to 1 KG (approximately 2.2 lbs)
40 49 
    *
41 
-   * @ingroup gpio groveelectromagnet
42 50 
    * @snippet groveelectromagnet.cxx Interesting
43 51 
    */
44 52 
   class GroveElectromagnet {