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

Remove return type from @return doxygen tags #12908

Merged
merged 3 commits into from
Mar 10, 2023
Merged

Remove return type from @return doxygen tags #12908

merged 3 commits into from
Mar 10, 2023

Conversation

davidwendt
Copy link
Contributor

Description

The doxygen @return does not require a type but only the description. However, the doxygen output looks cleaner without the type. There were only a few places in the public header files that needed to be corrected.
This technically a documentation-only change.
Found when working on #12904

Checklist

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

@davidwendt davidwendt added 2 - In Progress Currently a work in progress doc Documentation libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change labels Mar 8, 2023
@davidwendt davidwendt self-assigned this Mar 8, 2023
@davidwendt davidwendt changed the title Dox remove return types Remove return type from @return doxygen tags Mar 8, 2023
@davidwendt davidwendt added 3 - Ready for Review Ready for review by team and removed 2 - In Progress Currently a work in progress labels Mar 9, 2023
karthikeyann
karthikeyann approved these changes Mar 9, 2023
View reviewed changes
Copy link
Contributor

@karthikeyann karthikeyann left a comment

Choose a reason for hiding this comment

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

Thanks for doing this.
LGTM 👍

@davidwendt davidwendt marked this pull request as ready for review March 9, 2023 20:16
@davidwendt davidwendt requested a review from a team as a code owner March 9, 2023 20:16
@davidwendt davidwendt requested review from harrism and nvdbaranec March 9, 2023 20:16
bdice
bdice approved these changes Mar 9, 2023
View reviewed changes
Copy link
Contributor

@bdice bdice left a comment

Choose a reason for hiding this comment

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

Thanks for this!

@davidwendt
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit e37bddb into rapidsai:branch-23.04 Mar 10, 2023
@davidwendt davidwendt deleted the dox-remove-return-types branch March 10, 2023 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@karthikeyann karthikeyann karthikeyann approved these changes

@bdice bdice bdice approved these changes

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

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

Assignees

@davidwendt davidwendt

Labels
3 - Ready for Review Ready for review by team doc Documentation libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@davidwendt @bdice @karthikeyann