mirror/fmt
1
0
Fork 0
mirror of https://github.com/fmtlib/fmt.git synced 2024-12-25 06:21:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

More documentation fixes

Browse Source
This commit is contained in:
Victor Zverovich 2019-05-18 09:30:36 -07:00
parent afc1a74a6c
commit 2346779d6b
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/api.rst
View File

@ -51,14 +51,14 @@ participate in an overload resolution if the latter is not a string.
.. doxygenfunction:: vprint(std::FILE *, string_view, format_args) .. doxygenfunction:: vprint(std::FILE *, string_view, format_args)
.. doxygenfunction:: vprint(std::FILE *, wstring_view, wformat_args) .. doxygenfunction:: vprint(std::FILE *, wstring_view, wformat_args)
Named arguments Named Arguments
--------------- ---------------
.. doxygenfunction:: fmt::arg(const S&, const T&) .. doxygenfunction:: fmt::arg(const S&, const T&)
Named arguments are not supported in compile-time checks at the moment. Named arguments are not supported in compile-time checks at the moment.
Argument lists Argument Lists
-------------- --------------
.. doxygenfunction:: fmt::make_format_args(const Args&...) .. doxygenfunction:: fmt::make_format_args(const Args&...)
@ -91,13 +91,13 @@ Format API
``fmt/format.h`` defines the full format API providing compile-time format ``fmt/format.h`` defines the full format API providing compile-time format
string checks, output iterator and user-defined type support. string checks, output iterator and user-defined type support.
Compile-time format string checks Compile-time Format String Checks
--------------------------------- ---------------------------------
.. doxygendefine:: FMT_STRING .. doxygendefine:: FMT_STRING
.. doxygendefine:: fmt .. doxygendefine:: fmt
Formatting user-defined types Formatting User-defined Types
----------------------------- -----------------------------
To make a user-defined type formattable, specialize the ``formatter<T>`` struct To make a user-defined type formattable, specialize the ``formatter<T>`` struct
@ -184,10 +184,10 @@ This section shows how to define a custom format function for a user-defined
type. The next section describes how to get ``fmt`` to use a conventional stream type. The next section describes how to get ``fmt`` to use a conventional stream
output ``operator<<`` when one is defined for a user-defined type. output ``operator<<`` when one is defined for a user-defined type.
Output iterator support Output Iterator Support
----------------------- -----------------------
.. doxygenfunction:: fmt::format_to(OutputIt, const S&, const Args&...) .. doxygenfunction:: fmt::format_to(OutputIt, const S &, const Args &...)
.. doxygenfunction:: fmt::format_to_n(OutputIt, std::size_t, string_view, const Args&...) .. doxygenfunction:: fmt::format_to_n(OutputIt, std::size_t, string_view, const Args&...)
.. doxygenstruct:: fmt::format_to_n_result .. doxygenstruct:: fmt::format_to_n_result
:members: :members: