doc: improve API docs with sections #1444
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
Doxygen-generated API documentation had the ability to group API information into sections based on the class of items: Defines, Typedefs, Enums, Functions and then alphabetized with these groups. By removing the Breathe directive :content-only: we can get these class groupings back (instead of having items just sorted alphabetically across all classes), and also allow @name groups to be defined for creating and displaying additional groups (as requested by a developer). Depends on CSS changes in zephyrproject-rtos/docs-theme#14 Signed-off-by: David B. Kinder <[email protected]>
ghost
added
the
In progress
nashif
approved these changes
Sep 12, 2017
ghost
removed
the
In progress
nagineni
pushed a commit
to nagineni/zephyr
that referenced
this pull request
Nov 20, 2017
Signed-off-by: Cui Yan <[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.
Doxygen-generated API documentation had the ability to
group API information into sections based on the class
of items: Defines, Typedefs, Enums, Functions and then
alphabetized with these groups. By removing the
Breathe directive :content-only: we can get these class
groupings back (instead of having items just sorted
alphabetically across all classes), and also allow @name
groups to be defined for creating and displaying additional
groups (as requested by a developer).
Depends on CSS changes in
zephyrproject-rtos/docs-theme#14
Fixes #1445
Signed-off-by: David B. Kinder [email protected]