alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-24 01:10:22 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

waterlevel: updated description and few changes to header

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-07-10 16:53:00 -07:00
parent 2e36b8dc21
commit 54cda32a94
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/waterlevel/waterlevel.h
View File

@ -27,7 +27,7 @@
namespace upm { namespace upm {
/** /**
* @brief Water Level sensor library * @brief Water Level switch library
* @defgroup waterlevel libupm-waterlevel * @defgroup waterlevel libupm-waterlevel
* @ingroup seeed gpio liquid * @ingroup seeed gpio liquid
*/ */
@ -39,11 +39,15 @@ namespace upm {
* @man seeed * @man seeed
* @con gpio * @con gpio
* *
* @brief UPM module for the Grove Luminance Sensor * @brief UPM module for the Grove Water Level Switch
*
* This switch is a device used to sense the level of liquid within a tank,
* it may actuate a pump, an indicator, an alarm, or other devices.
* *
* @image html waterlevel.jpg * @image html waterlevel.jpg
* @snippet apds9002.cxx Interesting * @snippet apds9002.cxx Interesting
*/ class WaterLevel { */
class WaterLevel {
public: public:
/** /**
* Water Level Constructor * Water Level Constructor
@ -56,7 +60,7 @@ namespace upm {
*/ */
~WaterLevel(); ~WaterLevel();
/** /**
* @return bool returns whether liquid has gone above sensor * @return bool returns whether liquid has gone above sensor
*/ */
bool isSubmerged(); bool isSubmerged();