Browse Source

grove.h: add documentation to aio grove sensors

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
Brendan Le Foll 10 years ago
parent
commit
79e8a261ba
1 changed files with 16 additions and 0 deletions
  1. 16
    0
      src/grove/grove.h

+ 16
- 0
src/grove/grove.h View File

@@ -73,7 +73,15 @@ class GroveLed: public Grove {
73 73
  */
74 74
 class GroveTemp: public Grove {
75 75
     public:
76
+        /**
77
+         * Grove analog temperature sensor constructor
78
+         *
79
+         * @param analog pin to use
80
+         */
76 81
         GroveTemp(unsigned int pin);
82
+        /**
83
+         * GroveTemp destructor
84
+         */
77 85
         ~GroveTemp();
78 86
         /**
79 87
          * Get raw value from AIO pin
@@ -101,7 +109,15 @@ class GroveTemp: public Grove {
101 109
  */
102 110
 class GroveLight: public Grove {
103 111
     public:
112
+        /**
113
+         * Grove analog light sensor constructor
114
+         *
115
+         * @param analog pin to use
116
+         */
104 117
         GroveLight(unsigned int pin);
118
+        /**
119
+         * GroveLight Destructor
120
+         */
105 121
         ~GroveLight();
106 122
         /**
107 123
          * Get raw value from AIO pin