Fix API documentation for clean rosdoc2 build
#139
Merged
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
added 7 commits
August 2, 2021 12:23
Signed-off-by: Abrar Rahman Protyasha <[email protected]>
Previously, Doxygen was returning warnings about undocumented function parameters, which this commit addresses. Signed-off-by: Abrar Rahman Protyasha <[email protected]>
Signed-off-by: Abrar Rahman Protyasha <[email protected]>
Signed-off-by: Abrar Rahman Protyasha <[email protected]>
`split(const std::string&, char, InsertIterator&, bool)` was used privately by `split(const std::string&, char, bool)`. Since the latter signature was caushing `breathe` to choke at the template paramater list anyway, it was conditionally excluded from Doxygen visibility. Signed-off-by: Abrar Rahman Protyasha <[email protected]>
Signed-off-by: Abrar Rahman Protyasha <[email protected]>
The macro in question produces an anonymous hyperlink error when exhale produces the `Define THREAD_ANNOTATION_ATTRIBUTE__` statement in its generated `.rst` file. Since this macro itself is not used publicly, and there is no obvious approach to fix the warning about anonymous hpyerlinks, I have conditionally excluded that macro from Doxygen. Signed-off-by: Abrar Rahman Protyasha <[email protected]>
|
Not running CI since all changes introduced in this PR are for documentation. |
clalancette
requested changes
Aug 2, 2021
This commit targets the `filesystem_helper.hpp` and the `asserts.hpp` headers, to increase uniformity of doxygen commands across the package. Signed-off-by: Abrar Rahman Protyasha <[email protected]>
clalancette
approved these changes
Aug 3, 2021
|
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
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.
This PR introduces changes which resolve multiple errors/warnings on
rosdoc2 buildinvocations to generate API documentation forrcpputils.Namely:
rcpputils::fs: Missing parameters in function header.rcpputils::shared_library: Remove@copydocdirective.rcpputils::split: Conditionally excludesplitsignature with template parameter list sincebreathehas a tough time parsing said list. Once Handle parsing errors breathe-doc/breathe#711 is merged, the@cond/@endconddirectives can be removed.rcpputils::thread_safety_annotations: There seems to be no straightforward method to address the "anonymous hyperlink" warning generated because of the double trailing underscores in theRCPPUTILS_THREAD_ANNOTATION_ATTRIBUTE__macro. As such, this macro has been conditionally excluded.