Skip to content

Commit 098503b

Browse files
committed
Add documentation
1 parent 3d467ac commit 098503b

2 files changed

Lines changed: 13 additions & 1 deletion

File tree

‎cpp/src/arrow/array/util.h‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@
3131

3232
namespace arrow {
3333

34+
/// \defgroup array-factories Array factory functions
35+
///
36+
/// @{
37+
3438
/// \brief Create a strongly-typed Array instance from generic ArrayData
3539
/// \param[in] data the array contents
3640
/// \return the resulting Array instance
@@ -65,6 +69,8 @@ ARROW_EXPORT
6569
Result<std::shared_ptr<Array>> MakeEmptyArray(std::shared_ptr<DataType> type,
6670
MemoryPool* pool = default_memory_pool());
6771

72+
/// @}
73+
6874
namespace internal {
6975

7076
/// \brief Swap endian of each element in a generic ArrayData

‎docs/source/cpp/api/array.rst‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ Arrays
2727
:project: arrow_cpp
2828
:members:
2929

30+
Factory functions
31+
=================
32+
33+
.. doxygengroup:: array-factories
34+
:content-only:
35+
3036
Concrete array subclasses
3137
=========================
3238

@@ -86,4 +92,4 @@ Utilities
8692
.. doxygenclass:: arrow::ArrayVisitor
8793
:project: arrow_cpp
8894
:members:
89-
:undoc-members:
95+
:undoc-members:

0 commit comments

Comments
 (0)