Commit Graph

14 Commits (mbed-os-5.10)

Author SHA1 Message Date
Cruz Monrreal II 4a14db53b2 Make variables that are private in ConditionVariable.h, protected Paritally reverts docs PR 8511 2018-11-04 22:07:06 -06:00
Mel W cecd96f4f1 Breaking behaviors into two sections
as per @kjbracey-arm review
2018-11-04 22:06:11 -06:00
Mel W 377be71ca7 True -> `true`, inserting article 2018-11-04 22:06:10 -06:00
Melinda Weed 68081acb62 Capitalization, header level adjustment 2018-11-02 19:49:57 -05:00
Melinda Weed 9de93a19ee Adding punctuation 2018-11-02 19:49:57 -05:00
Melinda Weed e4acfe277b future to present tense 2018-11-02 19:49:57 -05:00
Amanda Butler 850cbb39ff Copy edit ConditionVariable.h
Copy edit file, including existing text.
2018-11-02 19:49:57 -05:00
Steve Cartmell 35bac5c5b9 docs(api-condvar): Update documentation for the ConditionVariable API
- Hide protected member structures from doxygen.
- Add some more details/comments to the example.
- Add some defined/undefined behaviours.
- Add some additional details to function documentation
2018-11-02 19:49:57 -05:00
Kevin Bracey bbefeb4432 Add ConditionVariable::wait_until
Given the 64-bit timebase, add wait_until to ConditionVariable.

Move the timeout example to wait_until(), and give wait_for() an
alternative example, as it's no longer the best option for a
timeout.

Tidy up - remove the redundant RESUME_SIGNAL definition.
2018-01-29 15:26:41 +02:00
Kevin Bracey 3bb2c445ca Correct ConditionVariable ISR comments
No ConditionVariable methods are useable from ISR, due to the built-in
mutex and the requirement that the caller of notify holds the mutex.
2018-01-29 15:26:41 +02:00
Amanda Butler c23709c60a
Copy edit ConditionVariable.h
Copy edit docs changes for active voice.
2018-01-08 17:36:24 -06:00
Bartek Szatkowski 71555a984d Add notes about ISR safety to RTOS doxygen 2017-12-27 14:46:49 +00:00
Russ Butler 93cf15d57c Fix and add test for ConditionVariable
Fix the circular linked list handling in ConditionVariable and add a
test to validate the linked list implementation.
2017-11-15 16:15:27 -06:00
Russ Butler 0c4e50abb3 Add ConditionVariable to mbed rtos
Add the ConditionVariable class to mbed rtos to provide easier and
safer synchronization.
2017-11-02 21:02:27 -05:00