docs: updated @param tags, added missing function descriptions, other minor changes

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2017-04-10 16:59:39 -07:00
parent 39df7fd10f
commit 3aef2ea70e
94 changed files with 327 additions and 222 deletions

View File

@ -477,7 +477,7 @@ namespace upm {
* BMA220 constructor
*
* @param bus i2c bus to use
* @param address the address for this device
* @param addr the address for this device
*/
BMA220(int bus=BMA220_I2C_BUS, uint8_t addr=BMA220_DEFAULT_ADDR);
@ -494,7 +494,6 @@ namespace upm {
/**
* read a register
*
* @param dev the device to access (XM or G)
* @param reg the register to read
* @return the value of the register
*/
@ -503,7 +502,6 @@ namespace upm {
/**
* write to a register
*
* @param dev the device to access (XM or G)
* @param reg the register to write to
* @param val the value to write
* @return true if successful, false otherwise