Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

sys_mutex and futex missing documentation #27829

Closed
nashif opened this issue Aug 27, 2020 · 1 comment · Fixed by #31855
Closed

sys_mutex and futex missing documentation #27829

nashif opened this issue Aug 27, 2020 · 1 comment · Fixed by #31855
Assignees
@laurenmurphyx64
Labels
area: Documentation bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug

Comments

@nashif
Copy link
Member

nashif commented Aug 27, 2020

Both objects missing documentation and although they are documented in the code, this API documentation is not linked in the main documentation page.
@nashif nashif added bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug area: Documentation labels Aug 27, 2020
@nashif nashif assigned laurenmurphyx64 and unassigned andrewboie Sep 9, 2020
@rljordan rljordan assigned aasthagr and unassigned laurenmurphyx64 Sep 9, 2020
@github-actions
Copy link

This issue has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this issue will automatically be closed in 14 days. Note, that you can always re-open a closed issue at any time.

@github-actions github-actions bot added the Stale label Nov 24, 2020
@nashif nashif removed the Stale label Dec 6, 2020
@laurenmurphyx64 laurenmurphyx64 mentioned this issue Feb 2, 2021
Merged
laurenmurphyx64 added a commit to laurenmurphyx64/zephyr that referenced this issue Feb 2, 2021
@laurenmurphyx64
doc: Fix sys_mutex and futex missing documentation
fb3719e 
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]>
nashif pushed a commit that referenced this issue Feb 2, 2021
@laurenmurphyx64 @nashif
doc: Fix sys_mutex and futex missing documentation
d922fed 
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@laurenmurphyx64 laurenmurphyx64

Labels
area: Documentation bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: Fix sys_mutex and futex missing documentation laurenmurphyx64/zephyr
4 participants
@nashif @andrewboie @laurenmurphyx64 @aasthagr