Skip to content

Commit bbc6e5d

Browse files
author
Amanda Butler
authored
Edit Mutex.h
Make minor copy edits to existing text.
1 parent b993eb9 commit bbc6e5d

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

rtos/Mutex.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ typedef mbed::ScopedLock<Mutex> ScopedMutexLock;
6060
ISR handler, consider using @a Semaphore.
6161
6262
@note
63-
Memory considerations: The mutex control structures will be created on current thread's stack, both for the Mbed OS
63+
Memory considerations: The mutex control structures are created on the current thread's stack, both for the Mbed OS
6464
and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
6565
*/
6666
class Mutex : private mbed::NonCopyable<Mutex> {
@@ -85,7 +85,7 @@ class Mutex : private mbed::NonCopyable<Mutex> {
8585
@a osOK the mutex has been obtained.
8686
8787
@note You cannot call this function from ISR context.
88-
@note This function treats RTOS errors as fatal system errors, so can only return osOK.
88+
@note This function treats RTOS errors as fatal system errors, so it can only return osOK.
8989
Use of the return value is deprecated, as the return is expected to become void in the future.
9090
*/
9191
osStatus lock(void);
@@ -102,7 +102,7 @@ class Mutex : private mbed::NonCopyable<Mutex> {
102102
@a osErrorResource the mutex could not be obtained when no timeout was specified.
103103
104104
@note You cannot call this function from ISR context.
105-
@note This function treats RTOS errors as fatal system errors, so can only return osOK or
105+
@note This function treats RTOS errors as fatal system errors, so it can only return osOK or
106106
osErrorResource in case when millisec is 0 or osErrorTimeout if millisec is not osWaitForever.
107107
*/
108108
MBED_DEPRECATED_SINCE("mbed-os-5.10.0", "Replaced with lock(), trylock() and trylock_for() functions")
@@ -147,7 +147,7 @@ class Mutex : private mbed::NonCopyable<Mutex> {
147147
@a osOK the mutex has been released.
148148
149149
@note You cannot call this function from ISR context.
150-
@note This function treats RTOS errors as fatal system errors, so can only return osOK.
150+
@note This function treats RTOS errors as fatal system errors, so it can only return osOK.
151151
Use of the return value is deprecated, as the return is expected to become void in the future.
152152
*/
153153
osStatus unlock();

0 commit comments

Comments
 (0)