Add doxygen support #330
Open
Add doxygen support #330
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
niklarm
force-pushed
the
feature/doxygen
branch
from
741db4f
to
3b096a9
Compare
niklarm
force-pushed
the
feature/doxygen
branch
from
3b096a9
to
eb452ef
Compare
niklarm
force-pushed
the
feature/doxygen
branch
from
eb452ef
to
779e2d2
Compare
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 adds a simple doxygen configuration and adapts our headers to group APIs into basic modules. This is only a rough draft, so that we have something to render.
Some APIs are just excluded, since I deemed them not relevant for application developers. They can be re-enabled by including the
UVISOR_INTERNALsection in doxygen (add to line 651 in doxyfile,ENABLED_SECTIONS = UVISOR_INTERNAL).The grouping decisions are not final, please leave a comment if I misjudged.
This includes no changes to code, only comments have been added or modified.
We could probably spend a year on the doxygen config alone, it's 2439 lines long.
The interesting decisions I've made to the default config can easily be seen in the second commit.
cc @AlessandroA @meriac @Patater