From 049f90ebba2d7c6d81dba25d9ca5800140c86398 Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Wed, 22 Nov 2023 17:52:53 +0000 Subject: [PATCH 1/2] Enable doxygen XML generation and fix issues --- cpp/doxygen/Doxyfile | 2 +- cpp/include/cudf/io/text/byte_range_info.hpp | 4 ++-- cpp/include/cudf_test/column_utilities.hpp | 6 +++++- cpp/include/cudf_test/column_wrapper.hpp | 7 ++++++- 4 files changed, 14 insertions(+), 5 deletions(-) diff --git a/cpp/doxygen/Doxyfile b/cpp/doxygen/Doxyfile index 594119c10f2..4333699d1f6 100644 --- a/cpp/doxygen/Doxyfile +++ b/cpp/doxygen/Doxyfile @@ -2026,7 +2026,7 @@ MAN_LINKS = NO # captures the structure of the code including all documentation. # The default value is: NO. -GENERATE_XML = NO +GENERATE_XML = YES # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/cpp/include/cudf/io/text/byte_range_info.hpp b/cpp/include/cudf/io/text/byte_range_info.hpp index d20befec301..72a581a33fd 100644 --- a/cpp/include/cudf/io/text/byte_range_info.hpp +++ b/cpp/include/cudf/io/text/byte_range_info.hpp @@ -98,9 +98,9 @@ std::vector create_byte_range_infos_consecutive(int64_t total_b /** * @brief Create a byte_range_info which represents as much of a file as possible. Specifically, - * `[0, numeric_limit::max())`. + * ``[0, numeric_limits:\:max())``. * - * @return `[0, numeric_limit::max())` + * @return Byte range info of size ``[0, numeric_limits:\:max())`` */ byte_range_info create_byte_range_info_max(); diff --git a/cpp/include/cudf_test/column_utilities.hpp b/cpp/include/cudf_test/column_utilities.hpp index f6872fcdd6d..6231f8207f9 100644 --- a/cpp/include/cudf_test/column_utilities.hpp +++ b/cpp/include/cudf_test/column_utilities.hpp @@ -154,7 +154,7 @@ std::vector bitmask_to_host(cudf::column_view const& c); * This takes care of padded bits * * @param expected_mask A vector representing expected mask - * @param got_mask A vector representing mask obtained from column + * @param got_mask_begin A vector representing mask obtained from column * @param number_of_elements number of elements the mask represent * * @returns true if both vector match till the `number_of_elements` @@ -179,6 +179,9 @@ std::pair, std::vector> to_host(column_view return {host_data, bitmask_to_host(c)}; } +// This signature is identical to the above overload apart from SFINAE so +// doxygen sees it as a duplicate. +//! @cond Doxygen_Suppress /** * @brief Copies the data and bitmask of a `column_view` to the host. * @@ -207,6 +210,7 @@ std::pair, std::vector> to_host(column_view return {host_fixed_points, bitmask_to_host(c)}; } +//! @endcond /** * @brief Copies the data and bitmask of a `column_view` of strings diff --git a/cpp/include/cudf_test/column_wrapper.hpp b/cpp/include/cudf_test/column_wrapper.hpp index b9f2e0d9868..df62e47e4c4 100644 --- a/cpp/include/cudf_test/column_wrapper.hpp +++ b/cpp/include/cudf_test/column_wrapper.hpp @@ -177,6 +177,9 @@ rmm::device_buffer make_elements(InputIterator begin, InputIterator end) elements.data(), size * sizeof(ElementTo), cudf::test::get_default_stream()}; } +// The two signatures below are identical to the above overload apart from +// SFINAE so doxygen sees it as a duplicate. +//! @cond Doxygen_Suppress /** * @brief Creates a `device_buffer` containing the elements in the range `[begin,end)`. * @@ -231,6 +234,7 @@ rmm::device_buffer make_elements(InputIterator begin, InputIterator end) return rmm::device_buffer{ elements.data(), size * sizeof(RepType), cudf::test::get_default_stream()}; } +//! @endcond /** * @brief Create a `std::vector` containing a validity indicator bitmask using @@ -1569,7 +1573,8 @@ class lists_column_wrapper : public detail::column_wrapper { * while at the same time, allowing further nesting * List = { {{0, 1}} } * - * @param c Input column to be wrapped + * @param elements Input columns to be wrapped + * @param v The validity of each row * */ void build_from_nested(std::initializer_list> elements, From fd6adf872bf886c05fae2797b8aeba5e1d7a77ef Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Thu, 23 Nov 2023 01:32:41 +0000 Subject: [PATCH 2/2] Fix copyright --- cpp/include/cudf/io/text/byte_range_info.hpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpp/include/cudf/io/text/byte_range_info.hpp b/cpp/include/cudf/io/text/byte_range_info.hpp index 72a581a33fd..0086432d003 100644 --- a/cpp/include/cudf/io/text/byte_range_info.hpp +++ b/cpp/include/cudf/io/text/byte_range_info.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022, NVIDIA CORPORATION. + * Copyright (c) 2022-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.