Removed bad \ref tag, but left in the tag name. Updated old param names in gpio_api.h and added new params in ticker_api.h

pull/4508/head
Kevin Gilbert 2017-06-02 16:17:32 -05:00
parent 567589f138
commit 7e2e80588d
3 changed files with 15 additions and 14 deletions

View File

@ -83,30 +83,30 @@ int gpio_read(gpio_t *obj);
/** Init the input pin and set mode to PullDefault
*
* @param obj The GPIO object
* @param pin The pin name
* @param gpio The GPIO object
* @param pin The pin name
*/
void gpio_init_in(gpio_t* gpio, PinName pin);
/** Init the input pin and set the mode
*
* @param obj The GPIO object
* @param pin The pin name
* @param mode The pin mode to be set
* @param gpio The GPIO object
* @param pin The pin name
* @param mode The pin mode to be set
*/
void gpio_init_in_ex(gpio_t* gpio, PinName pin, PinMode mode);
/** Init the output pin as an output, with predefined output value 0
*
* @param obj The GPIO object
* @param pin The pin name
* @return An integer value 1 or 0
* @param gpio The GPIO object
* @param pin The pin name
* @return An integer value 1 or 0
*/
void gpio_init_out(gpio_t* gpio, PinName pin);
/** Init the pin as an output and set the output value
*
* @param obj The GPIO object
* @param gpio The GPIO object
* @param pin The pin name
* @param value The value to be set
*/
@ -114,7 +114,7 @@ void gpio_init_out_ex(gpio_t* gpio, PinName pin, int value);
/** Init the pin to be in/out
*
* @param obj The GPIO object
* @param gpio The GPIO object
* @param pin The pin name
* @param direction The pin direction to be set
* @param mode The pin mode to be set

View File

@ -615,9 +615,9 @@ typedef struct _ARM_DRIVER_STORAGE {
*
* This optional function erases the complete device. If the device does not
* support global erase then the function returns the error value \ref
* ARM_DRIVER_ERROR_UNSUPPORTED. The data field \em 'erase_all' =
* \token{1} of the structure \ref ARM_STORAGE_CAPABILITIES encodes that
* \ref ARM_STORAGE_EraseAll is supported.
* ARM_DRIVER_ERROR_UNSUPPORTED. The data field \em 'erase_all' = 1
* of the structure \ref ARM_STORAGE_CAPABILITIES encodes that
* ARM_STORAGE_EraseAll is supported.
*
* @note This API may execute asynchronously if
* ARM_STORAGE_CAPABILITIES::asynchronous_ops is set. Asynchronous

View File

@ -163,7 +163,8 @@ us_timestamp_t ticker_read_us(const ticker_data_t *const ticker);
/** Read the next event's timestamp
*
* @param ticker The ticker object.
* @param ticker The ticker object.
* @param timestamp The timestamp object.
* @return 1 if timestamp is pending event, 0 if there's no event pending
*/
int ticker_get_next_timestamp(const ticker_data_t *const ticker, timestamp_t *timestamp);