Skip to content

Commit

Permalink
Fix doxygen warnings in cudf/*.hpp (rapidsai#10896)
Browse files Browse the repository at this point in the history
Fixes parts of rapidsai#9373
added missing documentation to fix doxygen warnings in multiple files cpp/include/cudf/*.hpp
fixes 40 warnings

Authors:
  - Karthikeyan (https://github.com/karthikeyann)

Approvers:
  - David Wendt (https://github.com/davidwendt)
  - Bradley Dice (https://github.com/bdice)

URL: rapidsai#10896
  • Loading branch information
karthikeyann authored and ttnghia committed May 31, 2022
1 parent 8ff9c31 commit dfb6649
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions cpp/include/cudf/search.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ namespace cudf {
* result = { 3 }
* @endcode
*
* @param haystack The table containing search space.
* @param needles Values for which to find the insert locations in the search space.
* @param column_order Vector of column sort order.
* @param null_precedence Vector of null_precedence enums needles.
* @param mr Device memory resource used to allocate the returned column's device memory.
* @return A non-nullable column of cudf::size_type elements containing the insertion points.
* @param haystack The table containing search space
* @param needles Values for which to find the insert locations in the search space
* @param column_order Vector of column sort order
* @param null_precedence Vector of null_precedence enums needles
* @param mr Device memory resource used to allocate the returned column's device memory
* @return A non-nullable column of cudf::size_type elements containing the insertion points
*/
std::unique_ptr<column> lower_bound(
table_view const& haystack,
Expand Down Expand Up @@ -97,12 +97,12 @@ std::unique_ptr<column> lower_bound(
* result = { 5 }
* @endcode
*
* @param haystack The table containing search space.
* @param needles Values for which to find the insert locations in the search space.
* @param column_order Vector of column sort order.
* @param null_precedence Vector of null_precedence enums needles.
* @param mr Device memory resource used to allocate the returned column's device memory.
* @return A non-nullable column of cudf::size_type elements containing the insertion points.
* @param haystack The table containing search space
* @param needles Values for which to find the insert locations in the search space
* @param column_order Vector of column sort order
* @param null_precedence Vector of null_precedence enums needles
* @param mr Device memory resource used to allocate the returned column's device memory
* @return A non-nullable column of cudf::size_type elements containing the insertion points
*/
std::unique_ptr<column> upper_bound(
table_view const& haystack,
Expand All @@ -124,9 +124,9 @@ std::unique_ptr<column> upper_bound(
* result = true
* @endcode
*
* @param haystack The column containing search space.
* @param needle A scalar value to check for existence in the search space.
* @return true if the given `needle` value exists in the `haystack` column.
* @param haystack The column containing search space
* @param needle A scalar value to check for existence in the search space
* @return true if the given `needle` value exists in the `haystack` column
*/
bool contains(column_view const& haystack, scalar const& needle);

Expand All @@ -145,10 +145,10 @@ bool contains(column_view const& haystack, scalar const& needle);
* result = { true, true, false, false }
* @endcode
*
* @param haystack The column containing search space.
* @param needles A column of values to check for existence in the search space.
* @param mr Device memory resource used to allocate the returned column's device memory.
* @return A BOOL column indicating if each element in `needles` exists in the search space.
* @param haystack The column containing search space
* @param needles A column of values to check for existence in the search space
* @param mr Device memory resource used to allocate the returned column's device memory
* @return A BOOL column indicating if each element in `needles` exists in the search space
*/
std::unique_ptr<column> contains(
column_view const& haystack,
Expand Down

0 comments on commit dfb6649

Please sign in to comment.