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.

Sign up for GitHub

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

Jump to bottom

Doxygen guide #423

Merged
merged 6 commits into from
Jun 7, 2022
Merged

Doxygen guide #423

merged 6 commits into from
Jun 7, 2022

Conversation

henrygerardmoore
Copy link
Contributor

@henrygerardmoore henrygerardmoore commented Jun 7, 2022 •
edited
Loading

Description

Added a short tutorial with an introduction to Doxygen comments, resolves #254

Checklist

  • Required by CI: Code is auto formatted using clang-format
  • While waiting for someone to review your request, please consider reviewing another open pull request to support the maintainers

@henrygerardmoore
Copy link
Contributor Author

Builds locally without issue and the page looks fine

@stephanie-eng
Copy link
Contributor

Since you mentioned both input and output parameters, could you also include an example that uses @return?

@henrygerardmoore
Copy link
Contributor Author

@stephanie-eng just added another example that uses @return

tylerjw
tylerjw approved these changes Jun 7, 2022
View reviewed changes
Copy link
Member

@tylerjw tylerjw left a comment

Choose a reason for hiding this comment

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

Thank you for this addition, this is helpful. Eventually, it would be nice to add a description for the style of doxygen comments we use with configs for those various tools, but this is a really nice addition regardless.

@tylerjw tylerjw added backport-galactic This label signals Mergify to backport this PR to Galactic backport-humble This label signals Mergify to backport this PR to Humble labels Jun 7, 2022
@tylerjw tylerjw merged commit ea8b4fc into moveit:main Jun 7, 2022
mergify bot pushed a commit that referenced this pull request Jun 7, 2022
@henrygerardmoore @mergify
Doxygen guide (#423)
5b719ed 
(cherry picked from commit ea8b4fc)
@mergify mergify bot mentioned this pull request Jun 7, 2022
Merged
mergify bot pushed a commit that referenced this pull request Jun 7, 2022
@henrygerardmoore @mergify
Doxygen guide (#423)
097a83f 
(cherry picked from commit ea8b4fc)
@mergify mergify bot mentioned this pull request Jun 7, 2022
Merged
vatanaksoytezer pushed a commit that referenced this pull request Jun 8, 2022
@mergify
Doxygen guide (#423) (#428)
ef27b6d
vatanaksoytezer pushed a commit that referenced this pull request Jun 8, 2022
@mergify
Doxygen guide (#423) (#427)
e7fa2c5
@henrygerardmoore henrygerardmoore deleted the doxygen-guide branch June 30, 2022 22:28
This was referenced Jun 30, 2022
Merged
Merged
@tylerjw tylerjw mentioned this pull request Feb 21, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stephanie-eng stephanie-eng stephanie-eng approved these changes

@tylerjw tylerjw tylerjw approved these changes

Assignees
No one assigned
Labels
backport-galactic This label signals Mergify to backport this PR to Galactic backport-humble This label signals Mergify to backport this PR to Humble
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Write How-To Guide for Contributing Doxygen Comments
3 participants
@henrygerardmoore @stephanie-eng @tylerjw