Skip to content

Commit 98e6d53

Browse files
author
Melinda Weed
committed
Capitalization, header level adjustment
1 parent c8f9759 commit 98e6d53

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

rtos/ConditionVariable.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ struct Waiter;
5353
* - Acquire a lock on the mutex used to construct the condition variable.
5454
* - Execute `notify_one` or `notify_all` on the condition variable.
5555
*
56-
* ### Defined behavior
56+
* #### Defined behavior
5757
* - All threads waiting on the condition variable wake when
5858
* `ConditionVariable::notify_all` is called.
5959
* - At least one thread waiting on the condition variable wakes
@@ -63,18 +63,18 @@ struct Waiter;
6363
* - The ConditionVariable reacquires the mutex lock before exiting the wait
6464
* function.
6565
*
66-
* ### Undefined behavior
66+
* #### Undefined behavior
6767
* - 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.
7171
* - The order in which waiting threads acquire the condition variable's
72-
* mutex after ConditionVariable::notify_all is called is undefined.
73-
* - When ConditionVariable::notify_one or ConditionVariable::notify_all is
72+
* mutex after `ConditionVariable::notify_all` is called is undefined.
73+
* - When `ConditionVariable::notify_one` or `ConditionVariable::notify_all` is
7474
* called and there are one or more waiters, and one or more threads
7575
* attempting to acquire the condition variable's mutex, the order in which the mutex is
7676
* acquired is undefined.
77-
* - The behavior of ConditionVariable::wait and ConditionVariable::wait_for
77+
* - The behavior of `ConditionVariable::wait` and `ConditionVariable::wait_for`
7878
* is undefined if the condition variable's mutex is locked more than once by
7979
* the calling thread.
8080
* - Spurious notifications (not triggered by the application) can occur,
@@ -194,8 +194,8 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
194194
* variable is notified, or a specific time given by millisec parameter is
195195
* reached.
196196
*
197-
* @param millisec absolute end time referenced to Kernel::get_ms_count()
198-
* @return true if a timeout occurred, false otherwise.
197+
* @param millisec Absolute end time referenced to `Kernel::get_ms_count()`
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.
@@ -205,7 +205,7 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
205205
* been met.
206206
*
207207
* @note - The current thread releases the lock while inside the wait
208-
* function and reacquire it upon exiting the function.
208+
* function and reacquires it upon exiting the function.
209209
*
210210
* Example:
211211
* @code
@@ -235,8 +235,8 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
235235
* variable receives a notification from another thread, or the timeout
236236
* specified by the millisec parameter is reached.
237237
*
238-
* @param millisec timeout value or osWaitForever in case of no timeout.
239-
* @return true if a timeout occurred, false otherwise.
238+
* @param millisec Timeout value or osWaitForever in case of no timeout.
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)