Skip to content

Commit

Permalink
Fix doxygen Modules page for cudf::lists::sequences (NVIDIA#10561)
Browse files Browse the repository at this point in the history
Corrects the [Modules](https://docs.rapids.ai/api/libcudf/nightly/modules.html) page where the `lists_filling` group appears at the bottom:
![image](https://user-images.githubusercontent.com/45795991/161142554-b78b8c2b-49dd-4958-8d2f-df3aa1720b86.png)

The `lists_filling` group is added to the appropriate section in the [`doxygen_groups.h`](https://github.com/rapidsai/cudf/blob/branch-22.06/cpp/include/doxygen_groups.h) file.

Also added a doxygen description for `namespace lists` so it will appear in the [Namespace List](https://docs.rapids.ai/api/libcudf/nightly/namespaces.html) page. This becomes an easy way to find the documentation fo all the `lists` APIs.

Authors:
  - David Wendt (https://github.com/davidwendt)

Approvers:
  - Nghia Truong (https://github.com/ttnghia)
  - https://github.com/nvdbaranec

URL: rapidsai/cudf#10561
  • Loading branch information
davidwendt authored Apr 4, 2022
1 parent d7602c3 commit adec535
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 3 additions & 1 deletion cpp/include/cudf/lists/combine.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2021, NVIDIA CORPORATION.
* Copyright (c) 2021-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 All @@ -19,6 +19,8 @@
#include <cudf/lists/lists_column_view.hpp>

namespace cudf {

//! Lists column APIs
namespace lists {
/**
* @addtogroup lists_combine
Expand Down
3 changes: 2 additions & 1 deletion cpp/include/doxygen_groups.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2021, NVIDIA CORPORATION.
* Copyright (c) 2021-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 @@ -146,6 +146,7 @@
* @{
* @defgroup lists_combine Combining
* @defgroup lists_extract Extracting
* @defgroup lists_filling Filling
* @defgroup lists_contains Searching
* @defgroup lists_gather Gathering
* @defgroup lists_elements Counting
Expand Down

0 comments on commit adec535

Please sign in to comment.