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

Fixing up documentation build when using rosdoc2 #344

Merged
merged 2 commits into from
Aug 9, 2021
Merged

Conversation

wjwwood
Copy link
Member

@wjwwood wjwwood commented Aug 5, 2021

The main this this pull request does is eliminate a bunch of issues caused by files in stdatomic_helpers. I spent a lot of time trying to squash the issues, but I think that, in the end, we won't run into these issues elsewhere and these files are implementation details really, so I've just excluded them completely from Doxygen.

I also changed the @file to be \file in the headers, just to match the style throughout the rest of the package.

In order to eliminate the rest of the warnings we have to resolve #333 and svenevs/exhale#111. As well as either resolve breathe-doc/breathe#722 or pin the version of breathe back to a version without that warning.

@wjwwood wjwwood requested a review from clalancette August 5, 2021 00:30
@wjwwood wjwwood self-assigned this Aug 5, 2021
@wjwwood wjwwood merged commit 304e143 into master Aug 9, 2021
@delete-merged-branch delete-merged-branch bot deleted the wjwwood/fixup_docs branch August 9, 2021 19:46
@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.

"Warning: Unable to resolve function...", Breathe omits param names?
4 participants