@@ -53,7 +53,7 @@ struct Waiter;
53
53
* - Acquire a lock on the mutex used to construct the condition variable.
54
54
* - Execute `notify_one` or `notify_all` on the condition variable.
55
55
*
56
- * ### Defined behavior
56
+ * #### Defined behavior
57
57
* - All threads waiting on the condition variable wake when
58
58
* `ConditionVariable::notify_all` is called.
59
59
* - At least one thread waiting on the condition variable wakes
@@ -63,18 +63,18 @@ struct Waiter;
63
63
* - The ConditionVariable reacquires the mutex lock before exiting the wait
64
64
* function.
65
65
*
66
- * ### Undefined behavior
66
+ * #### Undefined behavior
67
67
* - The thread that is unblocked on `ConditionVariable::notify_one` is
68
68
* undefined if there are multiple waiters.
69
69
* - Calling wait if the mutex is not locked by the current thread is undefined
70
70
* behavior.
71
71
* - 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
74
74
* called and there are one or more waiters, and one or more threads
75
75
* attempting to acquire the condition variable's mutex, the order in which the mutex is
76
76
* acquired is undefined.
77
- * - The behavior of ConditionVariable::wait and ConditionVariable::wait_for
77
+ * - The behavior of ` ConditionVariable::wait` and ` ConditionVariable::wait_for`
78
78
* is undefined if the condition variable's mutex is locked more than once by
79
79
* the calling thread.
80
80
* - Spurious notifications (not triggered by the application) can occur,
@@ -194,8 +194,8 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
194
194
* variable is notified, or a specific time given by millisec parameter is
195
195
* reached.
196
196
*
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.
199
199
*
200
200
* @note - The thread calling this function must be the owner of the
201
201
* ConditionVariable's mutex, and it must be locked exactly once.
@@ -205,7 +205,7 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
205
205
* been met.
206
206
*
207
207
* @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.
209
209
*
210
210
* Example:
211
211
* @code
@@ -235,8 +235,8 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
235
235
* variable receives a notification from another thread, or the timeout
236
236
* specified by the millisec parameter is reached.
237
237
*
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.
240
240
*
241
241
* @note - The thread calling this function must be the owner of the
242
242
* ConditionVariable's mutex, and it must be locked exactly once.
0 commit comments