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

Fix more doxygen issues #1367

Merged
merged 5 commits into from
Oct 26, 2023
Merged

Fix more doxygen issues #1367

merged 5 commits into from
Oct 26, 2023

Conversation

vyasr
Copy link
Contributor

@vyasr vyasr commented Oct 25, 2023

Description

This PR:

  • Adds the errors group to the doxygen so that errors are also contained in a group
  • Removes invalid @throws sections that throw nothing
  • Remove unnecessary backticks around exception types in contexts where they are already assumed to be types and therefore will link/use the appropriate font automatically

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@vyasr vyasr added 3 - Ready for review Ready for review by team doc Documentation non-breaking Non-breaking change labels Oct 25, 2023
@vyasr vyasr self-assigned this Oct 25, 2023
@vyasr vyasr requested a review from a team as a code owner October 25, 2023 22:04
@github-actions github-actions bot added the cpp Pertains to C++ code label Oct 25, 2023
harrism
harrism approved these changes Oct 26, 2023
View reviewed changes
Copy link
Member

@harrism harrism left a comment

Choose a reason for hiding this comment

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

👏 praise: ‏ Very nice. Thanks.

@vyasr
Copy link
Contributor Author

vyasr commented Oct 26, 2023

/merge

@rapids-bot rapids-bot bot merged commit 5bdcc05 into rapidsai:branch-23.12 Oct 26, 2023
47 checks passed
@vyasr vyasr deleted the fix/more_doxygen_issues branch October 26, 2023 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@harrism harrism harrism approved these changes

@cwharris cwharris Awaiting requested review from cwharris cwharris is a code owner automatically assigned from rapidsai/rmm-cpp-codeowners

Assignees

@vyasr vyasr

Labels
3 - Ready for review Ready for review by team cpp Pertains to C++ code doc Documentation non-breaking Non-breaking change
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@vyasr @harrism