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

@ -302,7 +302,7 @@ extern "C" {
*
* @param dev Device context.
* @param pin GPIO pin to use as the interrupt pin.
* @param fptr Pointer to a function to be called on interrupt.
* @param isr Pointer to a function to be called on interrupt.
* @param arg Pointer to an object to be supplied as an
* argument to the ISR.
* @return UPM result.

View File

@ -63,7 +63,7 @@ namespace upm {
* MCP2515 constructor.
*
* @param bus spi bus to use
* @param cs_pin The GPIO pin to use for Chip Select (CS). Pass
* @param csPin The GPIO pin to use for Chip Select (CS). Pass
* pass -1 if your CS is handled automatically by your SPI
* implementation (Edison).
*/
@ -335,7 +335,7 @@ namespace upm {
* an interrupt occurs.
*
* @param pin GPIO pin to use as the interrupt pin.
* @param fptr Pointer to a function to be called on interrupt.
* @param isr Pointer to a function to be called on interrupt.
* @param arg Pointer to an object to be supplied as an
* argument to the ISR.
*/