Skip to content
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

Fix up rmw_dds_common documentation when using rosdoc2 #54

Merged
merged 1 commit into from
Sep 15, 2021

Conversation

hidmic
Copy link
Contributor

@hidmic hidmic commented Sep 14, 2021

Precisely what the title says. This patch:

  • Updates the rmw_dds_common's Doxyfile.
  • Cleans up rmw_dds_common API doc blocks.
  • Rearranges a few md files to avoid path issues.

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
@hidmic
Copy link
Contributor Author

hidmic commented Sep 14, 2021

FYI the links to header files in FEATURES.md are not picked up by Doxygen and so they are broken. To the best of my knowledge, only docs.ros.org links to generated documentation, once we have them online, are the only ones that will work in both generated documentation and Github rendered documents.

Copy link
Contributor

@clalancette clalancette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great with green CI.

@hidmic
Copy link
Contributor Author

hidmic commented Sep 15, 2021

Ci up to rmw_dds_common:

  • Linux Build Status
  • Linux-aarch64 Build Status
  • macOS Build Status
  • Windows Build Status

@hidmic
Copy link
Contributor Author

hidmic commented Sep 15, 2021

Alright, CI's green. Going in !

@hidmic hidmic merged commit 4a987e5 into master Sep 15, 2021
@delete-merged-branch delete-merged-branch bot deleted the hidmic/fix-rmw_dds_common-docs branch September 15, 2021 14:00
@ros-discourse
Copy link

This pull request has been mentioned on ROS Discourse. There might be relevant details there:

https://discourse.ros.org/t/ros-2-tsc-meeting-minutes-2021-9-16/22372/1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants