RTOS: Semaphore: Improve API docs

2017-07-11 15:01:33 +01:00 · 2017-07-11 15:01:33 +01:00 · 2963308349
parent 739a429820
commit 2963308349
1 changed files with 4 additions and 1 deletions
--- a/rtos/Semaphore.h
+++ b/rtos/Semaphore.h
@ -58,7 +58,10 @@ public:
    int32_t wait(uint32_t millisec=osWaitForever);

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