Some doxygen improvements (#14469)

This PR fixes some errors in the doxygen docs and adds groups for some items that were previously missing altogether.

Authors:
  - Vyas Ramasubramani (https://github.com/vyasr)

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

URL: #14469

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

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<true> {};

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<column> 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<column> 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.

cpp/include/cudf/io/types.hpp

@@ -44,6 +44,12 @@ class datasource;
 namespace cudf {
 //! IO interfaces
 namespace io {
+/**
+ * @addtogroup io_types
+ * @{
+ * @file
+ */
+
 /**
  * @brief Compression algorithms
  */
@@ -938,5 +944,6 @@ class reader_column_schema {
   [[nodiscard]] size_t get_num_children() const { return children.size(); }
 };
 
+/** @} */  // end of group
 }  // namespace io
 }  // namespace cudf

cpp/include/cudf/lists/lists_column_view.hpp

@@ -83,15 +83,15 @@ 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;
 
   /**
    * @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
    */

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;

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

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 <rmm/cuda_stream_view.hpp>
 
 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

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 <typename T>
@@ -318,6 +325,7 @@ struct device_span : public cudf::detail::span_base<T, Extent, device_span<T, Ex
   {
   }
 };
+/** @} */  // end of group
 
 namespace detail {
 

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
@@ -179,9 +180,11 @@
  *   @defgroup utility_dispatcher Type Dispatcher
  *   @defgroup utility_bitmask Bitmask
  *   @defgroup utility_error Exception
+ *   @defgroup utility_span Exception
  * @}
  * @defgroup labeling_apis Labeling
  * @{
  *   @defgroup label_bins Bin Labeling
  * @}
+ * @defgroup expressions Expression Evaluation
  */