Adding doxygen documentation and READMEs to packages #204
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
brawner
force-pushed
the
documentation_readme
branch
from
449e474
to
178368e
Compare
ahcorde
requested changes
Apr 22, 2020
brawner
force-pushed
the
documentation_readme
branch
2 times, most recently
from
647a1cd
to
f6b581f
Compare
|
Thanks for the feedback @ahcorde. Should be addressed. |
|
CI status:
|
ahcorde
approved these changes
Apr 24, 2020
Signed-off-by: Stephen Brawner <brawner@gmail.com>
brawner
force-pushed
the
documentation_readme
branch
from
f6b581f
to
22d45c0
Compare
Signed-off-by: Stephen Brawner <brawner@gmail.com>
Merged
dirk-thomas
reviewed
Apr 24, 2020
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.
Completing the API documentation of rmw. I tried to research as much as I could through rcl and rcutils packages which this package borrows from as well as design.ros2.org documentation.
One question I had for the maintainers was whether items that were strictly defined to a corresponding element in rcutils should have documention, or just link to rcutils documentation? For those, I copied the existing comments, but that does create two locations where that documentation has to be maintained.
Signed-off-by: Stephen Brawner brawner@gmail.com