@@ -54,7 +54,7 @@ typedef mbed::ScopedLock<Mutex> ScopedMutexLock;
54
54
*/
55
55
56
56
/* * The Mutex class is used to synchronize the execution of threads.
57
- This is for example used to protect access to a shared resource.
57
+ This is, for example, used to protect access to a shared resource.
58
58
59
59
@note You cannot use member functions of this class in ISR context. If you require Mutex functionality within
60
60
ISR handler, consider using @a Semaphore.
@@ -82,7 +82,7 @@ class Mutex : private mbed::NonCopyable<Mutex> {
82
82
Wait until a Mutex becomes available.
83
83
84
84
@return status code that indicates the execution status of the function:
85
- @a osOK the mutex has been obtained.
85
+ @a Status code like osOK indicates that the mutex has been obtained.
86
86
87
87
@note You cannot call this function from ISR context.
88
88
@note This function treats RTOS errors as fatal system errors, so can only return osOK.
@@ -91,10 +91,10 @@ class Mutex : private mbed::NonCopyable<Mutex> {
91
91
osStatus lock (void );
92
92
93
93
/* *
94
- For backwards compatibility.
94
+ Wait until a Mutex becomes available.
95
+
95
96
@deprecated Do not use this function. This function has been replaced with lock(), trylock() and trylock_for() functions.
96
97
97
- Wait until a Mutex becomes available.
98
98
@param millisec timeout value or 0 in case of no time-out.
99
99
@return status code that indicates the execution status of the function:
100
100
@a osOK the mutex has been obtained.
@@ -144,7 +144,7 @@ class Mutex : private mbed::NonCopyable<Mutex> {
144
144
Unlock the mutex that has previously been locked by the same thread
145
145
146
146
@return status code that indicates the execution status of the function:
147
- @a osOK the mutex has been released.
147
+ @a Status code like osOK indicates that the mutex has been released.
148
148
149
149
@note You cannot call this function from ISR context.
150
150
@note This function treats RTOS errors as fatal system errors, so can only return osOK.
0 commit comments