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

Add groups to the doxygen docs #1358

Merged
merged 16 commits into from
Oct 12, 2023
Merged

Add groups to the doxygen docs #1358

merged 16 commits into from
Oct 12, 2023

Conversation

vyasr
Copy link
Contributor

@vyasr vyasr commented Oct 11, 2023

Description

This PR adds doxygen groups for the various parts of the C++ API to help provide more context. This will also help with improving the docs experience in #1324.

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 11, 2023
@vyasr vyasr self-assigned this Oct 11, 2023
@vyasr vyasr requested a review from a team as a code owner October 11, 2023 01:04
@vyasr vyasr requested review from wence- and bdice October 11, 2023 01:04
@github-actions github-actions bot added the cpp Pertains to C++ code label Oct 11, 2023
harrism
harrism requested changes Oct 11, 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.

Thanks for doing this, @vyasr. I think a few small changes will help to group everything by function and be more aligned to what users will do with the library. (As apposed to having some groups about coding terminology, like "strong types").

include/rmm/cuda_device.hpp Outdated Show resolved Hide resolved
include/rmm/cuda_stream.hpp Outdated Show resolved Hide resolved
include/rmm/cuda_stream_pool.hpp Outdated Show resolved Hide resolved
include/rmm/cuda_stream_view.hpp Outdated Show resolved Hide resolved
include/rmm/device_buffer.hpp Outdated Show resolved Hide resolved
include/rmm/device_uvector.hpp Outdated Show resolved Hide resolved
include/rmm/mr/device/owning_wrapper.hpp Outdated Show resolved Hide resolved
include/rmm/mr/device/owning_wrapper.hpp Outdated Show resolved Hide resolved
include/rmm/mr/device/owning_wrapper.hpp Show resolved Hide resolved
include/doxygen_groups.h Outdated Show resolved Hide resolved
@vyasr vyasr requested a review from harrism October 11, 2023 16:47
harrism
harrism approved these changes Oct 12, 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.

Looks good! Thanks.

@vyasr
Copy link
Contributor Author

vyasr commented Oct 12, 2023

/merge

@rapids-bot rapids-bot bot merged commit 48f2382 into rapidsai:branch-23.12 Oct 12, 2023
46 checks passed
@vyasr vyasr deleted the feat/doxygen_groups branch October 25, 2023 16:04
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

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

@bdice bdice Awaiting requested review from bdice bdice 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