Pārlūkot izejas kodu

grove.h: Improve docstrings on GroveTemp

Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
Sarah Knepper 10 gadus atpakaļ
vecāks
revīzija
c3d5b95576
1 mainītis faili ar 5 papildinājumiem un 5 dzēšanām
  1. 5
    5
      src/grove/grove.h

+ 5
- 5
src/grove/grove.h Parādīt failu

@@ -66,9 +66,9 @@ class GroveLed: public Grove {
66 66
 };
67 67
 
68 68
 /**
69
- * @brief C++ API for Grove Temperature sensor
69
+ * @brief C++ API for Grove temperature sensor
70 70
  *
71
- * Very basic UPM module for grove temperature sensor on analog
71
+ * Very basic UPM module for Grove temperature sensor on analog
72 72
  *
73 73
  * @ingroup grove analog
74 74
  * @snippet grovetemp.cxx Interesting
@@ -78,7 +78,7 @@ class GroveTemp: public Grove {
78 78
         /**
79 79
          * Grove analog temperature sensor constructor
80 80
          *
81
-         * @param analog pin to use
81
+         * @param pin analog pin to use
82 82
          */
83 83
         GroveTemp(unsigned int pin);
84 84
         /**
@@ -92,9 +92,9 @@ class GroveTemp: public Grove {
92 92
          */
93 93
         float raw_value();
94 94
         /**
95
-         * Get the temperature from the sensor
95
+         * Get the temperature in Celsius from the sensor
96 96
          *
97
-         * @return the normalised temperature
97
+         * @return the normalized temperature in Celsius
98 98
          */
99 99
         int value();
100 100
     private: