@@ -31,8 +31,8 @@ extern "C" {
31
31
* Low level interface to the microsecond ticker of a target
32
32
*
33
33
* # Defined behavior
34
- * * Has a reported frequency between 250KHz and 8MHz
35
- * * Has a counter that is at least 16 bits wide
34
+ * * Has a reported frequency between 250KHz and 8MHz - Verified by test ::us_ticker_info_test
35
+ * * Has a counter that is at least 16 bits wide - Verified by test ::us_ticker_info_test
36
36
* * All behavior defined by the @ref hal_ticker_shared "ticker specification"
37
37
*
38
38
* # Undefined behavior
@@ -80,9 +80,10 @@ extern "C" {
80
80
* * Calling ticker_set_interrupt with a value that has more than the supported number of bits
81
81
*
82
82
* # Potential bugs
83
- * * Drift due to reschedule - Verified by ::ticker_reschedule_test
83
+ * * Drift due to reschedule - Verified by ::ticker_repeat_reschedule_test
84
84
* * Incorrect overflow handling of timers - Verified by ::ticker_overflow_test
85
85
* * Interrupting at a time of 0 - Verified by ::ticker_overflow_test
86
+ * * Interrupt triggered more than once - Verified by ::ticker_interrupt_test
86
87
*
87
88
* @ingroup hal_us_ticker
88
89
* @ingroup hal_lp_ticker
@@ -109,7 +110,7 @@ typedef void (*ticker_irq_handler_type)(const ticker_data_t *const);
109
110
*
110
111
* @return previous ticker IRQ handler
111
112
*
112
- * @note by default IRQ handler is set to ticker_irq_handler()
113
+ * @note by default IRQ handler is set to :: ticker_irq_handler
113
114
* @note this function is primarily for testing purposes and it's not required part of HAL implementation
114
115
*
115
116
*/
@@ -163,7 +164,7 @@ void us_ticker_init(void);
163
164
/** Read the current tick
164
165
*
165
166
* Read the current counter value without performing frequency conversions.
166
- * If no rollover has occurred, the seconds passed since :: us_ticker_init
167
+ * If no rollover has occurred, the seconds passed since us_ticker_init()
167
168
* was called can be found by dividing the ticks returned by this function
168
169
* by the frequency returned by ::us_ticker_get_info.
169
170
*
@@ -185,7 +186,7 @@ uint32_t us_ticker_read(void);
185
186
*
186
187
* @note no special handling needs to be done for times in the past
187
188
* as the common timer code will detect this and call
188
- * :: us_ticker_fire_interrupt if this is the case
189
+ * us_ticker_fire_interrupt() if this is the case
189
190
*
190
191
* @note calling this function with timestamp of more than the supported
191
192
* number of bits returned by ::us_ticker_get_info results in undefined
0 commit comments