alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-03 18:31:13 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: final batch of header files reviewed

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-10 18:53:31 +03:00
committed by Mihai Tudor Panu
parent 04edb9be04
commit 1fe9b9eb1d
53 changed files with 1182 additions and 1191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/waterlevel/waterlevel.h
View File

@ -27,7 +27,7 @@
namespace upm {
/**
* @brief Water Level switch library
* @brief Water Level Switch Library
* @defgroup waterlevel libupm-waterlevel
* @ingroup seeed gpio liquid
*/
@ -50,17 +50,17 @@ namespace upm {
class WaterLevel {
public:
/**
* Water Level Constructor
* WaterLevel constructor
*
* @param pin digital pin to use
* @param pin Digital pin to use
*/
WaterLevel(int pin);
/**
* Water Level Destructor
* WaterLevel destructor
*/
~WaterLevel();
/**
* @return bool returns whether liquid has gone above sensor
* @return bool Determines whether liquid has risen above the sensor
*/
bool isSubmerged();