Add documentation for static events/queue #1147
Merged
Conversation
This file contains 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
maciejbocianski
force-pushed
the
static_allocation_event
branch
from
99341ad to
75ef998
Compare
added 3 commits
September 3, 2019 13:45
Edit new section for precise language and to fix typos.
Edit new section, mostly for inclusion of articles and precise language.
Edit file, mostly for clarity.
|
Updated example link |
|
@AnotherButler |
jamesbeyond
changed the title
jamesbeyond
reviewed
Sep 4, 2019
docs/api/rtos/EventQueue.md
Outdated
| @@ -57,6 +57,12 @@ To do this, set the `mbed_app.json` configuration option `events.shared-dispatch | |||
|
|
|||
| [](https://os.mbed.com/teams/mbed_example/code/Shared_Events_2/file/154179bdc39d/main.cpp) | |||
|
|
|||
| ## Static EventQueue example: posting user allocated events to the static queue | |||
|
|
|||
| Use static EventQueue to prevent your program failing due to queue memory exhaustion or to prevent dynamic memory allocation: | |||
There was a problem hiding this comment.
shouldn't it be prevent your program from failing ?
docs/api/rtos/UserAllocatedEvent.md
Outdated
|
|
||
| ## UserAllocatedEvent class reference | ||
|
|
||
| [](https://os.mbed.com/docs/development/mbed-os-api-doxy/_event_8h_source.html) |
There was a problem hiding this comment.
Why this link still goes to the Event class in doxygen, should this be to UserAllocatedEvent class ?
added 2 commits
September 4, 2019 10:59
Add missing word, as requested in comments.
Point link to correct class, as requested in comments.
|
@jamesbeyond Good catches 👍 Does that look better? |
jamesbeyond
approved these changes
Sep 4, 2019
|
As soon as the example is approved and merged, I'll merge this PR. |
added 3 commits
September 5, 2019 10:15
Fix broken link.
Fix broken link.
Fix broken link.
AnotherButler
approved these changes
Sep 5, 2019
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.
This PR contains documentation update to cover new features of EventQueue and UserAllocatedEvent classes (PR with the implementation ARMmbed/mbed-os#11342)
PR with code example ARMmbed/mbed-os-examples-docs_only#52