This is an automated email from the ASF dual-hosted git repository.
apitrou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 3cc284f554 GH-46537: [Docs][C++] Add RunEndEncodedArray, FlatArray,
and PrimitiveArray API Docs (#46540)
3cc284f554 is described below
commit 3cc284f55411beae30d629e47f3bb95a07e69352
Author: Hiroyuki Sato <[email protected]>
AuthorDate: Thu May 22 20:29:13 2025 +0900
GH-46537: [Docs][C++] Add RunEndEncodedArray, FlatArray, and PrimitiveArray
API Docs (#46540)
### Rationale for this change
The [Array](https://arrow.apache.org/docs/cpp/api/array.html) section of
the API Doc
does not explain `FlatArray`, `PrimitiveArray`, and `RunEndEncodedArray` .
### What changes are included in this PR?
Add `FlatArray`, `PrimitiveArray`, and `RunEndEncodedArray` API docs
### Are these changes tested?
No. (Document only)
### Are there any user-facing changes?
No.
* GitHub Issue: #46537
Authored-by: Hiroyuki Sato <[email protected]>
Signed-off-by: Antoine Pitrou <[email protected]>
---
docs/source/cpp/api/array.rst | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/docs/source/cpp/api/array.rst b/docs/source/cpp/api/array.rst
index 43601fc2ff..91aa5da673 100644
--- a/docs/source/cpp/api/array.rst
+++ b/docs/source/cpp/api/array.rst
@@ -34,6 +34,14 @@ Base classes
:project: arrow_cpp
:members:
+.. doxygenclass:: arrow::FlatArray
+ :project: arrow_cpp
+ :members:
+
+.. doxygenclass:: arrow::PrimitiveArray
+ :project: arrow_cpp
+ :members:
+
Factory functions
=================
@@ -84,6 +92,11 @@ Extension arrays
.. doxygenclass:: arrow::ExtensionArray
:members:
+Run-End Encoded Array
+---------------------
+
+.. doxygenclass:: arrow::RunEndEncodedArray
+ :members:
Chunked Arrays
==============
