alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +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

26
src/maxds3231m/maxds3231m.h
View File

@ -63,7 +63,7 @@ struct Time3231 {
};
/**
* @brief MAXDS3231M proximity sensor library
* @brief MAXDS3231M Proximity Sensor library
* @defgroup maxds3231m libupm-maxds3231m
* @ingroup maxim i2c light
*/
@ -75,48 +75,48 @@ struct Time3231 {
* @man maxim
* @con i2c
*
* @brief API for MAXDS3231M chip (I2C Real-Time Clock)
* @brief API for the MAXDS3231M I2C Real-Time Clock
*
* This file defines the API for maxds3231m
* This file defines the API for MAXDS3231M
*
* @snippet maxds3231m.cxx Interesting
*/
class MAXDS3231M {
public:
/**
* Instanciates a MAXDS3231M object
* Instantiates an MAXDS3231M object
*
* @param bus number of used bus
* @param devAddr addres of used i2c device
* @param bus Number of the used bus
* @param devAddr Address of the used I2C device
*/
MAXDS3231M (int bus=0, int devAddr=0x68);
/**
* MAXDS3231M object destructor, basicaly it close i2c connection.
* MAXDS3231M object destructor; basically, it closes the I2C connection.
*/
~MAXDS3231M ();
/**
* Set date and time on the chip.
* Sets the date and time on the chip.
*
* @param time staracture
* @param time Time structure
*/
void setDate (Time3231 &time);
/**
* Get date and time located on the chip.
* Gets the date and time from the chip.
*
* @param time staracture
* @param time Time structure
*/
bool getDate (Time3231 &time);
/**
* Get on board temperature.
* Gets the on-board temperature.
*/
uint16_t getTemperature ();
/**
* Return name of the component
* Returns the name of the component
*/
std::string name()
{