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

[DOC] Include ANN index type in C++ documentation #1771

Closed
lowener opened this issue Aug 25, 2023 · 0 comments · Fixed by #1782
Closed

[DOC] Include ANN index type in C++ documentation #1771

lowener opened this issue Aug 25, 2023 · 0 comments · Fixed by #1782
Assignees
@lowener
Labels
doc Documentation

Comments

@lowener
Copy link
Contributor

lowener commented Aug 25, 2023

Currently the documentation of the index types is not included in the C++ doc website.
IndexParams and SearchParams should be included for IVF-Flat, IVF-PQ and CAGRA doc.
@lowener lowener added the doc Documentation label Aug 25, 2023
@lowener lowener changed the title [DOC] Include NN index type in C++ documentation [DOC] Include ANN index type in C++ documentation Aug 25, 2023
@lowener lowener self-assigned this Aug 25, 2023
@lowener lowener mentioned this issue Aug 28, 2023
Merged
rapids-bot bot pushed a commit that referenced this issue Aug 28, 2023
@lowener
[DOC] Fix grouping for ANN in C++ doxygen (#1782)
3cb08f7 
Fix #1771.
The `@ingroup` directive could only be applied to the member that followed the directive.
`@addtogroup` works better with the markers `@{` and `@}`

Authors:
  - Micka (https://github.com/lowener)

Approvers:
  - Corey J. Nolet (https://github.com/cjnolet)

URL: #1782
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lowener lowener

Labels
doc Documentation
Projects
VS/ML/DM Primitives Release Board
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOC] Fix grouping for ANN in C++ doxygen lowener/raft
1 participant
@lowener