mirror/fmt
1
0
Fork 0
mirror of https://github.com/fmtlib/fmt.git synced 2024-11-06 05:34:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Victor Zverovich 2022-03-06 10:12:40 -08:00
parent 0cef1f819e
commit 8d4f3e91b2
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/api.rst
View File

@ -450,16 +450,19 @@ The format syntax is described in :ref:`chrono-specs`.
Format string compilation Format string compilation
========================= =========================
``fmt/compile.h`` provides format string compilation support when using ``fmt/compile.h`` provides format string compilation enabled via the
``FMT_COMPILE``. Format strings are parsed, checked and converted into efficient ``FMT_COMPILE`` macro or the ``_cf`` user-defined literal. Format strings
formatting code at compile-time. This supports arguments of built-in and string marked with ``FMT_COMPILE`` or ``_cf`` are parsed, checked and converted into
types as well as user-defined types with ``constexpr`` ``parse`` functions in efficient formatting code at compile-time. This supports arguments of built-in
their ``formatter`` specializations. Format string compilation can generate more and string types as well as user-defined types with ``constexpr`` ``parse``
binary code compared to the default API and is only recommended in places where functions in their ``formatter`` specializations. Format string compilation can
formatting is a performance bottleneck. generate more binary code compared to the default API and is only recommended in
places where formatting is a performance bottleneck.
.. doxygendefine:: FMT_COMPILE .. doxygendefine:: FMT_COMPILE
.. doxygenfunction:: operator""_cf()
.. _color-api: .. _color-api:
Terminal color and text style Terminal color and text style