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.

Sign up for GitHub

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

Fix doxygen groups for io data sources and sinks #13718

Merged
merged 1 commit into from
Jul 18, 2023
Merged

Fix doxygen groups for io data sources and sinks #13718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions cpp/include/cudf/io/data_sink.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@
namespace cudf {
//! IO interfaces
namespace io {

/**
* @addtogroup io_datasinks
* @{
* @file
*/

/**
* @brief Interface class for storing the output data from the writers
*/
Expand Down Expand Up @@ -200,5 +207,6 @@ class data_sink {
virtual size_t bytes_written() = 0;
};

/** @} */ // end of group
} // namespace io
} // namespace cudf
7 changes: 7 additions & 0 deletions cpp/include/cudf/io/datasource.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ namespace cudf {
//! IO interfaces
namespace io {

/**
* @addtogroup io_datasources
* @{
* @file
*/

/**
* @brief Interface class for providing input data to the readers.
*/
Expand Down Expand Up @@ -508,5 +514,6 @@ class arrow_io_source : public datasource {
std::shared_ptr<arrow::io::RandomAccessFile> arrow_file;
};

/** @} */ // end of group
} // namespace io
} // namespace cudf
3 changes: 2 additions & 1 deletion cpp/include/doxygen_groups.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,10 @@
* @}
* @defgroup io_apis IO
* @{
* @defgroup io_datasources Datasources
* @defgroup io_readers Readers
* @defgroup io_writers Writers
* @defgroup io_datasources Data Sources
* @defgroup io_datasinks Data Sinks
* @}
* @defgroup lists_apis Lists
* @{
Expand Down