From c3d5b9557630a7a45f12f09052e652288ba3d0aa Mon Sep 17 00:00:00 2001 From: Sarah Knepper Date: Thu, 4 Dec 2014 10:59:17 +0000 Subject: [PATCH] grove.h: Improve docstrings on GroveTemp Signed-off-by: Sarah Knepper Signed-off-by: Brendan Le Foll --- src/grove/grove.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/grove/grove.h b/src/grove/grove.h index 721b4e4a..3dac1a8d 100644 --- a/src/grove/grove.h +++ b/src/grove/grove.h @@ -66,9 +66,9 @@ class GroveLed: public Grove { }; /** - * @brief C++ API for Grove Temperature sensor + * @brief C++ API for Grove temperature sensor * - * Very basic UPM module for grove temperature sensor on analog + * Very basic UPM module for Grove temperature sensor on analog * * @ingroup grove analog * @snippet grovetemp.cxx Interesting @@ -78,7 +78,7 @@ class GroveTemp: public Grove { /** * Grove analog temperature sensor constructor * - * @param analog pin to use + * @param pin analog pin to use */ GroveTemp(unsigned int pin); /** @@ -92,9 +92,9 @@ class GroveTemp: public Grove { */ float raw_value(); /** - * Get the temperature from the sensor + * Get the temperature in Celsius from the sensor * - * @return the normalised temperature + * @return the normalized temperature in Celsius */ int value(); private: