Skip to content

Commit 2963308

Browse files
committed
RTOS: Semaphore: Improve API docs
1 parent 739a429 commit 2963308

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

rtos/Semaphore.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,10 @@ class Semaphore : private mbed::NonCopyable<Semaphore> {
5858
int32_t wait(uint32_t millisec=osWaitForever);
5959

6060
/** Release a Semaphore resource that was obtain with Semaphore::wait.
61-
@return status code that indicates the execution status of the function.
61+
@return status code that indicates the execution status of the function:
62+
@a osOK the token has been correctly released.
63+
@a osErrorResource the maximum token count has been reached.
64+
@a osErrorParameter internal error.
6265
*/
6366
osStatus release(void);
6467

0 commit comments

Comments
 (0)