Doxygen HAL updates to not produce warnings and errors [DOC Changes Only] #4435
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
Closed
2 tasks
2 tasks
…es in gpio_api.h and added new params in ticker_api.h
|
Rebased against master following sg-'s merged doxygen-template branch (#4425) and squashed changes. |
sg-
approved these changes
Jun 7, 2017
|
needs a rebase and should probably be consolidated into one PR at this point. The conflict will happen for each PR |
|
@kegilbert Still needs further rebasing by the looks of it... |
2 tasks
|
Combined remaining doc PRs into one to avoid causing merge conflicts on each submission, follow this changeset to here: #4508 |
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.
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.
Commit history will be cleaned up prior to merging.
Note to reviewers: In particular ticker_api.h, Driver_Storage.h, and gpio_api.h are the modified files that are unique to this PR. See (ignore Makefile, will squash when rebasing): kegilbert/mbed-os@kg-doxygen-template...kg-doxygen-hal
Documentation changes to Doxygen descriptions for the HAL module to allow Doxygen to build without errors/warnings.
Related PRs
#4425
#4434
Todos