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

Fix doxygen warnings in structs, lists headers #10923

Merged
merged 9 commits into from
Jun 1, 2022
8 changes: 4 additions & 4 deletions cpp/include/cudf/lists/combine.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ enum class concatenate_null_policy { IGNORE, NULLIFY_OUTPUT_ROW };
* @throws cudf::logic_error if any lists column contains nested typed entry.
* @throws cudf::logic_error if all lists columns do not have the same entry type.
*
* @param input Table of lists to be concatenated.
* @param input Table of lists to be concatenated
* @param null_policy The parameter to specify whether a null list element will be ignored from
* concatenation, or any concatenation involving a null element will result in a null list.
* @param mr Device memory resource used to allocate the returned column's device memory.
* @param mr Device memory resource used to allocate the returned column's device memory
* @return A new column in which each row is a list resulted from concatenating all list elements in
* the corresponding row of the input table.
*/
Expand Down Expand Up @@ -84,10 +84,10 @@ std::unique_ptr<column> concatenate_rows(
* @throws cudf::logic_error if the input lists column contains nested typed entries that are not
* lists.
*
* @param input The lists column containing lists of list elements to concatenate.
* @param input The lists column containing lists of list elements to concatenate
* @param null_policy The parameter to specify whether a null list element will be ignored from
* concatenation, or any concatenation involving a null element will result in a null list.
* @param mr Device memory resource used to allocate the returned column's device memory.
* @param mr Device memory resource used to allocate the returned column's device memory
* @return A new column in which each row is a list resulted from concatenating all list elements in
* the corresponding row of the input lists column.
*/
Expand Down
12 changes: 6 additions & 6 deletions cpp/include/cudf/lists/contains.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2021, NVIDIA CORPORATION.
* Copyright (c) 2021-2022, NVIDIA CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -42,7 +42,7 @@ namespace lists {
*
* @param lists Lists column whose `n` rows are to be searched
* @param search_key The scalar key to be looked up in each list row
* @param mr Device memory resource used to allocate the returned column's device memory.
* @param mr Device memory resource used to allocate the returned column's device memory
* @return std::unique_ptr<column> BOOL8 column of `n` rows with the result of the lookup
*/
std::unique_ptr<column> contains(
Expand All @@ -66,7 +66,7 @@ std::unique_ptr<column> contains(
*
* @param lists Lists column whose `n` rows are to be searched
* @param search_keys Column of elements to be looked up in each list row
* @param mr Device memory resource used to allocate the returned column's device memory.
* @param mr Device memory resource used to allocate the returned column's device memory
* @return std::unique_ptr<column> BOOL8 column of `n` rows with the result of the lookup
*/
std::unique_ptr<column> contains(
Expand All @@ -85,7 +85,7 @@ std::unique_ptr<column> contains(
* (Empty list rows are considered *NOT* to contain a null element.)
*
* @param lists Lists column whose `n` rows are to be searched
* @param mr Device memory resource used to allocate the returned column's device memory.
* @param mr Device memory resource used to allocate the returned column's device memory
* @return std::unique_ptr<column> BOOL8 column of `n` rows with the result of the lookup
*/
std::unique_ptr<column> contains_nulls(
Expand Down Expand Up @@ -123,7 +123,7 @@ enum class duplicate_find_option : int32_t {
* @param search_key The scalar key to be looked up in each list row
* @param find_option Whether to return the position of the first match (`FIND_FIRST`) or
* last (`FIND_LAST`)
* @param mr Device memory resource used to allocate the returned column's device memory.
* @param mr Device memory resource used to allocate the returned column's device memory
* @return std::unique_ptr<column> INT32 column of `n` rows with the location of the `search_key`
*
* @throw cudf::logic_error If `search_key` type does not match the element type in `lists`
Expand Down Expand Up @@ -159,7 +159,7 @@ std::unique_ptr<column> index_of(
* `lists`
* @param find_option Whether to return the position of the first match (`FIND_FIRST`) or
* last (`FIND_LAST`)
* @param mr Device memory resource used to allocate the returned column's device memory.
* @param mr Device memory resource used to allocate the returned column's device memory
* @return std::unique_ptr<column> INT32 column of `n` rows with the location of the `search_key`
*
* @throw cudf::logic_error If `search_keys` does not match `lists` in its number of rows
Expand Down
8 changes: 4 additions & 4 deletions cpp/include/cudf/lists/count_elements.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2021, NVIDIA CORPORATION.
* Copyright (c) 2021-2022, NVIDIA CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -42,9 +42,9 @@ namespace lists {
* Any null input element will result in a corresponding null entry
* in the output column.
*
* @param input Input lists column.
* @param mr Device memory resource used to allocate the returned column's device memory.
* @return New INT32 column with the number of elements for each row.
* @param input Input lists column
* @param mr Device memory resource used to allocate the returned column's device memory
* @return New INT32 column with the number of elements for each row
*/
std::unique_ptr<column> count_elements(
lists_column_view const& input,
Expand Down
6 changes: 3 additions & 3 deletions cpp/include/cudf/lists/detail/combine.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2021, NVIDIA CORPORATION.
* Copyright (c) 2021-2022, NVIDIA CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -25,7 +25,7 @@ namespace detail {
/**
* @copydoc cudf::lists::concatenate_rows
*
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> concatenate_rows(
table_view const& input,
Expand All @@ -36,7 +36,7 @@ std::unique_ptr<column> concatenate_rows(
/**
* @copydoc cudf::lists::concatenate_list_elements
*
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> concatenate_list_elements(
column_view const& input,
Expand Down
10 changes: 5 additions & 5 deletions cpp/include/cudf/lists/detail/concatenate.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020-2021, NVIDIA CORPORATION.
* Copyright (c) 2020-2022, NVIDIA CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -37,10 +37,10 @@ namespace detail {
* r is now [{0, 1}, {2, 3, 4, 5, 6}, {7, 8, 9}, {10, 11}]
* @endcode
*
* @param columns Vector of lists columns to concatenate.
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param mr Device memory resource used to allocate the returned column's device memory.
* @return New column with concatenated results.
* @param columns Vector of lists columns to concatenate
* @param stream CUDA stream used for device memory operations and kernel launches
* @param mr Device memory resource used to allocate the returned column's device memory
* @return New column with concatenated results
*/
std::unique_ptr<column> concatenate(
host_span<column_view const> columns,
Expand Down
8 changes: 4 additions & 4 deletions cpp/include/cudf/lists/detail/contains.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace detail {
* cudf::scalar const&,
* duplicate_find_option,
* rmm::mr::device_memory_resource*)
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> index_of(
cudf::lists_column_view const& lists,
Expand All @@ -41,7 +41,7 @@ std::unique_ptr<column> index_of(
* cudf::column_view const&,
* duplicate_find_option,
* rmm::mr::device_memory_resource*)
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> index_of(
cudf::lists_column_view const& lists,
Expand All @@ -54,7 +54,7 @@ std::unique_ptr<column> index_of(
* @copydoc cudf::lists::contains(cudf::lists_column_view const&,
* cudf::scalar const&,
* rmm::mr::device_memory_resource*)
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> contains(
cudf::lists_column_view const& lists,
Expand All @@ -66,7 +66,7 @@ std::unique_ptr<column> contains(
* @copydoc cudf::lists::contains(cudf::lists_column_view const&,
* cudf::column_view const&,
* rmm::mr::device_memory_resource*)
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> contains(
cudf::lists_column_view const& lists,
Expand Down
6 changes: 3 additions & 3 deletions cpp/include/cudf/lists/detail/copying.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020-2021, NVIDIA CORPORATION.
* Copyright (c) 2020-2022, NVIDIA CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -35,11 +35,11 @@ namespace detail {
* s2 is {{4, 5}, {6, 7}, {}}
* @endcode
*
* @param lists Lists instance for this operation.
* @param lists Lists instance for this operation
* @param start Index to first list to select in the column
* @param end One past the index to last list to select in the column
* @param stream CUDA stream used for device memory operations and kernel launches
* @param mr Device memory resource used to allocate the returned column's device memory.
* @param mr Device memory resource used to allocate the returned column's device memory
* @return New lists column of size (end - start)
*/
std::unique_ptr<cudf::column> copy_slice(lists_column_view const& lists,
Expand Down
6 changes: 3 additions & 3 deletions cpp/include/cudf/lists/detail/drop_list_duplicates.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2021, NVIDIA CORPORATION.
* Copyright (c) 2021-2022, NVIDIA CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -29,7 +29,7 @@ namespace detail {
* null_equality,
* nan_equality,
* rmm::mr::device_memory_resource*)
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> drop_list_duplicates(
lists_column_view const& keys,
Expand All @@ -45,7 +45,7 @@ std::unique_ptr<column> drop_list_duplicates(
* null_equality,
* nan_equality,
* rmm::mr::device_memory_resource*)
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> drop_list_duplicates(
lists_column_view const& input,
Expand Down
4 changes: 2 additions & 2 deletions cpp/include/cudf/lists/detail/extract.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace detail {
/**
* @copydoc cudf::lists::extract_list_element(lists_column_view, size_type,
* rmm::mr::device_memory_resource*)
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> extract_list_element(
lists_column_view lists_column,
Expand All @@ -36,7 +36,7 @@ std::unique_ptr<column> extract_list_element(
/**
* @copydoc cudf::lists::extract_list_element(lists_column_view, column_view const&,
* rmm::mr::device_memory_resource*)
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> extract_list_element(
lists_column_view lists_column,
Expand Down
4 changes: 2 additions & 2 deletions cpp/include/cudf/lists/detail/gather.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ struct gather_data {
* rmm::cuda_stream_view stream,
* rmm::mr::device_memory_resource* mr)
*
* @param prev_base_offsets The buffer backing the base offsets used in the gather map. We can
* @param prev_base_offsets The buffer backing the base offsets used in the gather map We can
karthikeyann marked this conversation as resolved.
Show resolved Hide resolved
* free this buffer before allocating the new one to keep peak memory
* usage down.
*/
Expand Down Expand Up @@ -249,7 +249,7 @@ gather_data make_gather_data(cudf::lists_column_view const& source_column,
* @tparam NullifyOutOfBounds Nullify values in `gather_map` that are out of bounds
* @param source_column View into the column to gather from
* @param gather_map Iterator access to the gather map for `source_column` map
* @param gather_map_size Size of the gather map.
* @param gather_map_size Size of the gather map
* @param stream CUDA stream on which to execute kernels
* @param mr Memory resource to use for all allocations
*
Expand Down
12 changes: 6 additions & 6 deletions cpp/include/cudf/lists/detail/interleave_columns.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2021, NVIDIA CORPORATION.
* Copyright (c) 2021-2022, NVIDIA CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -38,11 +38,11 @@ namespace detail {
* @throws cudf::logic_error if any lists column contains nested typed entry.
* @throws cudf::logic_error if all lists columns do not have the same entry type.
*
* @param input Table containing lists columns to interleave.
* @param has_null_mask A boolean flag indicating that the input columns have a null mask.
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param mr Device memory resource used to allocate the returned column's device memory.
* @return The interleaved columns as a single column.
* @param input Table containing lists columns to interleave
* @param has_null_mask A boolean flag indicating that the input columns have a null mask
* @param stream CUDA stream used for device memory operations and kernel launches
* @param mr Device memory resource used to allocate the returned column's device memory
* @return The interleaved columns as a single column
*/
std::unique_ptr<column> interleave_columns(
table_view const& input,
Expand Down
12 changes: 6 additions & 6 deletions cpp/include/cudf/lists/detail/scatter.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ rmm::device_uvector<unbound_list_view> list_vector_from_column(
* @param scatter_map_end End iterator of scatter map
* @param source Source column view
* @param target Target column view
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
* @param mr Device memory resource used to allocate the returned column's device memory
* @return New lists column.
* @return New lists column
*/
template <typename MapIterator>
std::unique_ptr<column> scatter_impl(
Expand Down Expand Up @@ -158,9 +158,9 @@ std::unique_ptr<column> scatter_impl(
* @param scatter_map_begin Start iterator of scatter map
* @param scatter_map_end End iterator of scatter map
* @param target Target column view
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
* @param mr Device memory resource used to allocate the returned column's device memory
* @return New lists column.
* @return New lists column
*/
template <typename MapIterator>
std::unique_ptr<column> scatter(
Expand Down Expand Up @@ -215,9 +215,9 @@ std::unique_ptr<column> scatter(
* @param scatter_map_begin Start iterator of scatter map
* @param scatter_map_end End iterator of scatter map
* @param target Target column view
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
* @param mr Device memory resource used to allocate the returned column's device memory
* @return New lists column.
* @return New lists column
*/
template <typename MapIterator>
std::unique_ptr<column> scatter(
Expand Down
6 changes: 3 additions & 3 deletions cpp/include/cudf/lists/detail/sorting.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2021, NVIDIA CORPORATION.
* Copyright (c) 2021-2022, NVIDIA CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -26,7 +26,7 @@ namespace detail {
/**
* @copydoc cudf::lists::sort_lists
*
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> sort_lists(
lists_column_view const& input,
Expand All @@ -38,7 +38,7 @@ std::unique_ptr<column> sort_lists(
/**
* @copydoc cudf::lists::stable_sort_lists
*
* @param stream CUDA stream used for device memory operations and kernel launches.
* @param stream CUDA stream used for device memory operations and kernel launches
*/
std::unique_ptr<column> stable_sort_lists(
lists_column_view const& input,
Expand Down
Loading