diff --git a/doc/api.rst b/doc/api.rst index d4540251..bdac411f 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -17,7 +17,7 @@ The {fmt} library API consists of the following parts: * :ref:`fmt/color.h `: terminal color and text style * :ref:`fmt/os.h `: system APIs * :ref:`fmt/ostream.h `: ``std::ostream`` support -* :ref:`fmt/args.h `: dynamic format arguments +* :ref:`fmt/args.h `: dynamic argument lists * :ref:`fmt/printf.h `: ``printf`` formatting * :ref:`fmt/xchar.h `: optional ``wchar_t`` support @@ -309,6 +309,17 @@ times and reduces binary code size compared to a fully parameterized version. .. doxygentypedef:: fmt::format_context +.. _args-api: + +Dynamic Argument Lists +====================== + +The header ``fmt/args.h`` provides ``dynamic_format_arg_store``, a builder-like +API that can be used to construct format argument lists dynamically. + +.. doxygenclass:: fmt::dynamic_format_arg_store + :members: + Compatibility ------------- @@ -602,17 +613,6 @@ In order to make a type formattable via ``std::ostream`` you should provide a .. doxygenfunction:: print(std::ostream &os, format_string fmt, T&&... args) -.. _args-api: - -Dynamic Format Arguments -======================== - -The header ``fmt/args.h`` provides ``dynamic_format_arg_store``, a builder-like -API that can be used to construct format argument lists dynamically. - -.. doxygenclass:: fmt::dynamic_format_arg_store - :members: - .. _printf-api: ``printf`` Formatting diff --git a/include/fmt/args.h b/include/fmt/args.h index a3966d14..2d684e7c 100644 --- a/include/fmt/args.h +++ b/include/fmt/args.h @@ -1,4 +1,4 @@ -// Formatting library for C++ - dynamic format arguments +// Formatting library for C++ - dynamic argument lists // // Copyright (c) 2012 - present, Victor Zverovich // All rights reserved.