Fix Doxygen @param entries in /include - #21762
Merged
Merged
Conversation
vuule
added
doc
Contributor
Author
|
/ok to test d01d060 |
Contributor
|
This looks good. |
bdice
approved these changes
Mar 13, 2026
| * | ||
| * @param p A \c pointer to the previously allocated memory. | ||
| * @note The second parameter is the number of objects previously allocated. | ||
| * @param cnt Number of objects that werepreviously allocated. |
Contributor
There was a problem hiding this comment.
Missing a space in this sentence. I also wish this was count...
Suggested change
| * @param cnt Number of objects that werepreviously allocated. | |
| * @param cnt Number of objects that were previously allocated. |
shrshi
approved these changes
Mar 13, 2026
Contributor
Author
|
/ok to test 0e2c513 |
Contributor
Author
|
/merge |
3 tasks
rapids-bot Bot
pushed a commit
that referenced
this pull request
Aug 12, 2026
…ns (#23564) Doxygen tags in `cpp/include` and `cpp/src` that name something the declaration below them does not have. Comments only — no code, no behaviour, no tests. **`@tparam` with the name missing** — `column_view_base::head` and `mutable_column_view::head` both carry `@tparam The type to cast to`, so Doxygen takes `The` as the template parameter name and `T` goes undocumented. **`@tparam` left over from a refactor** — eight of the `make_device_uvector*` overloads in `detail/utilities/vector_factories.hpp` document both `Container` and `T`, but those overloads are `template <typename Container>` only. The `T` line is a leftover from the `host_span<T>` overloads above them. **`@tparam` renamed** — `id_to_type` documents `t` while the parameter is `Id`; `dictionary_column_wrapper` documents `SourceElementTo` while the parameter is `SourceElementT`. **`@param` on a function that takes nothing** — `arrow_column::view()` and `arrow_table::view()` document `stream` and `mr`, copied from the `to_arrow` overload directly above each. Both take no arguments. **`@param` where `@tparam` was meant** — `is_boolean()` documents `@param type The data_type to verify` and `is_nested()` documents `@param T`; both are `template <typename T>` predicates with no runtime arguments. A second commit covers the further files pointed out in review: `column_device_view_base.cuh`, `type_dispatcher.hpp`'s `IdTypeMap`, `iterator.cuh`, `timestamp_utilities.cuh`, `rolling/detail/range_utils.cuh` and `strings/count_matches.hpp`. Follows #21762 and #21764, which did the same for other entries in `/include` and `/src`. Every tag here was opened and read against the declaration underneath it. Authors: - Dmitry (https://github.com/darkdi) - Igor Peshansky (https://github.com/igorpeshansky) - Nghia Truong (https://github.com/ttnghia) Approvers: - Igor Peshansky (https://github.com/igorpeshansky) - Nghia Truong (https://github.com/ttnghia) - Yunsong Wang (https://github.com/PointKernel) URL: #23564
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
AI-assisted, human-verified, fixes for the Doxygen parameter documentation - limited to
/includedirectory.We often find these kinds of errors in new PRs. With AI code review we will probably stop merging new errors of this type. This PR aims to fix old error so we hopefully stay 100% accurate from now on.
Checklist