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 table_view_base doxygen format #11340

Merged
merged 8 commits into from
Jul 28, 2022
Merged

Fix table_view_base doxygen format #11340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ade4b36
Fix table_view_base doxygen format
davidwendt Jul 25, 2022
ea35b95
rewording to avoid plural of type
davidwendt Jul 25, 2022
a841f8c
Merge branch 'branch-22.10' into doc-table-view-base
davidwendt Jul 26, 2022
5c650fc
Merge branch 'branch-22.10' into doc-table-view-base
davidwendt Jul 26, 2022
5325e1e
make same changes to table_device_view_base doxygen
davidwendt Jul 26, 2022
9824698
Merge branch 'branch-22.10' into doc-table-view-base
davidwendt Jul 26, 2022
8c60514
Merge branch 'branch-22.10' into doc-table-view-base
davidwendt Jul 27, 2022
fd92bce
Merge branch 'branch-22.10' into doc-table-view-base
davidwendt Jul 27, 2022
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
11 changes: 7 additions & 4 deletions cpp/include/cudf/table/table_device_view.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,17 @@ namespace detail {
* @brief Base class for a device table of `ColumnDeviceView`s
*
* This class should not be used directly. Instead:
* -`table_device_view` should be used for a table of `column_device_view`s
* -`mutable_table_device_view` should be used for a table of `mutable_column__device_view`s
* - `table_device_view` should be used for a table of columns of type `column_device_view`
* - `mutable_table_device_view` should be used for a table of columns of type
* `mutable_column_device_view`
*
* All public constructors and member functions of `table_device_view_base` are
* available in both `table_device_view` and `mutable_table_device_view`.
*
* @tparam ColumnDeviceView The type of column device view the table contains
* @tparam HostTableView The type of table view used to create the table device view
* @tparam ColumnDeviceView The type of column device view the table contains:
* expects column_device_view or mutable_column_device_view
* @tparam HostTableView The type of table view used to create the table device view:
* expects table_view or mutable_table_view
*/
template <typename ColumnDeviceView, typename HostTableView>
class table_device_view_base {
Expand Down
7 changes: 4 additions & 3 deletions cpp/include/cudf/table/table_view.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,14 @@ namespace detail {
* @brief Base class for a table of `ColumnView`s
*
* This class should not be used directly. Instead:
* -`table_view` should be used for a table of `column_view`s
* -`mutable_table_view` should be used for a table of `mutable_column_view`s
* - `table_view` should be used for a table of columns of type `column_view`
* - `mutable_table_view` should be used for a table of columns of type `mutable_column_view`
*
* All public constructors and member functions of `table_view_base` are
* available in both `table_view` and `mutable_table_view`.
*
* @tparam ColumnView The type of column view the table contains
* @tparam ColumnView The type of column view the table contains:
* expects column_view or mutable_column_view
Comment on lines +47 to +48
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @tparam ColumnView The type of column view the table contains:
* expects column_view or mutable_column_view
* @tparam ColumnView The type of column view the table contains.
* Expects column_view or mutable_column_view

*/
template <typename ColumnView>
class table_view_base {
Expand Down