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

grove: improve docstrings

Browse Source 
Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Sarah Knepper 2014-12-04 10:41:32 +00:00 committed by Brendan Le Foll
parent a1abab8909
commit 751b0f1fe0
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/grove/grove.h
View File

@ -1,6 +1,7 @@
/* /*
* Author: Brendan Le Foll <brendan.le.foll@intel.com> * Author: Brendan Le Foll <brendan.le.foll@intel.com>
* Contributions: Mihai Tudor Panu <mihai.t.panu@intel.com> * Contributions: Mihai Tudor Panu <mihai.t.panu@intel.com>
* Contributions: Sarah Knepper <sarah.knepper@intel.com>
* Copyright (c) 2014 Intel Corporation. * Copyright (c) 2014 Intel Corporation.
* *
* Permission is hereby granted, free of charge, to any person obtaining * Permission is hereby granted, free of charge, to any person obtaining
@ -103,7 +104,7 @@ class GroveTemp: public Grove {
/** /**
* @brief C++ API for Grove light sensor * @brief C++ API for Grove light sensor
* *
* Very basic UPM module for grove Light sensor on analog * Very basic UPM module for Grove light sensor on analog
* *
* @ingroup grove analog * @ingroup grove analog
* @snippet grovelight.cxx Interesting * @snippet grovelight.cxx Interesting
@ -113,7 +114,7 @@ class GroveLight: public Grove {
/** /**
* Grove analog light sensor constructor * Grove analog light sensor constructor
* *
* @param analog pin to use * @param pin analog pin to use
*/ */
GroveLight(unsigned int pin); GroveLight(unsigned int pin);
/** /**
@ -127,9 +128,9 @@ class GroveLight: public Grove {
*/ */
float raw_value(); float raw_value();
/** /**
* Get the light value from the sensor * Get the approximate light value, in lux, from the sensor
* *
* @return the normalised light reading * @return the normalized light reading in lux
*/ */
int value(); int value();
private: private: