From 098503bb6c48765e2d573396fcd10eca42395afb Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Tue, 5 Mar 2024 17:45:26 +0000 Subject: [PATCH] Add documentation --- cpp/src/arrow/array/util.h | 6 ++++++ docs/source/cpp/api/array.rst | 8 +++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/cpp/src/arrow/array/util.h b/cpp/src/arrow/array/util.h index 9f34af0525d96..fd8e75ddb8640 100644 --- a/cpp/src/arrow/array/util.h +++ b/cpp/src/arrow/array/util.h @@ -31,6 +31,10 @@ namespace arrow { +/// \defgroup array-factories Array factory functions +/// +/// @{ + /// \brief Create a strongly-typed Array instance from generic ArrayData /// \param[in] data the array contents /// \return the resulting Array instance @@ -65,6 +69,8 @@ ARROW_EXPORT Result> MakeEmptyArray(std::shared_ptr type, MemoryPool* pool = default_memory_pool()); +/// @} + namespace internal { /// \brief Swap endian of each element in a generic ArrayData diff --git a/docs/source/cpp/api/array.rst b/docs/source/cpp/api/array.rst index eca9ec398c15a..a7e5d0cf07e0a 100644 --- a/docs/source/cpp/api/array.rst +++ b/docs/source/cpp/api/array.rst @@ -27,6 +27,12 @@ Arrays :project: arrow_cpp :members: +Factory functions +================= + +.. doxygengroup:: array-factories + :content-only: + Concrete array subclasses ========================= @@ -86,4 +92,4 @@ Utilities .. doxygenclass:: arrow::ArrayVisitor :project: arrow_cpp :members: - :undoc-members: \ No newline at end of file + :undoc-members: