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

docs: header files for sensors starting with [a] reviewed.

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-07 20:33:46 +03:00
committed by Mihai Tudor Panu
parent de49bb0e42
commit 9db2d57de3
11 changed files with 359 additions and 328 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/apds9002/apds9002.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief APDS-9002 luminance sensor library
* @brief APDS-9002 Luminance Sensor library
* @defgroup apds9002 libupm-apds9002
* @ingroup seeed analog light
*/
@ -42,10 +42,10 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief UPM module for the Grove Luminance Sensor
* @brief UPM module for the APDS-9002 Luminance Sensor
*
* This sensor transforms luminous intensity to output analog values.
* It uses the APDS-9002 ambient light sensor.
* It uses an APDS-9002 ambient light sensor.
*
* @image html apds9002.jpg
* @snippet apds9002.cxx Interesting
@ -54,19 +54,19 @@ namespace upm {
class APDS9002 {
public:
/**
* Grove luminance sensor constructor
* APDS-9002 luminance sensor constructor
*
* @param pin analog pin to use
* @param pin Analog pin to use
*/
APDS9002(int pin);
/**
* APDS9002 Destructor
* APDS9002 destructor
*/
~APDS9002();
/**
* Get the luminance value from the sensor
* Gets the luminance value from the sensor
*
* @return the luminance reading
* @return Luminance value
*/
int value();