Переглянути джерело

ttp223.h: adding doxygen tags

Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
John Van Drasek 9 роки тому
джерело
коміт
7bb661d31b
1 змінених файлів з 20 додано та 9 видалено
  1. 20
    9
      src/ttp223/ttp223.h

+ 20
- 9
src/ttp223/ttp223.h Переглянути файл

@@ -27,22 +27,33 @@
27 27
 #include <mraa/gpio.h>
28 28
 
29 29
 namespace upm {
30
-
31 30
 /**
32 31
  * @brief TTP223 Touch Detector sensor library
32
+ *
33
+ *   This touch sensor detects when a finger is near the metallic pad
34
+ *   by a change in capacitance.  It can replace a more traditional push
35
+ *   button.  The touch sensor can still function when placed under a 
36
+ *   non-metallic surface like glass or plastic.
37
+ *
33 38
  * @defgroup ttp223 libupm-ttp223
39
+ * @ingroup seeed gpio touch
34 40
  */
35
-
36 41
 /**
37
- * @brief C++ API for TTP223 touch detector-based sensors,
38
- * such as the Grove Touch sensor
42
+ * @library ttp223
43
+ * @sensor ttp223
44
+ * @comname Touch sensor
45
+ * @type touch
46
+ * @man seeed
47
+ * @web http://www.seeedstudio.com/depot/Grove-Touch-Sensor-p-747.html
48
+ * @con gpio
39 49
  *
40
- * This touch sensor detects when a finger is near the metallic pad
41
- * by a change in capacitance.  It can replace a more traditional push
42
- * button.  The touch sensor can still function when placed under a 
43
- * non-metallic surface like glass or plastic.
50
+ * @brief TTP223 Touch Detector sensor library
51
+ * 
52
+ *   This touch sensor detects when a finger is near the metallic pad
53
+ *   by a change in capacitance.  It can replace a more traditional push
54
+ *   button.  The touch sensor can still function when placed under a 
55
+ *   non-metallic surface like glass or plastic.
44 56
  *
45
- * @ingroup ttp223 gpio
46 57
  * @snippet ttp223.cxx Interesting
47 58
  */
48 59
 class TTP223 {