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

updated comment formatting for correct doxygen generation #1582

Merged
merged 1 commit into from
Sep 27, 2022

Conversation

MikeWrock
Copy link
Contributor

@MikeWrock MikeWrock commented Sep 27, 2022

Description

The Doxygen documentation is generated incorrectly due to incorrect comment syntax. This PR corrects the issue

Checklist

  • Required by CI: Code is auto formatted using clang-format
  • Extend the tutorials / documentation reference
  • Document API changes relevant to the user in the MIGRATION.md notes
  • Create tests, which fail without this PR reference
  • Include a screenshot if changing a GUI
  • While waiting for someone to review your request, please help review another open pull request to support the maintainers

@MikeWrock
Copy link
Contributor Author

This newline causes the doxygen formatting to look bad for VALID_INITIALIZATION_METHODS, but I'm not sure how to fix it without disabling clang for that section. I can leave it as is, or disable formatting for that line

@codecov
Copy link

codecov bot commented Sep 27, 2022

Codecov Report

Base: 51.11% // Head: 51.11% // Decreases project coverage by -0.01% ⚠️

Coverage data is based on head (bc08e40) compared to base (e960047).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1582      +/-   ##
==========================================
- Coverage   51.11%   51.11%   -0.00%     
==========================================
  Files         380      380              
  Lines       31796    31796              
==========================================
- Hits        16250    16249       -1     
- Misses      15546    15547       +1     
Impacted Files Coverage Δ
...nning_scene_monitor/src/planning_scene_monitor.cpp 45.29% <0.00%> (-0.43%) ⬇️
...dl_kinematics_plugin/src/kdl_kinematics_plugin.cpp 76.43% <0.00%> (+1.08%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@tylerjw tylerjw merged commit 71e6d90 into moveit:main Sep 27, 2022
@tylerjw tylerjw added the backport-humble Mergify label that triggers a PR backport to Humble label Oct 28, 2022
mergify bot pushed a commit that referenced this pull request Oct 28, 2022
tylerjw pushed a commit that referenced this pull request Oct 28, 2022
)

(cherry picked from commit 71e6d90)

Co-authored-by: Michael Wrock <michael.wrock@picknik.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-humble Mergify label that triggers a PR backport to Humble
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants