Skip to content

Commit 4b0cf63

Browse files
committed
RTOS: RtosTimer: Improve API docs
1 parent 99a8467 commit 4b0cf63

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

rtos/RtosTimer.h

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,13 +131,21 @@ class RtosTimer : private mbed::NonCopyable<RtosTimer> {
131131
}
132132

133133
/** 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.
135139
*/
136140
osStatus stop(void);
137141

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).
141149
*/
142150
osStatus start(uint32_t millisec);
143151

0 commit comments

Comments
 (0)