-
Notifications
You must be signed in to change notification settings - Fork 3k
Doxygen features/Frameworks updates to not produce warnings and errors [DOC Changes Only] #4452
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.
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
Conversation
The following errors are known and being resolved in the RTOS PR (pending).
|
@kegilbert So it can't come in until that aforementioned, pending PR does. |
The person who's github name is param must have a bad time with doxygen output. |
1561e97
to
4fc20be
Compare
Rebased against master following sg-'s merged doxygen-template branch (#4425) and squashed changes. |
@kegilbert needs a rebase and should probably be consolidated into one PR at this point. The conflict will happen for each PR |
Good point, I'll consolidate everything to make this easier. |
Combined remaining doc PRs into one to avoid causing merge conflicts on each submission, follow this changeset to here: #4508 |
NOTE The commit history is not cleaned up and pulls in a lot of duplicate changes from @sg-'s pull request linked below. Putting this review up to get eyes on the doxygen changes as the structure changed a decent amount for how I documented the overloaded functions. This also pulls in Jimmy's CI changes so I can get a CI run in.
Rebased to remove references to Makefile I accidentally added in my template branch.
Note to reviewers: In particular look at the following diff to see what files to review:
https://github.com/kegilbert/mbed-os/compare/kg-doxygen-template...kegilbert:kg-doxygen-framework2?expand=1
Documentation changes to Doxygen descriptions for the features/Frameworks module to allow Doxygen to build without errors/warnings.
Related PRs
#4425
#4434
#4435
Todos