Skip to content

Commit 0d772db

Browse files
author
Amanda Butler
authored
Copy edit Mutex.h
Copy edit file for active voice.
1 parent 4a3c9ef commit 0d772db

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

rtos/Mutex.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ namespace rtos {
4040
/** The Mutex class is used to synchronize the execution of threads.
4141
This is for example used to protect access to a shared resource.
4242
43-
@note Member functions of this class cannot be used in ISR context. If you require Mutex functionality within
44-
ISR handler consider using @a Semaphore.
43+
@note You cannot use member functions of this class in ISR context. If you require Mutex functionality within
44+
ISR handler, consider using @a Semaphore.
4545
4646
@note
4747
Memory considerations: The mutex control structures will be created on current thread's stack, both for the mbed OS
@@ -51,15 +51,15 @@ class Mutex : private mbed::NonCopyable<Mutex> {
5151
public:
5252
/** Create and Initialize a Mutex object
5353
*
54-
* @note This function cannot be called from ISR context.
54+
* @note You cannot call this function from ISR context.
5555
*/
5656
Mutex();
5757

5858
/** Create and Initialize a Mutex object
5959
6060
@param name name to be used for this mutex. It has to stay allocated for the lifetime of the thread.
6161
62-
@note This function cannot be called from ISR context.
62+
@note You cannot call this function from ISR context.
6363
*/
6464
Mutex(const char *name);
6565

@@ -72,7 +72,7 @@ class Mutex : private mbed::NonCopyable<Mutex> {
7272
@a osErrorResource the mutex could not be obtained when no timeout was specified.
7373
@a osErrorISR this function cannot be called from the interrupt service routine.
7474
75-
@note This function cannot be called from ISR context.
75+
@note You cannot call this function from ISR context.
7676
*/
7777
osStatus lock(uint32_t millisec=osWaitForever);
7878

@@ -97,13 +97,13 @@ class Mutex : private mbed::NonCopyable<Mutex> {
9797
/** Get the owner the this mutex
9898
@return the current owner of this mutex.
9999
100-
@note This function cannot be called from ISR context.
100+
@note You cannot call this function from ISR context.
101101
*/
102102
osThreadId get_owner();
103103

104104
/** Mutex destructor
105105
*
106-
* @note This function cannot be called from ISR context.
106+
* @note You cannot call this function from ISR context.
107107
*/
108108
~Mutex();
109109

0 commit comments

Comments
 (0)