fmtlib/fmt
1
0
Fork 1
mirror of https://github.com/fmtlib/fmt.git synced 2025-07-31 19:24:48 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Victor Zverovich
2024-01-02 08:52:07 -08:00
parent eedfdb4c5c
commit baea8f6906
2 changed files with 4 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api.rst
View File

@@ -362,10 +362,6 @@ Utilities
.. doxygenfunction:: fmt::to_string(const T &value) -> std::string .. doxygenfunction:: fmt::to_string(const T &value) -> std::string
.. doxygenfunction:: fmt::join(Range &&range, string_view sep) -> join_view<detail::iterator_t<Range>, detail::sentinel_t<Range>>
.. doxygenfunction:: fmt::join(It begin, Sentinel end, string_view sep) -> join_view<It, Sentinel>
.. doxygenfunction:: fmt::group_digits(T value) -> group_digits_view<T> .. doxygenfunction:: fmt::group_digits(T value) -> group_digits_view<T>
.. doxygenclass:: fmt::detail::buffer .. doxygenclass:: fmt::detail::buffer
@@ -469,10 +465,6 @@ The library also supports convenient formatting of ranges and tuples::
// Prints "('a', 1, 2.0)" // Prints "('a', 1, 2.0)"
fmt::print("{}", t); fmt::print("{}", t);
NOTE: currently, the overload of ``fmt::join`` for iterables exists in the main
``format.h`` header, but expect this to change in the future.
Using ``fmt::join``, you can separate tuple elements with a custom separator:: Using ``fmt::join``, you can separate tuple elements with a custom separator::
#include <fmt/ranges.h> #include <fmt/ranges.h>
@@ -481,6 +473,9 @@ Using ``fmt::join``, you can separate tuple elements with a custom separator::
// Prints "1, a" // Prints "1, a"
fmt::print("{}", fmt::join(t, ", ")); fmt::print("{}", fmt::join(t, ", "));
.. doxygenfunction:: fmt::join(Range &&range, string_view sep) -> join_view<detail::iterator_t<Range>, detail::sentinel_t<Range>>
.. doxygenfunction:: fmt::join(It begin, Sentinel end, string_view sep) -> join_view<It, Sentinel>
.. _chrono-api: .. _chrono-api:
Date and Time Formatting Date and Time Formatting

2
doc/build.py
View File

@@ -56,7 +56,7 @@ def build_docs(version='dev', **kwargs):
CASE_SENSE_NAMES = NO CASE_SENSE_NAMES = NO
INPUT = {0}/args.h {0}/chrono.h {0}/color.h {0}/core.h \ INPUT = {0}/args.h {0}/chrono.h {0}/color.h {0}/core.h \
{0}/compile.h {0}/format.h {0}/os.h {0}/ostream.h \ {0}/compile.h {0}/format.h {0}/os.h {0}/ostream.h \
{0}/printf.h {0}/xchar.h {0}/printf.h {0}/ranges.h {0}/xchar.h
QUIET = YES QUIET = YES
JAVADOC_AUTOBRIEF = YES JAVADOC_AUTOBRIEF = YES
AUTOLINK_SUPPORT = NO AUTOLINK_SUPPORT = NO