Doxygen for make_Vector

AMReX-Codes · Sep 19, 2023 · 3760484 · 3760484
1 parent b7891ce
commit 3760484
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/Base/Vector.H b/src/Base/Vector.H
@@ -38,6 +38,15 @@ namespace
     }
 }
 
+/** Register an ``amrex::Vector`` type with pybind11.
+ *
+ * Specialized for a specific data type ``T`` and memory ``Allocator``.
+ *
+ * @tparam T data type per vector element
+ * @tparam Allocator the memory allocator, e.g., an AMReX Arena or std::allocator
+ * @param m the pyAMReX pybind11 module object
+ * @param typestr a unique suffix for the type ``T`` and ``Allocator``
+ */
 template <class T, class Allocator = std::allocator<T> >
 void make_Vector(py::module &m, std::string typestr)
 {