mirror/fmt
1
0
Fork 0
mirror of https://github.com/fmtlib/fmt.git synced 2025-01-18 19:15:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update api.rst

Browse Source
This commit is contained in:
Victor Zverovich 2024-01-12 13:57:44 -08:00 committed by GitHub
parent deb584c0e1
commit 6064b85c10
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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

@ -6,7 +6,7 @@ API Reference
The {fmt} library API consists of the following parts: The {fmt} library API consists of the following parts:
* :ref:`fmt/core.h <core-api>`: the core API providing main formatting functions * :ref:`fmt/base.h <base-api>`: the base API providing main formatting functions
for ``char``/UTF-8 with C++20 compile-time checks and minimal dependencies for ``char``/UTF-8 with C++20 compile-time checks and minimal dependencies
* :ref:`fmt/format.h <format-api>`: the full format API providing additional * :ref:`fmt/format.h <format-api>`: the full format API providing additional
formatting functions and locale support formatting functions and locale support
@ -26,10 +26,10 @@ macros have prefix ``FMT_``.
.. _core-api: .. _core-api:
Core API Base API
======== ========
``fmt/core.h`` defines the core API which provides main formatting functions ``fmt/base.h`` defines the core API which provides main formatting functions
for ``char``/UTF-8 with C++20 compile-time checks. It has minimal include for ``char``/UTF-8 with C++20 compile-time checks. It has minimal include
dependencies for better compile times. This header is only beneficial when dependencies for better compile times. This header is only beneficial when
using {fmt} as a library (the default) and not in the header-only mode. using {fmt} as a library (the default) and not in the header-only mode.
@ -55,9 +55,6 @@ specified otherwise.
.. _format: .. _format:
.. doxygenfunction:: format(format_string<T...> fmt, T&&... args) -> std::string
.. doxygenfunction:: vformat(string_view fmt, format_args args) -> std::string
.. doxygenfunction:: format_to(OutputIt out, format_string<T...> fmt, T&&... args) -> OutputIt .. doxygenfunction:: format_to(OutputIt out, format_string<T...> fmt, T&&... args) -> OutputIt
.. doxygenfunction:: format_to_n(OutputIt out, size_t n, format_string<T...> fmt, T&&... args) -> format_to_n_result<OutputIt> .. doxygenfunction:: format_to_n(OutputIt out, size_t n, format_string<T...> fmt, T&&... args) -> format_to_n_result<OutputIt>
.. doxygenfunction:: formatted_size(format_string<T...> fmt, T&&... args) -> size_t .. doxygenfunction:: formatted_size(format_string<T...> fmt, T&&... args) -> size_t
@ -344,6 +341,9 @@ Format API
``fmt/format.h`` defines the full format API providing additional formatting ``fmt/format.h`` defines the full format API providing additional formatting
functions and locale support. functions and locale support.
.. doxygenfunction:: format(format_string<T...> fmt, T&&... args) -> std::string
.. doxygenfunction:: vformat(string_view fmt, format_args args) -> std::string
Literal-Based API Literal-Based API
----------------- -----------------