ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

mutex doc changes

pull/8391/head
Aashish chaddha 2018-10-12 10:51:38 -05:00
parent 24054ec723
commit b993eb9d3d
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
rtos/Mutex.h
View File

@ -82,7 +82,7 @@ public:
Wait until a Mutex becomes available. Wait until a Mutex becomes available.
@return status code that indicates the execution status of the function: @return status code that indicates the execution status of the function:
@a Status code such as osOK indicates that the mutex has been obtained. @a osOK the mutex has been obtained.
@note You cannot call this function from ISR context. @note You cannot call this function from ISR context.
@note This function treats RTOS errors as fatal system errors, so can only return osOK. @note This function treats RTOS errors as fatal system errors, so can only return osOK.
@ -144,7 +144,7 @@ public:
Unlock the mutex that has previously been locked by the same thread Unlock the mutex that has previously been locked by the same thread
@return status code that indicates the execution status of the function: @return status code that indicates the execution status of the function:
@a Status code such as osOK indicates that the mutex has been released. @a osOK the mutex has been released.
@note You cannot call this function from ISR context. @note You cannot call this function from ISR context.
@note This function treats RTOS errors as fatal system errors, so can only return osOK. @note This function treats RTOS errors as fatal system errors, so can only return osOK.