From a83db9625699d74ab952d50b651f6a4a2dc2a6dd Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Wed, 8 Nov 2023 15:33:24 -0800 Subject: [PATCH 1/8] Add the default stream to a group and link it --- cpp/include/cudf/utilities/default_stream.hpp | 8 +++++++- cpp/include/doxygen_groups.h | 1 + 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/cpp/include/cudf/utilities/default_stream.hpp b/cpp/include/cudf/utilities/default_stream.hpp index 1eec3b994d0..aacab996e8a 100644 --- a/cpp/include/cudf/utilities/default_stream.hpp +++ b/cpp/include/cudf/utilities/default_stream.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2022, NVIDIA CORPORATION. + * Copyright (c) 2020-2023, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -22,6 +22,11 @@ #include namespace cudf { +/** + * @addtogroup default_stream + * @{ + * @file + */ /** * @brief Get the current default stream @@ -37,4 +42,5 @@ rmm::cuda_stream_view const get_default_stream(); */ bool is_ptds_enabled(); +/** @} */ // end of group } // namespace cudf diff --git a/cpp/include/doxygen_groups.h b/cpp/include/doxygen_groups.h index 8845b84613d..356b1a10cf1 100644 --- a/cpp/include/doxygen_groups.h +++ b/cpp/include/doxygen_groups.h @@ -29,6 +29,7 @@ // Add a new group by first specifying in the hierarchy below. /** + * @defgroup default_stream Default Stream * @defgroup cudf_classes Classes * @{ * @defgroup column_classes Column From 47a9877780c9012d3259b202bdf1433463a27a4f Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Thu, 9 Nov 2023 14:36:21 -0800 Subject: [PATCH 2/8] Fix incorrect docs of cudf::logic_error --- cpp/include/cudf/lists/lists_column_view.hpp | 6 +++--- cpp/include/cudf/strings/strings_column_view.hpp | 4 ++-- cpp/include/cudf/structs/structs_column_view.hpp | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/cpp/include/cudf/lists/lists_column_view.hpp b/cpp/include/cudf/lists/lists_column_view.hpp index 8c6368eacb6..57a4f724c2d 100644 --- a/cpp/include/cudf/lists/lists_column_view.hpp +++ b/cpp/include/cudf/lists/lists_column_view.hpp @@ -83,7 +83,7 @@ class lists_column_view : private column_view { /** * @brief Returns the internal column of offsets * - * @throw cudf::logic error if this is an empty column + * @throw cudf::logic_error if this is an empty column * @return The internal column of offsets */ [[nodiscard]] column_view offsets() const; @@ -91,7 +91,7 @@ class lists_column_view : private column_view { /** * @brief Returns the internal child column * - * @throw cudf::logic error if this is an empty column + * @throw cudf::logic_error if this is an empty column * @return The internal child column */ [[nodiscard]] column_view child() const; @@ -104,7 +104,7 @@ class lists_column_view : private column_view { * the child columns when recursing. Most functions operating in a recursive manner * on lists columns should be using `get_sliced_child()` instead of `child()`. * - * @throw cudf::logic error if this is an empty column + * @throw cudf::logic_error if this is an empty column * @param stream CUDA stream used for device memory operations and kernel launches * @return A sliced child column view */ diff --git a/cpp/include/cudf/strings/strings_column_view.hpp b/cpp/include/cudf/strings/strings_column_view.hpp index f1aa8e49f00..e27d32fceb9 100644 --- a/cpp/include/cudf/strings/strings_column_view.hpp +++ b/cpp/include/cudf/strings/strings_column_view.hpp @@ -80,7 +80,7 @@ class strings_column_view : private column_view { /** * @brief Returns the internal column of offsets * - * @throw cudf::logic error if this is an empty column + * @throw cudf::logic_error if this is an empty column * @return The offsets column */ [[nodiscard]] column_view offsets() const; @@ -106,7 +106,7 @@ class strings_column_view : private column_view { /** * @brief Returns the internal column of chars * - * @throw cudf::logic error if this is an empty column + * @throw cudf::logic_error if this is an empty column * @return The chars column */ [[nodiscard]] column_view chars() const; diff --git a/cpp/include/cudf/structs/structs_column_view.hpp b/cpp/include/cudf/structs/structs_column_view.hpp index 6a9f2890177..4a50488ef00 100644 --- a/cpp/include/cudf/structs/structs_column_view.hpp +++ b/cpp/include/cudf/structs/structs_column_view.hpp @@ -87,7 +87,7 @@ class structs_column_view : public column_view { * the child columns when recursing. Most functions operating in a recursive manner * on struct columns should be using `get_sliced_child()` instead of `child()`. * - * @throw cudf::logic error if this is an empty column + * @throw cudf::logic_error if this is an empty column * * @param index The index of the child column to return * @param stream The stream on which to perform the operation. Uses the default CUDF From f9cd014d01df4fdca96f2e5d46cc8ccfd483bc57 Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Thu, 9 Nov 2023 16:20:56 -0800 Subject: [PATCH 3/8] Add documentation of AST expressions --- cpp/include/cudf/ast/expressions.hpp | 6 ++++++ cpp/include/doxygen_groups.h | 1 + 2 files changed, 7 insertions(+) diff --git a/cpp/include/cudf/ast/expressions.hpp b/cpp/include/cudf/ast/expressions.hpp index c5172486fa6..26916e49012 100644 --- a/cpp/include/cudf/ast/expressions.hpp +++ b/cpp/include/cudf/ast/expressions.hpp @@ -25,6 +25,11 @@ namespace cudf { namespace ast { +/** + * @addtogroup expressions + * @{ + * @file + */ // Forward declaration. namespace detail { @@ -544,6 +549,7 @@ class column_name_reference : public expression { std::string column_name; }; +/** @} */ // end of group } // namespace ast } // namespace cudf diff --git a/cpp/include/doxygen_groups.h b/cpp/include/doxygen_groups.h index 356b1a10cf1..2e7ce5c363e 100644 --- a/cpp/include/doxygen_groups.h +++ b/cpp/include/doxygen_groups.h @@ -185,4 +185,5 @@ * @{ * @defgroup label_bins Bin Labeling * @} + * @defgroup expressions Expression Evaluation */ From 038ecaee18df37517c749f5340d36edb218ff27c Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Thu, 9 Nov 2023 16:28:08 -0800 Subject: [PATCH 4/8] Add doxygen group for io types --- cpp/include/cudf/io/types.hpp | 13 +++++++------ cpp/include/doxygen_groups.h | 1 + 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/cpp/include/cudf/io/types.hpp b/cpp/include/cudf/io/types.hpp index 50119e60882..dcb2ec7f770 100644 --- a/cpp/include/cudf/io/types.hpp +++ b/cpp/include/cudf/io/types.hpp @@ -37,13 +37,13 @@ namespace cudf { namespace io { class data_sink; class datasource; -} // namespace io -} // namespace cudf -//! cuDF interfaces -namespace cudf { -//! IO interfaces -namespace io { +/** + * @addtogroup io_types + * @{ + * @file + */ + /** * @brief Compression algorithms */ @@ -938,5 +938,6 @@ class reader_column_schema { [[nodiscard]] size_t get_num_children() const { return children.size(); } }; +/** @} */ // end of group } // namespace io } // namespace cudf diff --git a/cpp/include/doxygen_groups.h b/cpp/include/doxygen_groups.h index 2e7ce5c363e..8732c4fa082 100644 --- a/cpp/include/doxygen_groups.h +++ b/cpp/include/doxygen_groups.h @@ -141,6 +141,7 @@ * @} * @defgroup io_apis IO * @{ + * @defgroup io_types Readers * @defgroup io_readers Readers * @defgroup io_writers Writers * @defgroup io_datasources Data Sources From 7042ed32e1a20aa6f3f0e3359bc2e52fbc9d8e8f Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Thu, 9 Nov 2023 17:02:13 -0800 Subject: [PATCH 5/8] Add nullate to docs --- cpp/include/cudf/column/column_device_view.cuh | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cpp/include/cudf/column/column_device_view.cuh b/cpp/include/cudf/column/column_device_view.cuh index b1ff0bbaea7..daee443a5f3 100644 --- a/cpp/include/cudf/column/column_device_view.cuh +++ b/cpp/include/cudf/column/column_device_view.cuh @@ -52,6 +52,8 @@ namespace cudf { * If used at compile-time, this indicator can tell the optimizer * to include or exclude any null-checking clauses. * + * @ingroup column_classes + * */ struct nullate { struct YES : std::bool_constant {}; From aa44af77456ad3577cab417c0dec6fe1b3648c2c Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Thu, 9 Nov 2023 17:41:28 -0800 Subject: [PATCH 6/8] Fix some more logic_error typos --- cpp/include/cudf/dictionary/update_keys.hpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/cpp/include/cudf/dictionary/update_keys.hpp b/cpp/include/cudf/dictionary/update_keys.hpp index 81728e1ff73..40504c22edd 100644 --- a/cpp/include/cudf/dictionary/update_keys.hpp +++ b/cpp/include/cudf/dictionary/update_keys.hpp @@ -46,9 +46,9 @@ namespace dictionary { * Null entries from the input column are copied to the output column. * No new null entries are created by this operation. * - * @throw cudf_logic_error if the new_keys type does not match the keys type in + * @throw cudf::logic_error if the new_keys type does not match the keys type in * the dictionary_column. - * @throw cudf_logic_error if the new_keys contain nulls. + * @throw cudf::logic_error if the new_keys contain nulls. * * @param dictionary_column Existing dictionary column. * @param new_keys New keys to incorporate into the dictionary_column. @@ -78,9 +78,9 @@ std::unique_ptr add_keys( * @endcode * Note that "a" has been removed so output row[2] becomes null. * - * @throw cudf_logic_error if the keys_to_remove type does not match the keys type in + * @throw cudf::logic_error if the keys_to_remove type does not match the keys type in * the dictionary_column. - * @throw cudf_logic_error if the keys_to_remove contain nulls. + * @throw cudf::logic_error if the keys_to_remove contain nulls. * * @param dictionary_column Existing dictionary column. * @param keys_to_remove The keys to remove from the dictionary_column. @@ -134,9 +134,9 @@ std::unique_ptr remove_unused_keys( * d2 is now {keys=["b", "c", "d"], indices=[1, x, 0, 1, 0], valids=[1, 0, 1, 1, 1]} * @endcode * - * @throw cudf_logic_error if the keys type does not match the keys type in + * @throw cudf::logic_error if the keys type does not match the keys type in * the dictionary_column. - * @throw cudf_logic_error if the keys contain nulls. + * @throw cudf::logic_error if the keys contain nulls. * * @param dictionary_column Existing dictionary column. * @param keys New keys to use for the output column. Must not contain nulls. From ddbef0333b1b6bc34e96c7808385b9d5baa97988 Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Tue, 21 Nov 2023 23:06:02 +0000 Subject: [PATCH 7/8] Add span group --- cpp/include/cudf/utilities/span.hpp | 8 ++++++++ cpp/include/doxygen_groups.h | 1 + 2 files changed, 9 insertions(+) diff --git a/cpp/include/cudf/utilities/span.hpp b/cpp/include/cudf/utilities/span.hpp index 3e5f6e3e97a..a6190ee02cb 100644 --- a/cpp/include/cudf/utilities/span.hpp +++ b/cpp/include/cudf/utilities/span.hpp @@ -185,6 +185,13 @@ class span_base { } // namespace detail +/** + * @addtogroup utility_span + * @{ + * @file + * @brief APIs for labeling values by bin. + */ + // ===== host_span ================================================================================= template @@ -318,6 +325,7 @@ struct device_span : public cudf::detail::span_base Date: Wed, 22 Nov 2023 01:45:19 +0000 Subject: [PATCH 8/8] Put back old groupings --- cpp/include/cudf/io/types.hpp | 6 ++++++ cpp/include/doxygen_groups.h | 1 - 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/cpp/include/cudf/io/types.hpp b/cpp/include/cudf/io/types.hpp index dcb2ec7f770..d790f869e22 100644 --- a/cpp/include/cudf/io/types.hpp +++ b/cpp/include/cudf/io/types.hpp @@ -37,7 +37,13 @@ namespace cudf { namespace io { class data_sink; class datasource; +} // namespace io +} // namespace cudf +//! cuDF interfaces +namespace cudf { +//! IO interfaces +namespace io { /** * @addtogroup io_types * @{ diff --git a/cpp/include/doxygen_groups.h b/cpp/include/doxygen_groups.h index 8a74432aaff..8a85b6daeca 100644 --- a/cpp/include/doxygen_groups.h +++ b/cpp/include/doxygen_groups.h @@ -141,7 +141,6 @@ * @} * @defgroup io_apis IO * @{ - * @defgroup io_types Readers * @defgroup io_readers Readers * @defgroup io_writers Writers * @defgroup io_datasources Data Sources