mirror of
https://github.com/fmtlib/fmt.git
synced 2025-07-31 19:24:48 +02:00
Tweak the docs
This commit is contained in:
12
doc/api.rst
12
doc/api.rst
@@ -427,11 +427,13 @@ The format string syntax is described in the documentation of
|
|||||||
Format string compilation
|
Format string compilation
|
||||||
=========================
|
=========================
|
||||||
|
|
||||||
Format strings can be processed at compile time for built-in and string types
|
``fmt/compile.h`` provides format string compilation support. Format strings
|
||||||
as well as user-defined types with ``constexpr`` ``parse`` functions in their
|
are parsed at compile time and converted into efficient formatting code. This
|
||||||
``formatter`` specializations. Format string compilation can generate more
|
supports arguments of built-in and string types as well as user-defined types
|
||||||
binary code compared to the normal API and is only recommended in places where
|
with ``constexpr`` ``parse`` functions in their ``formatter`` specializations.
|
||||||
formatting is a performance bottleneck.
|
Format string compilation can 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
|
||||||
|
|
||||||
|
@@ -23,14 +23,14 @@ struct is_compiled_string : std::is_base_of<compiled_string, S> {};
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
\rst
|
\rst
|
||||||
Constructs a format string that will be translated into an efficient
|
Converts a string literal *s* into a format string that will be parsed at
|
||||||
formatting code at compile time from a string literal *s*. Requires C++17
|
compile time and converted into efficient formatting code. Requires C++17
|
||||||
``constexpr if``.
|
``constexpr if`` compiler support.
|
||||||
|
|
||||||
**Example**::
|
**Example**::
|
||||||
|
|
||||||
// Converts 42 into std::string using the most efficient code and no runtime
|
// Converts 42 into std::string using the most efficient method and no
|
||||||
// format string processing.
|
// runtime format string processing.
|
||||||
std::string s = fmt::format(FMT_COMPILE("{}"), 42);
|
std::string s = fmt::format(FMT_COMPILE("{}"), 42);
|
||||||
\endrst
|
\endrst
|
||||||
*/
|
*/
|
||||||
|
Reference in New Issue
Block a user