Skip to content

Commit 8f17560

Browse files
author
Amanda Butler
authored
Copy edit ScopedLock.h
Copy edit document for active voice, present tense and consistent comma use.
1 parent cde5196 commit 8f17560

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

platform/ScopedLock.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ namespace mbed {
3131
*
3232
* @tparam Lockable The type implementing BasicLockable concept
3333
*
34-
* @note For type Lockable to be BasicLockable the following conditions have to be satisfied:
34+
* @note For type Lockable to be BasicLockable, the following conditions have to be satisfied:
3535
* - has public member function @a lock which blocks until a lock can be obtained for the current execution context
3636
* - has public member function @a unlock which releases the lock
3737
*
@@ -42,7 +42,7 @@ namespace mbed {
4242
* @code
4343
* void foo(Mutex &m) {
4444
* ScopedLock<Mutex> lock(m);
45-
* // Code in this block will be protected by Mutex lock
45+
* // Mutex lock protects code in this block
4646
* }
4747
* @endcode
4848
*
@@ -53,7 +53,7 @@ namespace mbed {
5353
* template<typename Lockable>
5454
* void foo(Lockable& lockable) {
5555
* ScopedLock<Lockable> lock(lockable);
56-
* // Code in this block will run under lock
56+
* // Code in this block runs under lock
5757
* }
5858
* @endcode
5959
*/

0 commit comments

Comments
 (0)