From 54cda32a948532243c45cbef12545f35ab2f3341 Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Fri, 10 Jul 2015 16:53:00 -0700 Subject: [PATCH] waterlevel: updated description and few changes to header Signed-off-by: Mihai Tudor Panu --- src/waterlevel/waterlevel.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/waterlevel/waterlevel.h b/src/waterlevel/waterlevel.h index df5318c9..708b9f83 100644 --- a/src/waterlevel/waterlevel.h +++ b/src/waterlevel/waterlevel.h @@ -27,7 +27,7 @@ namespace upm { /** - * @brief Water Level sensor library + * @brief Water Level switch library * @defgroup waterlevel libupm-waterlevel * @ingroup seeed gpio liquid */ @@ -39,11 +39,15 @@ namespace upm { * @man seeed * @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 * @snippet apds9002.cxx Interesting - */ class WaterLevel { + */ + class WaterLevel { public: /** * Water Level Constructor @@ -56,7 +60,7 @@ namespace upm { */ ~WaterLevel(); /** - * @return bool returns whether liquid has gone above sensor + * @return bool returns whether liquid has gone above sensor */ bool isSubmerged();