-
Notifications
You must be signed in to change notification settings - Fork 0
227 workflow add checks on cpp documentation #313
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't forget to sign off you commits. A DCO workflow runs automatically on all repos on alliander-opensource and fails when you don't sign off your commits.
| const moveit::core::JointModelGroup *joint_model_group; | ||
| moveit_visual_tools::MoveItVisualTools moveit_visual_tools; | ||
| PoseStamped goal_pose; | ||
| rclcpp::Node::SharedPtr node; /**< ROS2 node with MoveIt Services */ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Previously instead of using /**< ... */ I simply used // ..., is the /**< ... */ version the neater way of commenting behind a variable?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In order for Doxygen to recognize the comment as a docstring, it needs to be formatted a certain way. See: https://www.doxygen.nl/manual/docblocks.html
9cd4267 to
bcd4218
Compare
Signed-off-by: Peter Geurts <[email protected]>
Signed-off-by: Peter Geurts <[email protected]>
Signed-off-by: Peter Geurts <[email protected]>
Signed-off-by: Peter Geurts <[email protected]>
…hods; remove generated Doxygen output folder after script has run Signed-off-by: Peter Geurts <[email protected]>
…doc warnings in doxyfile.lint Signed-off-by: Peter Geurts <[email protected]>
Signed-off-by: Peter Geurts <[email protected]>
…GH workflows to use modern pip version of clang-format Signed-off-by: Peter Geurts <[email protected]>
bcd4218 to
224079c
Compare
Signed-off-by: Jelmer de Wolde <[email protected]>
Description
This PR adds doxygen-style documentation checks for C++ code. Specifically, it adds
.cpp/.h/.hppfiles inros2_ws/src;pre-commitcheck that executes the shell script mentioned above;moveit_manager.hppto adhere to Doxygen documentation standards;Fixes: #227
Testing
pre-commitcheck with correct and incorrect documentation;actwith correct and incorrect documentation.Documentation
Additional Notes
The doxygen linter fails in
pre-commitchecks when no output is produced (theGENERATE_<...>values indoxyfile.lint). Therefore, RTF output is generated to pass the check. The generated files are added to the.gitignore.