apacheGH-40318: [C++][Docs] Add documentation of array factories (apa…

…che#40373) ### Rationale for this change These factory functions are generally useful and available, so documenting them helps external users find them without having to search the source code. ### What changes are included in this PR? This PR adds the array factories in arrow/array/util.h into a doxygen group for array factories and adds that group to the Sphinx C++ API documentation. ### Are these changes tested? I built the docs locally to verify. ### Are there any user-facing changes? Nothing to the API, only docs. * GitHub Issue: apache#40318 Authored-by: Vyas Ramasubramani <[email protected]> Signed-off-by: Antoine Pitrou <[email protected]>
thisisnic · Mar 8, 2024 · 0415c53 · 0415c53
1 parent 24f4e20
commit 0415c53
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git 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<std::shared_ptr<Array>> MakeEmptyArray(std::shared_ptr<DataType> 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
@@ -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:
+   :undoc-members: