Copy edit Mutex.h

Copy edit file for active voice.
pull/5760/head
Amanda Butler 2018-01-08 17:46:08 -06:00 committed by GitHub
parent 4a3c9ef566
commit 0d772db6ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions

View File

@ -40,8 +40,8 @@ namespace rtos {
/** The Mutex class is used to synchronize the execution of threads. /** The Mutex class is used to synchronize the execution of threads.
This is for example used to protect access to a shared resource. This is for example used to protect access to a shared resource.
@note Member functions of this class cannot be used in ISR context. If you require Mutex functionality within @note You cannot use member functions of this class in ISR context. If you require Mutex functionality within
ISR handler consider using @a Semaphore. ISR handler, consider using @a Semaphore.
@note @note
Memory considerations: The mutex control structures will be created on current thread's stack, both for the mbed OS Memory considerations: The mutex control structures will be created on current thread's stack, both for the mbed OS
@ -51,7 +51,7 @@ class Mutex : private mbed::NonCopyable<Mutex> {
public: public:
/** Create and Initialize a Mutex object /** Create and Initialize a Mutex object
* *
* @note This function cannot be called from ISR context. * @note You cannot call this function from ISR context.
*/ */
Mutex(); Mutex();
@ -59,7 +59,7 @@ public:
@param name name to be used for this mutex. It has to stay allocated for the lifetime of the thread. @param name name to be used for this mutex. It has to stay allocated for the lifetime of the thread.
@note This function cannot be called from ISR context. @note You cannot call this function from ISR context.
*/ */
Mutex(const char *name); Mutex(const char *name);
@ -72,7 +72,7 @@ public:
@a osErrorResource the mutex could not be obtained when no timeout was specified. @a osErrorResource the mutex could not be obtained when no timeout was specified.
@a osErrorISR this function cannot be called from the interrupt service routine. @a osErrorISR this function cannot be called from the interrupt service routine.
@note This function cannot be called from ISR context. @note You cannot call this function from ISR context.
*/ */
osStatus lock(uint32_t millisec=osWaitForever); osStatus lock(uint32_t millisec=osWaitForever);
@ -97,13 +97,13 @@ public:
/** Get the owner the this mutex /** Get the owner the this mutex
@return the current owner of this mutex. @return the current owner of this mutex.
@note This function cannot be called from ISR context. @note You cannot call this function from ISR context.
*/ */
osThreadId get_owner(); osThreadId get_owner();
/** Mutex destructor /** Mutex destructor
* *
* @note This function cannot be called from ISR context. * @note You cannot call this function from ISR context.
*/ */
~Mutex(); ~Mutex();