feedc0de/fmt
1
0
Fork 0
forked from fmtlib/fmt
Code Pull Requests Activity

Update docs

Browse Source
This commit is contained in:
Victor Zverovich
2023-06-13 18:58:15 +03:00
parent a81135f2c8
commit 5afb1821a9
2 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/api.rst
View File

@ -17,7 +17,7 @@ The {fmt} library API consists of the following parts:
* :ref:`fmt/color.h <color-api>`: terminal color and text style * :ref:`fmt/color.h <color-api>`: terminal color and text style
* :ref:`fmt/os.h <os-api>`: system APIs * :ref:`fmt/os.h <os-api>`: system APIs
* :ref:`fmt/ostream.h <ostream-api>`: ``std::ostream`` support * :ref:`fmt/ostream.h <ostream-api>`: ``std::ostream`` support
* :ref:`fmt/args.h <args-api>`: dynamic format arguments * :ref:`fmt/args.h <args-api>`: dynamic argument lists
* :ref:`fmt/printf.h <printf-api>`: ``printf`` formatting * :ref:`fmt/printf.h <printf-api>`: ``printf`` formatting
* :ref:`fmt/xchar.h <xchar-api>`: optional ``wchar_t`` support * :ref:`fmt/xchar.h <xchar-api>`: optional ``wchar_t`` support
@ -309,6 +309,17 @@ times and reduces binary code size compared to a fully parameterized version.
.. doxygentypedef:: fmt::format_context .. 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 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<T...> fmt, T&&... args) .. doxygenfunction:: print(std::ostream &os, format_string<T...> 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-api:
``printf`` Formatting ``printf`` Formatting

2
include/fmt/args.h
View File

@ -1,4 +1,4 @@
// Formatting library for C++ - dynamic format arguments // Formatting library for C++ - dynamic argument lists
// //
// Copyright (c) 2012 - present, Victor Zverovich // Copyright (c) 2012 - present, Victor Zverovich
// All rights reserved. // All rights reserved.