External/fmt
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Victor Zverovich 2020-11-08 06:48:34 -08:00
parent e29f93e8a8
commit 8cf0afaf1c
2 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/api.rst
View File

@ -443,13 +443,12 @@ Format string compilation
========================= =========================
``fmt/compile.h`` provides format string compilation support when using ``fmt/compile.h`` provides format string compilation support when using
``FMT_COMPILE``. Format strings are parsed, checked and converted ``FMT_COMPILE``. Format strings are parsed, checked and converted into efficient
into efficient formatting code at compile-time. formatting code at compile-time. This supports arguments of built-in and string
This supports arguments of built-in and string types as well as user-defined types types as well as user-defined types with ``constexpr`` ``parse`` functions in
with ``constexpr`` ``parse`` functions in their ``formatter`` specializations. their ``formatter`` specializations. Format string compilation can generate more
Format string compilation can generate more binary code compared to the default binary code compared to the default API and is only recommended in places where
API and is only recommended in places where formatting is a performance formatting is a performance bottleneck.
bottleneck.
.. doxygendefine:: FMT_COMPILE .. doxygendefine:: FMT_COMPILE

11
doc/build.py
View File

@ -89,11 +89,14 @@ def build_docs(version='dev', **kwargs):
fmt::basic_format_arg::handle fmt::basic_format_arg::handle
'''.format(include_dir, doxyxml_dir).encode('UTF-8')) '''.format(include_dir, doxyxml_dir).encode('UTF-8'))
noisy_warnings = [ noisy_warnings = [
'warning: .* fmt::detail::.* is not documented.', 'warning: Internal inconsistency: .* does not belong to any container!'
'warning: Internal inconsistency: member .* does not belong to any ' +
'container!'
] ]
for w in noisy_warnings: internal_symbols = [
'fmt::detail::.*',
'basic_data<>',
'fmt::dynamic_formatter'
]
for w in noisy_warnings + ['(' + '|'.join(internal_symbols) + ')']:
out = re.sub('.*' + w + '\n', '', out) out = re.sub('.*' + w + '\n', '', out)
print(out) print(out)
if p.returncode != 0: if p.returncode != 0: