doxygen: added documentation to new public methods

Signed-off-by: Kiveisha Yevgeniy <yevgeniy.kiveisha@intel.com>
This commit is contained in:
Kiveisha Yevgeniy 2014-06-10 13:39:02 +00:00
parent 12b2ab6991
commit ca0b0cce44
2 changed files with 19 additions and 1 deletions

View File

@ -64,7 +64,7 @@ MAX44000::getProximity () {
uint16_t
MAX44000::getAmbient () {
uint16_t data = 0;
data = (i2cReadReg_8 (ALSDATA_HIGH) & 0x7F) << 8;
data = data | i2cReadReg_8 (ALSDATA_LOW);

View File

@ -102,8 +102,26 @@ class MAX44000 {
return m_name;
}
/**
* Read one byte register
*
* @param reg address of a register
*/
uint8_t i2cReadReg_8 (int reg);
/**
* Read two bytes register
*
* @param reg address of a register
*/
uint16_t i2cReadReg_16 (int reg);
/**
* Write to one byte register
*
* @param reg address of a register
* @param value byte to be written
*/
maa_result_t i2cWriteReg (uint8_t reg, uint8_t value);
private: