Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable doxygen XML generation and fix issues #14477

Merged
merged 2 commits into from
Dec 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cpp/doxygen/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions cpp/include/cudf/io/text/byte_range_info.hpp
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -98,9 +98,9 @@ std::vector<byte_range_info> 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<int64_t>::max())`.
* ``[0, numeric_limits<int64_t>:\:max())``.
*
* @return `[0, numeric_limit<int64_t>::max())`
* @return Byte range info of size ``[0, numeric_limits<int64_t>:\:max())``
*/
byte_range_info create_byte_range_info_max();

Expand Down
6 changes: 5 additions & 1 deletion cpp/include/cudf_test/column_utilities.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ std::vector<bitmask_type> 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`
Expand All @@ -179,6 +179,9 @@ std::pair<thrust::host_vector<T>, std::vector<bitmask_type>> 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.
*
Expand Down Expand Up @@ -207,6 +210,7 @@ std::pair<thrust::host_vector<T>, std::vector<bitmask_type>> 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
Expand Down
7 changes: 6 additions & 1 deletion cpp/include/cudf_test/column_wrapper.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
karthikeyann marked this conversation as resolved.
Show resolved Hide resolved
/**
* @brief Creates a `device_buffer` containing the elements in the range `[begin,end)`.
*
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -1569,7 +1573,8 @@ class lists_column_wrapper : public detail::column_wrapper {
* while at the same time, allowing further nesting
* List<List<int> = { {{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<lists_column_wrapper<T, SourceElementT>> elements,
Expand Down