Doxygen EventQueue updates to not produce warnings and errors [DOC Changes Only] #4434
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
|
Added @geky due to EventQueue updates. |
kegilbert
commented
Jun 2, 2017
| @@ -227,39 +219,64 @@ class Event<void()> { | |||
|
|
|||
| public: | |||
| /** Create an event | |||
| * @see Event::Event | |||
There was a problem hiding this comment.
Removed these as they did not link properly and I had moved all parameter documentation to each function. I can add it back in since the referenced function does have some additional description.
|
so this is the diff? kegilbert/mbed-os@kg-doxygen-template...kg-doxygen-event |
|
Yup, thanks theotherjimmy! (Except that Makefile removal, feel free to ignore that...) |
2 tasks
|
Looks good to me (as long as that makefile is squashed out) 👍 |
Closed
2 tasks
2 tasks
kegilbert
force-pushed
the
kg-doxygen-event
branch
from
f9c4fff to
c6371d9
Compare
- Removed Makefile from branch - Moved a0..a4/c0..c4 parameter documentation from top level overloaded functions to each function to appease Doxygen. - Removed @see Event::Event from overloaded functions as the link did not work and the argument parameter documentation was moved down to each function - TODO: Cleanup EventQueue.h
…s documentation to overloaded functions to fix warnings. B0..B4 were not documentated additionally, only bulk docs for a0..a4 and c0..c4 were moved around.
kegilbert
force-pushed
the
kg-doxygen-event
branch
from
c6371d9 to
fcc7808
Compare
|
Rebased against master following sg-'s merged doxygen-template branch (#4425) and squashed changes. |
sg-
approved these changes
Jun 7, 2017
sg-
added
needs: CI
ready for merge
release-version: 5.5.0-rc2
and removed
needs: review
needs: CI
labels
2 tasks
5 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.
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 Event.h and EventQueue.h are the modified files that are unique to this PR.
Documentation changes to Doxygen descriptions for the Event module to allow Doxygen to build without errors/warnings.
All overloaded functions had refereed to the base function with the base function containing all parameter descriptions for all variations (the overloaded functions largely just added more callback arguments and shared most parameters). This caused a ton of warnings from Doxygen so I moved the documentation blocks to each overloaded function to match that particular implementation. This is a pretty messy method, but I wasn't able to find a better way to handle it with Doxygen.
Please let me know if you're not a fan of the new setup and would like it done a different way.
Related PRs
#4425
Todos