fmtlib/fmt
1
0
Fork 1
mirror of https://github.com/fmtlib/fmt.git synced 2025-07-30 10:47:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update signatures

Browse Source
This commit is contained in:
Victor Zverovich
2021-05-19 09:36:12 -07:00
parent 95c358f721
commit 7483dfc652
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/api.rst
View File

@ -35,33 +35,33 @@ using {fmt} as a library and not in the header-only mode.
The following functions use :ref:`format string syntax <syntax>` The following functions use :ref:`format string syntax <syntax>`
similar to that of Python's `str.format similar to that of Python's `str.format
<https://docs.python.org/3/library/stdtypes.html#str.format>`_. <https://docs.python.org/3/library/stdtypes.html#str.format>`_.
They take *format_str* and *args* as arguments. They take *fmt* and *args* as arguments.
*format_str* is a format string that contains literal text and replacement *fmt* is a format string that contains literal text and replacement
fields surrounded by braces ``{}``. The fields are replaced with formatted fields surrounded by braces ``{}``. The fields are replaced with formatted
arguments in the resulting string. A function taking *format_str* doesn't arguments in the resulting string. A function taking *fmt* doesn't
participate in an overload resolution if the latter is not a string. participate in an overload resolution if the latter is not a string.
*args* is an argument list representing objects to be formatted. *args* is an argument list representing objects to be formatted.
.. _format: .. _format:
.. doxygenfunction:: format(const S &format_str, Args&&... args) .. doxygenfunction:: format(format_string<T...> fmt, T&&... args)
.. doxygenfunction:: vformat(const S &format_str, basic_format_args<buffer_context<type_identity_t<Char>>> args) .. doxygenfunction:: vformat(string_view fmt, format_args args)
.. doxygenfunction:: format_to(OutputIt out, const S&, const Args&... args) .. doxygenfunction:: format_to(OutputIt out, format_string<T...> fmt, T&& args)
.. doxygenfunction:: format_to_n(OutputIt out, size_t n, const S&, const Args&... args) .. doxygenfunction:: format_to_n(OutputIt out, size_t n, format_string<T...> fmt, const T&... args)
.. doxygenfunction:: formatted_size(string_view format_str, Args&&... args) .. doxygenfunction:: formatted_size(format_string<T...> fmt, T&&... args)
.. doxygenstruct:: fmt::format_to_n_result .. doxygenstruct:: fmt::format_to_n_result
:members: :members:
.. _print: .. _print:
.. doxygenfunction:: fmt::print(const S &format_str, Args&&... args) .. doxygenfunction:: fmt::print(format_string<T...> fmt, T&&... args)
.. doxygenfunction:: vprint(string_view, format_args) .. doxygenfunction:: vprint(string_view, format_args)
.. doxygenfunction:: print(std::FILE *f, const S &format_str, Args&&... args) .. doxygenfunction:: print(std::FILE *f, format_string<T...> fmt, T&&... args)
.. doxygenfunction:: vprint(std::FILE*, string_view, format_args) .. doxygenfunction:: vprint(std::FILE*, string_view, format_args)
Named Arguments Named Arguments