Skip to content

Commit 377be71

Browse files
Mel WCruz Monrreal II
authored andcommitted
True -> true, inserting article
1 parent 8bae0b1 commit 377be71

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

rtos/ConditionVariable.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ struct Waiter;
9090
* Mutex mutex;
9191
* ConditionVariable cv(mutex);
9292
*
93-
* // These variables are protected by locking mutex.
93+
* // These variables are protected by locking the mutex.
9494
* uint32_t work_count = 0;
9595
* bool done = false;
9696
*
@@ -123,7 +123,7 @@ struct Waiter;
123123
* // Acquire lock on mutex before modifying variables and notifying.
124124
* mutex.lock();
125125
*
126-
* // Change count and notify waiters of this.
126+
* // Change count and notify waiters.
127127
* work_count++;
128128
* printf("Main thread: Set count to: %lu\r\n", work_count);
129129
* printf("Main thread: Notifying worker thread\r\n");
@@ -195,7 +195,7 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
195195
* reached.
196196
*
197197
* @param millisec Absolute end time referenced to `Kernel::get_ms_count()`
198-
* @return True if a timeout occurred, false otherwise.
198+
* @return `true` if a timeout occurred, `false` otherwise.
199199
*
200200
* @note - The thread calling this function must be the owner of the
201201
* ConditionVariable's mutex, and it must be locked exactly once.
@@ -236,7 +236,7 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
236236
* specified by the millisec parameter is reached.
237237
*
238238
* @param millisec Timeout value or osWaitForever in case of no timeout.
239-
* @return True if a timeout occurred, false otherwise.
239+
* @return `true` if a timeout occurred, `false` otherwise.
240240
*
241241
* @note - The thread calling this function must be the owner of the
242242
* ConditionVariable's mutex, and it must be locked exactly once.

0 commit comments

Comments
 (0)