File tree Expand file tree Collapse file tree 1 file changed +12
-4
lines changed Expand file tree Collapse file tree 1 file changed +12
-4
lines changed Original file line number Diff line number Diff line change @@ -131,13 +131,21 @@ class RtosTimer : private mbed::NonCopyable<RtosTimer> {
131
131
}
132
132
133
133
/* * Stop the timer.
134
- @return status code that indicates the execution status of the function.
134
+ @return status code that indicates the execution status of the function:
135
+ @a osOK the timer has been stopped.
136
+ @a osErrorISR @a stop cannot be called from interrupt service routines.
137
+ @a osErrorParameter internal error.
138
+ @a osErrorResource the timer is not running.
135
139
*/
136
140
osStatus stop (void );
137
141
138
- /* * Start the timer.
139
- @param millisec time delay value of the timer.
140
- @return status code that indicates the execution status of the function.
142
+ /* * Start or restart the timer.
143
+ @param millisec non-zero value of the timer.
144
+ @return status code that indicates the execution status of the function:
145
+ @a osOK the timer has been started or restarted.
146
+ @a osErrorISR @a start cannot be called from interrupt service routines.
147
+ @a osErrorParameter internal error or incorrect parameter value.
148
+ @a osErrorResource internal error (the timer is in an invalid timer state).
141
149
*/
142
150
osStatus start (uint32_t millisec);
143
151
You can’t perform that action at this time.
0 commit comments