Fix Doxygen warnings in strings / header files

cpp/include/cudf/strings/attributes.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, NVIDIA CORPORATION.
+ * Copyright (c) 2019-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.
@@ -39,8 +39,8 @@ namespace strings {
  *
  * Any null string will result in a null entry for that row in the output column.
  *
- * @param strings Strings instance for this operation.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param strings Strings instance for this operation
+ * @param mr Device memory resource used to allocate the returned column's device memory
  * @return New INT32 column with lengths for each string.
  */
 std::unique_ptr<column> count_characters(
@@ -57,8 +57,8 @@ std::unique_ptr<column> count_characters(
  *
  * Any null string will result in a null entry for that row in the output column.
  *
- * @param strings Strings instance for this operation.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param strings Strings instance for this operation
+ * @param mr Device memory resource used to allocate the returned column's device memory
  * @return New INT32 column with the number of bytes for each string.
  */
 std::unique_ptr<column> count_bytes(
@@ -77,8 +77,8 @@ std::unique_ptr<column> count_bytes(
  *
  * Any null string is ignored. No null entries will appear in the output column.
  *
- * @param strings Strings instance for this operation.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param strings Strings instance for this operation
+ * @param mr Device memory resource used to allocate the returned column's device memory
  * @return New INT32 column with code point integer values for each character.
  */
 std::unique_ptr<column> code_points(

cpp/include/cudf/strings/capitalize.hpp

@@ -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.
@@ -50,8 +50,8 @@ namespace strings {
  *
  * @throw cudf::logic_error if `delimiter.is_valid()` is  `false`.
  *
- * @param input String column.
- * @param delimiters Characters for identifying words to capitalize.
+ * @param input String column
+ * @param delimiters Characters for identifying words to capitalize
  * @param mr Device memory resource used to allocate the returned column's device memory
  * @return Column of strings capitalized from the input column.
  */
@@ -81,8 +81,8 @@ std::unique_ptr<column> capitalize(
  *
  * Any null string entries return corresponding null output column entries.
  *
- * @param input String column.
- * @param sequence_type The character type that is used when identifying words.
+ * @param input String column
+ * @param sequence_type The character type that is used when identifying words
  * @param mr Device memory resource used to allocate the returned column's device memory
  * @return Column of titled strings.
  */
@@ -110,7 +110,7 @@ std::unique_ptr<column> title(
  *
  * Any null string entries result in corresponding null output column entries.
  *
- * @param input String column.
+ * @param input String column
  * @param mr Device memory resource used to allocate the returned column's device memory
  * @return Column of type BOOL8.
  */

cpp/include/cudf/strings/case.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, NVIDIA CORPORATION.
+ * Copyright (c) 2019-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.
@@ -35,8 +35,8 @@ namespace strings {
  *
  * Any null entries create null entries in the output column.
  *
- * @param strings Strings instance for this operation.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param strings Strings instance for this operation
+ * @param mr Device memory resource used to allocate the returned column's device memory
  * @return New column of strings with characters converted.
  */
 std::unique_ptr<column> to_lower(
@@ -52,8 +52,8 @@ std::unique_ptr<column> to_lower(
  *
  * Any null entries create null entries in the output column.
  *
- * @param strings Strings instance for this operation.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param strings Strings instance for this operation
+ * @param mr Device memory resource used to allocate the returned column's device memory
  * @return New column of strings with characters converted.
  */
 std::unique_ptr<column> to_upper(
@@ -70,8 +70,8 @@ std::unique_ptr<column> to_upper(
  *
  * Any null entries create null entries in the output column.
  *
- * @param strings Strings instance for this operation.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param strings Strings instance for this operation
+ * @param mr Device memory resource used to allocate the returned column's device memory
  * @return New column of strings with characters converted.
  */
 std::unique_ptr<column> swapcase(

cpp/include/cudf/strings/char_types/char_types.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2021, NVIDIA CORPORATION.
+ * Copyright (c) 2019-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.
@@ -51,11 +51,19 @@ enum string_character_types : uint32_t {
 
 /**
  * @brief OR operator for combining string_character_types
+ *
+ * @param lhs left-hand side of OR operation
+ * @param rhs right-hand side of OR operation
+ * @return combined string_character_types
  */
 string_character_types operator|(string_character_types lhs, string_character_types rhs);
 
 /**
  * @brief Compound assignment OR operator for combining string_character_types
+ *
+ * @param lhs left-hand side of OR operation
+ * @param rhs right-hand side of OR operation
+ * @return Reference to `lhs` after combining `lhs` and `rhs`
  */
 string_character_types& operator|=(string_character_types& lhs, string_character_types rhs);
 
@@ -82,12 +90,12 @@ string_character_types& operator|=(string_character_types& lhs, string_character
  *
  * Any null row results in a null entry for that row in the output column.
  *
- * @param strings Strings instance for this operation.
- * @param types The character types to check in each string.
+ * @param strings Strings instance for this operation
+ * @param types The character types to check in each string
  * @param verify_types Only verify against these character types.
  *                     Default `ALL_TYPES` means return `true`
  *                     iff all characters match `types`.
- * @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 column of boolean results for each string.
  */
 std::unique_ptr<column> all_characters_of_type(
@@ -125,13 +133,13 @@ std::unique_ptr<column> all_characters_of_type(
  * @throw cudf::logic_error if neither or both `types_to_remove` and
  *        `types_to_keep` are set to `ALL_TYPES`.
  *
- * @param strings Strings instance for this operation.
- * @param types_to_remove The character types to check in each string.
+ * @param strings Strings instance for this operation
+ * @param types_to_remove The character types to check in each string
  *        Use `ALL_TYPES` here to specify `types_to_keep` instead.
- * @param replacement The replacement character to use when removing characters.
+ * @param replacement The replacement character to use when removing characters
  * @param types_to_keep Default `ALL_TYPES` means all characters of
  *        `types_to_remove` will be filtered.
- * @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 column of boolean results for each string.
  */
 std::unique_ptr<column> filter_characters_of_type(

cpp/include/cudf/strings/combine.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2021, NVIDIA CORPORATION.
+ * Copyright (c) 2019-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.
@@ -64,12 +64,12 @@ enum class output_if_empty_list {
  *
  * @throw cudf::logic_error if separator is not valid.
  *
- * @param strings Strings for this operation.
+ * @param strings Strings for this operation
  * @param separator String that should inserted between each string.
  *        Default is an empty string.
  * @param narep String that should represent any null strings found.
  *        Default of invalid-scalar will ignore any null entries.
- * @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 column containing one string.
  */
 std::unique_ptr<column> join_strings(
@@ -125,7 +125,7 @@ std::unique_ptr<column> join_strings(
  * @throw cudf::logic_error if the number of rows from @p separators and @p strings_columns
  *                          do not match
  *
- * @param strings_columns List of strings columns to concatenate.
+ * @param strings_columns List of strings columns to concatenate
  * @param separators Strings column that provides the separator for a given row
  * @param separator_narep String that should be used in place of a null separator for a given
  *        row. Default of invalid-scalar means no row separator value replacements.
@@ -135,7 +135,7 @@ std::unique_ptr<column> join_strings(
  *        Default is an invalid string.
  * @param separate_nulls If YES, then the separator is included for null rows
  *        if `col_narep` is valid.
- * @param mr Resource for allocating device memory.
+ * @param mr Resource for allocating device memory
  * @return New column with concatenated results.
  */
 std::unique_ptr<column> concatenate(
@@ -182,14 +182,14 @@ std::unique_ptr<column> concatenate(
  * @throw cudf::logic_error if separator is not valid.
  * @throw cudf::logic_error if only one column is specified
  *
- * @param strings_columns List of string columns to concatenate.
+ * @param strings_columns List of string columns to concatenate
  * @param separator String that should inserted between each string from each row.
  *        Default is an empty string.
  * @param narep String that should be used in place of any null strings
  *        found in any column. Default of invalid-scalar means any null entry in any column will
  *        produces a null result for that row.
- * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid
+ * @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(
@@ -241,18 +241,18 @@ std::unique_ptr<column> concatenate(
  * @throw cudf::logic_error if the number of rows from `separators` and `lists_strings_column` do
  *        not match
  *
- * @param lists_strings_column Column containing lists of strings to concatenate.
- * @param separators Strings column that provides separators for concatenation.
+ * @param lists_strings_column Column containing lists of strings to concatenate
+ * @param separators Strings column that provides separators for concatenation
  * @param separator_narep String that should be used to replace null separator, default is an
  *        invalid-scalar denoting that rows containing null separator will result in null string in
  *        the corresponding output rows.
  * @param string_narep String that should be used to replace null strings in any non-null list row,
  *        default is an invalid-scalar denoting that list rows containing null strings will result
  *        in null string in the corresponding output rows.
- * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid.
+ * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid
  * @param empty_list_policy if set to EMPTY_STRING, any input row that is an empty list will
  *        result in an empty string. Otherwise, it will result in a null.
- * @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 strings column with concatenated results.
  */
 std::unique_ptr<column> join_list_elements(
@@ -301,16 +301,16 @@ std::unique_ptr<column> join_list_elements(
  * @throw cudf::logic_error if input column is not lists of strings column.
  * @throw cudf::logic_error if separator is not valid.
  *
- * @param lists_strings_column Column containing lists of strings to concatenate.
+ * @param lists_strings_column Column containing lists of strings to concatenate
  * @param separator String that should inserted between strings of each list row, default is an
  *        empty string.
  * @param narep String that should be used to replace null strings in any non-null list row, default
  *        is an invalid-scalar denoting that list rows containing null strings will result in null
  *        string in the corresponding output rows.
- * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid.
+ * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid
  * @param empty_list_policy if set to EMPTY_STRING, any input row that is an empty list will result
  *        in an empty string. Otherwise, it will result in a null.
- * @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 strings column with concatenated results.
  */
 std::unique_ptr<column> join_list_elements(

cpp/include/cudf/strings/contains.hpp

@@ -43,10 +43,10 @@ namespace strings {
  *
  * See the @ref md_regex "Regex Features" page for details on patterns supported by this API.
  *
- * @param strings Strings instance for this operation.
- * @param pattern Regex pattern to match to each string.
- * @param flags Regex flags for interpreting special characters in the pattern.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param strings Strings instance for this operation
+ * @param pattern Regex pattern to match to each string
+ * @param flags Regex flags for interpreting special characters in the pattern
+ * @param mr Device memory resource used to allocate the returned column's device memory
  * @return New column of boolean results for each string.
  */
 std::unique_ptr<column> contains_re(
@@ -70,10 +70,10 @@ std::unique_ptr<column> contains_re(
  *
  * See the @ref md_regex "Regex Features" page for details on patterns supported by this API.
  *
- * @param strings Strings instance for this operation.
- * @param pattern Regex pattern to match to each string.
- * @param flags Regex flags for interpreting special characters in the pattern.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param strings Strings instance for this operation
+ * @param pattern Regex pattern to match to each string
+ * @param flags Regex flags for interpreting special characters in the pattern
+ * @param mr Device memory resource used to allocate the returned column's device memory
  * @return New column of boolean results for each string.
  */
 std::unique_ptr<column> matches_re(
@@ -97,10 +97,10 @@ std::unique_ptr<column> matches_re(
  *
  * See the @ref md_regex "Regex Features" page for details on patterns supported by this API.
  *
- * @param strings Strings instance for this operation.
- * @param pattern Regex pattern to match within each string.
- * @param flags Regex flags for interpreting special characters in the pattern.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param strings Strings instance for this operation
+ * @param pattern Regex pattern to match within each string
+ * @param flags Regex flags for interpreting special characters in the pattern
+ * @param mr Device memory resource used to allocate the returned column's device memory
  * @return New INT32 column with counts for each string.
  */
 std::unique_ptr<column> count_re(

cpp/include/cudf/strings/convert/convert_booleans.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, NVIDIA CORPORATION.
+ * Copyright (c) 2019-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.
@@ -33,9 +33,9 @@ namespace strings {
  *
  * Any null entries will result in corresponding null entries in the output column.
  *
- * @param strings Strings instance for this operation.
- * @param true_string String to expect for true. Non-matching strings are false.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param strings Strings instance for this operation
+ * @param true_string String to expect for true. Non-matching strings are false
+ * @param mr Device memory resource used to allocate the returned column's device memory
  * @return New BOOL8 column converted from strings.
  */
 std::unique_ptr<column> to_booleans(
@@ -51,10 +51,10 @@ std::unique_ptr<column> to_booleans(
  *
  * @throw cudf::logic_error if the input column is not BOOL8 type.
  *
- * @param booleans Boolean column to convert.
- * @param true_string String to use for true in the output column.
- * @param false_string String to use for false in the output column.
- * @param mr Device memory resource used to allocate the returned column's device memory.
+ * @param booleans Boolean column to convert
+ * @param true_string String to use for true in the output column
+ * @param false_string String to use for false in the output column
+ * @param mr Device memory resource used to allocate the returned column's device memory
  * @return New strings column.
  */
 std::unique_ptr<column> from_booleans(