Skip to content

Commit

Permalink
Fix Doxygen warnings in column header files (#10963)
Browse files Browse the repository at this point in the history
Fixes parts of #9373
added missing documentation to fix doxygen warnings in column, column_view, column_device_view, column factories headers

fixes 155 warnings.

Authors:
  - Karthikeyan (https://github.com/karthikeyann)

Approvers:
  - Vyas Ramasubramani (https://github.com/vyasr)
  - Bradley Dice (https://github.com/bdice)

URL: #10963
  • Loading branch information
karthikeyann authored Jun 5, 2022
1 parent 22e3b7c commit 840fc87
Show file tree
Hide file tree
Showing 4 changed files with 246 additions and 30 deletions.
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

0 comments on commit 840fc87

Please sign in to comment.