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

Bluetooth mesh API documentation incomplete #5040

Closed
dbkinder opened this issue Nov 17, 2017 · 3 comments
Closed

Bluetooth mesh API documentation incomplete #5040

dbkinder opened this issue Nov 17, 2017 · 3 comments
Assignees
@dbkinder
Labels
area: Documentation

Comments

@dbkinder
Copy link
Contributor

@jhedberg noted that the generated API documentation for Bluetooth Mesh (found at http://docs.zephyrproject.org/api/bluetooth.html#mesh-profile) is missing material. A quick look shows only API material from bluetooth/mesh/main.h is showing up.

Recommend folks read the header files for now while we investigate and fix.
@dbkinder dbkinder self-assigned this Nov 17, 2017
@dbkinder
Copy link
Contributor Author

Verified doxygen comments and processing is ok, so it looks like a sphinx/breathe issue...

@nashif
Copy link
Member

nashif commented Nov 18, 2017

see http://docs.zephyrproject.org/apidoc/latest/dd/d6d/group__bt__mesh.html

@dbkinder dbkinder added the In progress For PRs: is work in progress and should not be merged yet. For issues: Is being worked on label Nov 19, 2017
@dbkinder dbkinder mentioned this issue Nov 19, 2017
Merged
nashif pushed a commit that referenced this issue Nov 19, 2017
@dbkinder
doc: fix missing bluetooth mesh API docs
fa48b93 
Sphinx/breathe doesn't support showing nested groups, so explicitly add
the nested groups in the API documentation (for Bluetooth Mesh).

Also, added an ignore pattern for a nested unnamed type known issue.

fixes: issue #5040

Signed-off-by: David B. Kinder <[email protected]>
@dbkinder
Copy link
Contributor Author

Wait for another cycle of the nightly doc build to verify the subgroups of Mesh in the http://docs.zephyrproject.org/api/bluetooth.html API doc are shown and we can close this issue.

@ghost ghost removed the In progress For PRs: is work in progress and should not be merged yet. For issues: Is being worked on label Nov 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dbkinder dbkinder

Labels
area: Documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nashif @dbkinder