Skip to content

Commit 702de09

Browse files
GH-46318: [Docs][C++] Add Extension Array/Type documents (#46319)
### Rationale for this change There are no Extension Array/Type documentation in the [API Reference page](https://arrow.apache.org/docs/cpp/api.html). ### What changes are included in this PR? Add Extension Array / Type API documents. ### Are these changes tested? No. (Add document only) ### Are there any user-facing changes? No. * GitHub Issue: #46318 Authored-by: Hiroyuki Sato <hiroysato@gmail.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
1 parent 7d985a2 commit 702de09

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed

docs/source/cpp/api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ API Reference
2727
api/thread
2828
api/datatype
2929
api/array
30+
api/extension
3031
api/scalar
3132
api/builder
3233
api/table

docs/source/cpp/api/extension.rst

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
.. or more contributor license agreements. See the NOTICE file
3+
.. distributed with this work for additional information
4+
.. regarding copyright ownership. The ASF licenses this file
5+
.. to you under the Apache License, Version 2.0 (the
6+
.. "License"); you may not use this file except in compliance
7+
.. with the License. You may obtain a copy of the License at
8+
9+
.. http://www.apache.org/licenses/LICENSE-2.0
10+
11+
.. Unless required by applicable law or agreed to in writing,
12+
.. software distributed under the License is distributed on an
13+
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
.. KIND, either express or implied. See the License for the
15+
.. specific language governing permissions and limitations
16+
.. under the License.
17+
18+
=========
19+
Extension
20+
=========
21+
22+
Extension Type classes
23+
======================
24+
25+
.. doxygenclass:: arrow::extension::Bool8Type
26+
:project: arrow_cpp
27+
:members:
28+
29+
.. doxygenclass:: arrow::extension::FixedShapeTensorType
30+
:project: arrow_cpp
31+
:members:
32+
33+
.. doxygenclass:: arrow::extension::OpaqueType
34+
:project: arrow_cpp
35+
:members:
36+
37+
.. doxygenclass:: arrow::extension::JsonExtensionType
38+
:project: arrow_cpp
39+
:members:
40+
41+
.. doxygenclass:: arrow::extension::UuidType
42+
:project: arrow_cpp
43+
:members:
44+
45+
Extension Array classes
46+
=======================
47+
48+
.. doxygenclass:: arrow::extension::Bool8Array
49+
:project: arrow_cpp
50+
:members:
51+
52+
.. doxygenclass:: arrow::extension::FixedShapeTensorArray
53+
:project: arrow_cpp
54+
:members:
55+
56+
.. doxygenclass:: arrow::extension::OpaqueArray
57+
:project: arrow_cpp
58+
:members:
59+
60+
.. doxygenclass:: arrow::extension::UuidArray
61+
:project: arrow_cpp
62+
:members:
63+

0 commit comments

Comments
 (0)