Skip to content

Commit 6085c0d

Browse files
committed
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
1 parent 92fc508 commit 6085c0d

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

hal/gpio_api.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -83,38 +83,38 @@ int gpio_read(gpio_t *obj);
8383

8484
/** Init the input pin and set mode to PullDefault
8585
*
86-
* @param obj The GPIO object
87-
* @param pin The pin name
86+
* @param gpio The GPIO object
87+
* @param pin The pin name
8888
*/
8989
void gpio_init_in(gpio_t* gpio, PinName pin);
9090

9191
/** Init the input pin and set the mode
9292
*
93-
* @param obj The GPIO object
94-
* @param pin The pin name
95-
* @param mode The pin mode to be set
93+
* @param gpio The GPIO object
94+
* @param pin The pin name
95+
* @param mode The pin mode to be set
9696
*/
9797
void gpio_init_in_ex(gpio_t* gpio, PinName pin, PinMode mode);
9898

9999
/** Init the output pin as an output, with predefined output value 0
100100
*
101-
* @param obj The GPIO object
102-
* @param pin The pin name
103-
* @return An integer value 1 or 0
101+
* @param gpio The GPIO object
102+
* @param pin The pin name
103+
* @return An integer value 1 or 0
104104
*/
105105
void gpio_init_out(gpio_t* gpio, PinName pin);
106106

107107
/** Init the pin as an output and set the output value
108108
*
109-
* @param obj The GPIO object
109+
* @param gpio The GPIO object
110110
* @param pin The pin name
111111
* @param value The value to be set
112112
*/
113113
void gpio_init_out_ex(gpio_t* gpio, PinName pin, int value);
114114

115115
/** Init the pin to be in/out
116116
*
117-
* @param obj The GPIO object
117+
* @param gpio The GPIO object
118118
* @param pin The pin name
119119
* @param direction The pin direction to be set
120120
* @param mode The pin mode to be set

hal/storage_abstraction/Driver_Storage.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -615,9 +615,9 @@ typedef struct _ARM_DRIVER_STORAGE {
615615
*
616616
* This optional function erases the complete device. If the device does not
617617
* support global erase then the function returns the error value \ref
618-
* ARM_DRIVER_ERROR_UNSUPPORTED. The data field \em 'erase_all' =
619-
* \token{1} of the structure \ref ARM_STORAGE_CAPABILITIES encodes that
620-
* \ref ARM_STORAGE_EraseAll is supported.
618+
* ARM_DRIVER_ERROR_UNSUPPORTED. The data field \em 'erase_all' = 1
619+
* of the structure \ref ARM_STORAGE_CAPABILITIES encodes that
620+
* ARM_STORAGE_EraseAll is supported.
621621
*
622622
* @note This API may execute asynchronously if
623623
* ARM_STORAGE_CAPABILITIES::asynchronous_ops is set. Asynchronous

hal/ticker_api.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,8 @@ us_timestamp_t ticker_read_us(const ticker_data_t *const ticker);
163163

164164
/** Read the next event's timestamp
165165
*
166-
* @param ticker The ticker object.
166+
* @param ticker The ticker object.
167+
* @param timestamp The timestamp object.
167168
* @return 1 if timestamp is pending event, 0 if there's no event pending
168169
*/
169170
int ticker_get_next_timestamp(const ticker_data_t *const ticker, timestamp_t *timestamp);

0 commit comments

Comments
 (0)