Add fmt::detail::buffer to the docs (#704)

fmtlib · May 15, 2020 · c5ed73a · c5ed73a
1 parent ea1cd96
commit c5ed73a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/doc/api.rst b/doc/api.rst
@@ -273,6 +273,9 @@ Utilities
 
 .. doxygenfunction:: fmt::join(It, It, string_view)
 
+.. doxygenclass:: fmt::detail::buffer
+   :members:
+
 .. doxygenclass:: fmt::basic_memory_buffer
    :protected-members:
    :members:

diff --git a/include/fmt/core.h b/include/fmt/core.h
@@ -627,7 +627,12 @@ using has_formatter =
 
 namespace detail {
 
-/** A contiguous memory buffer with an optional growing ability. */
+/**
+  \rst
+  A contiguous memory buffer with an optional growing ability. It is an internal
+  class and shouldn't be used directly, only via `~fmt::basic_memory_buffer`.
+  \endrst
+ */
 template <typename T> class buffer {
  private:
   T* ptr_;