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

Add DOCUMENTATION.md #667

Merged
merged 8 commits into from
Sep 28, 2022
Merged

Conversation

harrism
Copy link
Member

@harrism harrism commented Sep 7, 2022

Description

Adds the C++ DOCUMENTATION.md, covering the use of Doxygen for documenting the code. Copied mostly from libcudf.

Contributes to #598

Checklist

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

@harrism harrism added doc Documentation non-breaking Non-breaking change labels Sep 7, 2022
@harrism harrism added this to the Developer Documentation milestone Sep 7, 2022
@harrism harrism requested a review from a team as a code owner September 7, 2022 06:18
@harrism harrism self-assigned this Sep 7, 2022
@github-actions github-actions bot added the libcuspatial Relates to the cuSpatial C++ library label Sep 7, 2022
@harrism harrism added the 3 - Ready for Review Ready for review by team label Sep 7, 2022
@harrism harrism requested review from thomcom and isVoid and removed request for zhangjianting and jrhemstad September 7, 2022 06:19
cpp/doc/DOCUMENTATION.md Show resolved Hide resolved
cpp/doc/DOCUMENTATION.md Show resolved Hide resolved
cpp/doc/DOCUMENTATION.md Outdated Show resolved Hide resolved
cpp/doc/DOCUMENTATION.md Outdated Show resolved Hide resolved
Copy link
Contributor

@thomcom thomcom left a comment

Choose a reason for hiding this comment

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

I reviewed this in #673

@harrism harrism requested a review from a team as a code owner September 21, 2022 00:28
@github-actions github-actions bot added the cmake Related to CMake code or build configuration label Sep 21, 2022
cpp/CMakeLists.txt Show resolved Hide resolved
Copy link
Contributor

@isVoid isVoid left a comment

Choose a reason for hiding this comment

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

Some nitpicking.

cpp/doc/DOCUMENTATION.md Show resolved Hide resolved
cpp/doc/DOCUMENTATION.md Outdated Show resolved Hide resolved
cpp/doc/DOCUMENTATION.md Show resolved Hide resolved
@harrism
Copy link
Member Author

harrism commented Sep 28, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit d5f2032 into rapidsai:branch-22.10 Sep 28, 2022
rapids-bot bot pushed a commit that referenced this pull request Sep 30, 2022
This PR mimics rapidsai/cudf#11475 to add libcuspatial's C++ developer guide to the rendered Doxygen HTML docs. See that PR for detailed discussion.

Contributes to #598 . Closes #235

Note that this PR depends on #672 and #667 so the changed files will include changes from those PRs until they are merged.

Authors:
  - Mark Harris (https://github.com/harrism)

Approvers:
  - H. Thomson Comer (https://github.com/thomcom)
  - Vyas Ramasubramani (https://github.com/vyasr)
  - AJ Schmidt (https://github.com/ajschmidt8)
  - Michael Wang (https://github.com/isVoid)

URL: #673
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Ready for Review Ready for review by team cmake Related to CMake code or build configuration doc Documentation libcuspatial Relates to the cuSpatial C++ library non-breaking Non-breaking change
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants