Document output_file

This commit is contained in:
Victor Zverovich
2021-01-09 07:18:56 -08:00
parent 018688da2a
commit 061e364b25
3 changed files with 28 additions and 4 deletions

View File

@@ -16,6 +16,7 @@ The {fmt} library API consists of the following parts:
* :ref:`fmt/chrono.h <chrono-api>`: date and time formatting
* :ref:`fmt/compile.h <compile-api>`: format string compilation
* :ref:`fmt/color.h <color-api>`: terminal color and text style
* :ref:`fmt/os.h <os-api>`: system APIs
* :ref:`fmt/ostream.h <ostream-api>`: ``std::ostream`` support
* :ref:`fmt/printf.h <printf-api>`: ``printf`` formatting
@@ -57,7 +58,7 @@ participate in an overload resolution if the latter is not a string.
.. _print:
.. doxygenfunction:: print(const S &format_str, Args&&... args)
.. doxygenfunction:: fmt::print(const S &format_str, Args&&... args)
.. doxygenfunction:: vprint(string_view, format_args)
.. doxygenfunction:: print(std::FILE *f, const S &format_str, Args&&... args)
@@ -471,6 +472,14 @@ Terminal color and text style
.. doxygenfunction:: bg(detail::color_type)
.. _os-api:
System APIs
===========
.. doxygenclass:: fmt::ostream
:members:
.. _ostream-api:
``std::ostream`` Support

View File

@@ -55,6 +55,7 @@ def build_docs(version='dev', **kwargs):
ALIASES += "endrst=\endverbatim"
MACRO_EXPANSION = YES
PREDEFINED = _WIN32=1 \
__linux__=1 \
FMT_USE_VARIADIC_TEMPLATES=1 \
FMT_USE_RVALUE_REFERENCES=1 \
FMT_USE_USER_DEFINED_LITERALS=1 \