From c5ed73aab2bed43de381287303ef76fe870a0daf Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Fri, 15 May 2020 14:35:55 -0700 Subject: [PATCH] Add fmt::detail::buffer to the docs (#704) --- doc/api.rst | 3 +++ include/fmt/core.h | 7 ++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/api.rst b/doc/api.rst index 6fa11c48..ee781a7e 100644 --- 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 index 65850e5e..e5d94c5e 100644 --- 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 class buffer { private: T* ptr_;