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

@ -558,7 +558,7 @@ extern "C" {
* interrupts if they are enabled.
*
* @param dev The device context.
* @param a bitmask of INT_STA_BITS_T bits to set in the interrupt
* @param mask A bitmask of INT_STA_BITS_T bits to set in the interrupt
* mask register.
*/
void bno055_set_interrupt_mask(const bno055_context dev, uint8_t mask);

View File

@ -261,7 +261,7 @@ namespace upm {
* Write previously saved calibration data to the calibration
* registers.
*
* @param calibData A vector of uint8_t (bytes) representing
* @param calibrationData A vector of uint8_t (bytes) representing
* calibration data as returned by readCalibrationData().
* It's length must always be exactly BNO055_CALIBRATION_DATA_SIZE.
* @throws std::length_error if the vector size is not equal to
@ -572,7 +572,7 @@ namespace upm {
* interrupt. The interrupt status register can still be used
* to detect masked interrupts if they are enabled.
*
* @param a bitmask of BNO055_INT_STA_BITS_T bits to set in
* @param mask A bitmask of BNO055_INT_STA_BITS_T bits to set in
* the interrupt mask register.
*/
void setInterruptMask(uint8_t mask);