Add documentation for the ConditionVariable class #318
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a description and example for the ConditionVariable class.
|
This should go into 5.7 as it is a new feature. Once ARMmbed/mbed-os#3648 is merged and dthe doxygen is available I'll update this to include the class reference. |
sg-
reviewed
Oct 28, 2017
|
Will do. I held off on creating an example because this change isn't in mbed-os yet. @sg- can the example use master of mbed-os or does it need to be fixed to a release? If it needs to be on a release I won't be able to add an importable example until 5.7. |
Make minor copy edits.
|
It should be from a release so staging all this until 5.7 shouldn't be a problem. |
sg-
approved these changes
Nov 1, 2017
Add API reference.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a description and example for the ConditionVariable class.