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

Copy edit ScopedLock.h 

Copy edit document for active voice, present tense and consistent comma use.
pull/5852/head
Amanda Butler 2018-01-17 16:56:28 -06:00 committed by GitHub
parent cde5196170
commit 8f175609ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
platform/ScopedLock.h
View File

@ -31,7 +31,7 @@ namespace mbed {
* *
* @tparam Lockable The type implementing BasicLockable concept * @tparam Lockable The type implementing BasicLockable concept
* *
* @note For type Lockable to be BasicLockable the following conditions have to be satisfied: * @note For type Lockable to be BasicLockable, the following conditions have to be satisfied:
* - has public member function @a lock which blocks until a lock can be obtained for the current execution context * - has public member function @a lock which blocks until a lock can be obtained for the current execution context
* - has public member function @a unlock which releases the lock * - has public member function @a unlock which releases the lock
* *
@ -42,7 +42,7 @@ namespace mbed {
* @code * @code
* void foo(Mutex &m) { * void foo(Mutex &m) {
* ScopedLock<Mutex> lock(m); * ScopedLock<Mutex> lock(m);
* // Code in this block will be protected by Mutex lock * // Mutex lock protects code in this block
* } * }
* @endcode * @endcode
* *
@ -53,7 +53,7 @@ namespace mbed {
* template<typename Lockable> * template<typename Lockable>
* void foo(Lockable& lockable) { * void foo(Lockable& lockable) {
* ScopedLock<Lockable> lock(lockable); * ScopedLock<Lockable> lock(lockable);
* // Code in this block will run under lock * // Code in this block runs under lock
* } * }
* @endcode * @endcode
*/ */