mirror of
https://github.com/eclipse/upm.git
synced 2025-07-02 01:41:12 +03:00
docs: more header files edited
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:

committed by
Mihai Tudor Panu

parent
55e8076988
commit
04edb9be04
@ -28,7 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief Grove Moisture sensor library
|
||||
* @brief Grove Moisture Sensor library
|
||||
* @defgroup grovemoisture libupm-grovemoisture
|
||||
* @ingroup seeed analog liquid eak hak
|
||||
*/
|
||||
@ -48,7 +48,7 @@ namespace upm {
|
||||
* This sensor can be used to detect the moisture content
|
||||
* of soil or whether there is water around the sensor.
|
||||
* As the moisture content increases, so does the value that is read.
|
||||
* Note that this sensor is not designed to be left in soil
|
||||
* Note: this sensor is not designed to be left in soil
|
||||
* nor to be used outdoors.
|
||||
*
|
||||
* @image html grovemoisture.jpg
|
||||
@ -59,17 +59,17 @@ namespace upm {
|
||||
/**
|
||||
* Grove analog moisture sensor constructor
|
||||
*
|
||||
* @param pin analog pin to use
|
||||
* @param pin Analog pin to use
|
||||
*/
|
||||
GroveMoisture(int pin);
|
||||
/**
|
||||
* GroveMoisture Destructor
|
||||
* GroveMoisture destructor
|
||||
*/
|
||||
~GroveMoisture();
|
||||
/**
|
||||
* Get the moisture value from the sensor
|
||||
* Gets the moisture value from the sensor
|
||||
*
|
||||
* @return the moisture reading
|
||||
* @return Moisture reading
|
||||
*/
|
||||
int value();
|
||||
|
||||
|
Reference in New Issue
Block a user