alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-05 03:11:15 +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

20
src/tcs3414cs/tcs3414cs.h
View File

@ -105,7 +105,7 @@ typedef struct {
} tcs3414sc_rgb_t;
/**
* @brief TCS3414CS color sensor library
* @brief TCS3414CS Color Sensor library
* @defgroup tcs3414cs libupm-tcs3414cs
* @ingroup seeed i2c color
*/
@ -119,9 +119,9 @@ typedef struct {
* @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Color_Sensor
* @con i2c
*
* @brief API for TCS3414CS chip (Color sensor)
* @brief API for the TCS3414CS Color Sensor
*
* This file defines the TCS3414CS interface for the color sensor
* This file defines the TCS3414CS interface for the color sensor
*
* @image html tcs3414cs.jpg
* @snippet tcs3414cs.cxx Interesting
@ -129,31 +129,31 @@ typedef struct {
class TCS3414CS {
public:
/**
* Instanciates a TCS3414CS object
* Instantiates a TCS3414CS object
*
* @param bus number of used bus
* @param bus Number of the used bus
*/
TCS3414CS ();
/**
* TCS3414CS object destructor, basicaly it close i2c connection.
* TCS3414CS object destructor; basically, it closes the I2C connection.
*/
~TCS3414CS ();
/**
* Get the RGB value from sensor.
* Gets the RGB value from the sensor.
*
* @param rgb color values
* @param rgb Color values
*/
void readRGB (tcs3414sc_rgb_t * rgb);
/**
* Clear interrupts.
* Clears interrupts.
*/
void clearInterrupt ();
/**
* Return name of the component
* Returns the name of the component
*/
std::string name()
{