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

Fix Doxygen warnings in column header files #10963

Merged
merged 7 commits into from
Jun 5, 2022
Merged
Show file tree
Hide file tree
Changes from 5 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
16 changes: 12 additions & 4 deletions cpp/include/cudf/column/column.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2019-2021, NVIDIA CORPORATION.
* Copyright (c) 2019-2022, 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 @@ -121,11 +121,15 @@ class column {

/**
* @brief Returns the column's logical element type
*
* @return The column's logical element type
*/
[[nodiscard]] data_type type() const noexcept { return _type; }

/**
* @brief Returns the number of elements
*
* @return The number of elements
*/
[[nodiscard]] size_type size() const noexcept { return _size; }

Expand All @@ -136,6 +140,8 @@ class column {
* point `set_null_count(UNKNOWN_NULL_COUNT)` was invoked, then the
* first invocation of `null_count()` will compute and store the count of null
* elements indicated by the `null_mask` (if it exists).
*
* @return The number of null elements
*/
[[nodiscard]] size_type null_count() const;

Expand Down Expand Up @@ -211,6 +217,8 @@ class column {

/**
* @brief Returns the number of child columns
*
* @return The number of child columns
*/
[[nodiscard]] size_type num_children() const noexcept { return _children.size(); }

Expand Down Expand Up @@ -239,9 +247,9 @@ class column {
* Returned by `column::release()`.
*/
struct contents {
std::unique_ptr<rmm::device_buffer> data;
std::unique_ptr<rmm::device_buffer> null_mask;
std::vector<std::unique_ptr<column>> children;
std::unique_ptr<rmm::device_buffer> data; ///< data device memory buffer
std::unique_ptr<rmm::device_buffer> null_mask; ///< null mask device memory buffer
std::vector<std::unique_ptr<column>> children; ///< child columns
};

/**
Expand Down
Loading