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

@ -354,7 +354,7 @@ extern "C" {
* pin. See the datasheet for details.
*
* @param dev The device context.
* @param A bitmask of BMA250E_INT_MAP_0_BITS_T bits.
* @param bits A bitmask of BMA250E_INT_MAP_0_BITS_T bits.
* @return UPM result.
*/
upm_result_t bma250e_set_interrupt_map0(const bma250e_context dev,
@ -374,7 +374,7 @@ extern "C" {
* details.
*
* @param dev The device context.
* @param A bitmask of BMA250E_INT_MAP_1_BITS_T bits.
* @param bits A bitmask of BMA250E_INT_MAP_1_BITS_T bits.
* @return UPM result.
*/
upm_result_t bma250e_set_interrupt_map1(const bma250e_context dev,
@ -394,7 +394,7 @@ extern "C" {
* details.
*
* @param dev The device context.
* @param A bitmask of BMA250E_INT_MAP_2_BITS_T bits.
* @param bits A bitmask of BMA250E_INT_MAP_2_BITS_T bits.
* @return UPM result.
*/
upm_result_t bma250e_set_interrupt_map2(const bma250e_context dev,

View File

@ -327,7 +327,7 @@ namespace upm {
* to map specific interrupts to the interrupt 1 or interrupt 2
* pin. See the datasheet for details.
*
* @param A bitmask of BMA250E_INT_MAP_0_BITS_T bits.
* @param bits A bitmask of BMA250E_INT_MAP_0_BITS_T bits.
* @throws std::runtime_error on failure.
*/
void setInterruptMap0(uint8_t bits);
@ -344,7 +344,7 @@ namespace upm {
* Set the Interrupt Map 1 register. See the datasheet for
* details.
*
* @param A bitmask of BMA250E_INT_MAP_1_BITS_T bits.
* @param bits A bitmask of BMA250E_INT_MAP_1_BITS_T bits.
* @throws std::runtime_error on failure.
*/
void setInterruptMap1(uint8_t bits);
@ -361,7 +361,7 @@ namespace upm {
* Set the Interrupt Map 2 register. See the datasheet for
* details.
*
* @param A bitmask of BMA250E_INT_MAP_2_BITS_T bits.
* @param bits A bitmask of BMA250E_INT_MAP_2_BITS_T bits.
* @throws std::runtime_error on failure.
*/
void setInterruptMap2(uint8_t bits);