Doxygen template and CI to not produce warnings and errors #4425
Conversation
This file contains hidden or 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
theotherjimmy
force-pushed
the
doxygen-template
branch
5 times, most recently
from
cf4a809 to
b54902e
Compare
|
Starting from the top of the list with RTOS. @deepikabhavnani said she could start from the center and we'll work towards each other. |
|
I'll start from the bottom, once I get the CI work done. |
|
Please be aware: I'm currently modifying history. |
theotherjimmy
force-pushed
the
doxygen-template
branch
2 times, most recently
from
4ad1b1b to
727f52f
Compare
|
I'm done editing history. This travis build should pass and tests for no warnings in the doxygen! |
This was referenced Jun 2, 2017
|
Taking up Frameworks next, Deepika is on Filesystems. |
Closed
2 tasks
Should be kept in sync with doxygen_options.json which is used for building the doxygen which is used by docs.mbed.com It is intended only generate doxygen for specific directories which present the public APIs for mbed OS
|
looks like a regression in doxygen happened recently in platform. |
2 tasks
2 tasks
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.
Description
To verify the doxygen documentation is compatible with the developer.mbed.org and docs.mbed.com doxygen_options can be used
doxygen doxygen_optionsto build locally. When modifications are made to this file they must also be made todoxygen_options.jsonOnly a subset of options are available in
doxygen_options.jsontherefore should not depend on modifications to options that are not present.@theotherjimmy tbd add to travis and verify output is clean (ie no warnings or errors)
Additional commits to fix additional warnings added in the last few days since the platform/* directory was last warning free.
Status
READY
Todos
Directories still needing errors and warnings to be fixed: