Skip to content

Commit c8f9759

Browse files
author
Melinda Weed
committed
Adding punctuation
1 parent 5cc5e47 commit c8f9759

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

rtos/ConditionVariable.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ struct Waiter;
4343
* threads.
4444
*
4545
* The thread that intends to wait on a ConditionVariable must:
46-
* - Acquire a lock on a mutex
46+
* - Acquire a lock on a mutex.
4747
* - Execute `wait`, `wait_for` or `wait_until`. While the thread is waiting,
4848
* the mutex is unlocked.
4949
* - When the condition variable has been notified, or in the case of `wait_for`
@@ -64,7 +64,7 @@ struct Waiter;
6464
* function.
6565
*
6666
* ### Undefined behavior
67-
* - The thread that is unblocked on ConditionVariable::notify_one is
67+
* - The thread that is unblocked on `ConditionVariable::notify_one` is
6868
* undefined if there are multiple waiters.
6969
* - Calling wait if the mutex is not locked by the current thread is undefined
7070
* behavior.
@@ -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 mutex.
9494
* uint32_t work_count = 0;
9595
* bool done = false;
9696
*
@@ -102,7 +102,7 @@ struct Waiter;
102102
* while (done == false) {
103103
* printf("Worker thread: Count: %lu\r\n", work_count);
104104
*
105-
* // Wait for main thread to notify the condition variable
105+
* // Wait for main thread to notify the condition variable.
106106
* printf("Worker thread: Waiting\r\n");
107107
* cv.wait();
108108
* }
@@ -169,7 +169,7 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
169169
* been met.
170170
*
171171
* @note - The current thread releases the lock while inside the wait
172-
* function and reacquire it upon exiting the function.
172+
* function and reacquires it upon exiting the function.
173173
*
174174
* Example:
175175
* @code
@@ -229,7 +229,7 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
229229
*/
230230
bool wait_until(uint64_t millisec);
231231

232-
/** Wait for a notification or timeout
232+
/** Wait for a notification or timeout.
233233
*
234234
* `Wait for` causes the current thread to block until the condition
235235
* variable receives a notification from another thread, or the timeout
@@ -301,7 +301,7 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
301301
*/
302302
void notify_all();
303303

304-
/** ConditionVariable destructor
304+
/** ConditionVariable destructor.
305305
*
306306
* @note You cannot call this function from ISR context.
307307
*/

0 commit comments

Comments
 (0)