doc: Fix sys_mutex and futex missing documentation #31855
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
laurenmurphyx64
requested review from
andyross,
carlescufi,
galak and
MaureenHelm
as code owners
Adds API reference for sys_mutex and futex to mutex documentation, adds Doxygen documentation for SYS_MUTEX_DEFINE and fixes typo in futex documentation. Fixes zephyrproject-rtos#27829 Signed-off-by: Lauren Murphy <[email protected]>
laurenmurphyx64
force-pushed
the
fix_sys_mutex_and_futex_docs
branch
from
4496012 to
fb3719e
Compare
nashif
approved these changes
Feb 2, 2021
dcpleung
approved these changes
Feb 2, 2021
jenmwms
reviewed
Feb 2, 2021
| @@ -166,3 +166,25 @@ API Reference | |||
|
|
|||
| .. doxygengroup:: mutex_apis | |||
| :project: Zephyr | |||
|
|
|||
| Futex API Reference | |||
| ********************************* | |||
There was a problem hiding this comment.
Please check format - I think the underline (*) needs to be same length as the title line above it.
jenmwms
reviewed
Feb 2, 2021
| :project: Zephyr | ||
|
|
||
| User Mode Mutex API Reference | ||
| ********************************* |
There was a problem hiding this comment.
same comment on format of underline (*) length
laurenmurphyx64
added a commit
to laurenmurphyx64/zephyr
that referenced
this pull request
Feb 4, 2021
Fixes typos in mutex documentation accidentally introduced by zephyrproject-rtos#31855. Signed-off-by: Lauren Murphy <[email protected]>
nashif
pushed a commit
that referenced
this pull request
Feb 4, 2021
Fixes typos in mutex documentation accidentally introduced by #31855. Signed-off-by: Lauren Murphy <[email protected]>
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.
Adds API reference for sys_mutex and futex to mutex documentation,
adds Doxygen documentation for SYS_MUTEX_DEFINE and fixes typo in
futex documentation.
Fixes #27829
Signed-off-by: Lauren Murphy [email protected]