diff --git a/doc/api.rst b/doc/api.rst index 1f57ef59..5b09ea3f 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -19,6 +19,7 @@ The {fmt} library API consists of the following parts: * :ref:`fmt/os.h `: system APIs * :ref:`fmt/ostream.h `: ``std::ostream`` support * :ref:`fmt/printf.h `: ``printf`` formatting +* :ref:`fmt/xchar.h `: optional ``wchar_t`` support All functions and types provided by the library reside in namespace ``fmt`` and macros have prefix ``FMT_``. @@ -49,7 +50,7 @@ participate in an overload resolution if the latter is not a string. .. doxygenfunction:: format(format_string fmt, T&&... args) -> std::string .. doxygenfunction:: vformat(string_view fmt, format_args args) -> std::string -.. doxygenfunction:: format_to(OutputIt out, format_string fmt, T&& args) -> OutputIt +.. doxygenfunction:: format_to(OutputIt out, format_string fmt, T&&... args) -> OutputIt .. doxygenfunction:: format_to_n(OutputIt out, size_t n, format_string fmt, const T&... args) -> format_to_n_result .. doxygenfunction:: formatted_size(format_string fmt, T&&... args) -> size_t @@ -123,7 +124,6 @@ times and reduces binary code size compared to a fully parameterized version. :members: .. doxygentypedef:: fmt::format_context -.. doxygentypedef:: fmt::wformat_context Compatibility ------------- @@ -132,7 +132,6 @@ Compatibility :members: .. doxygentypedef:: fmt::string_view -.. doxygentypedef:: fmt::wstring_view Locale ------ @@ -297,15 +296,13 @@ Literal-based API The following user-defined literals are defined in ``fmt/format.h``. -.. doxygenfunction:: operator""_format(const char *s, size_t n) +.. doxygenfunction:: operator""_format(const char *s, size_t n) -> detail::udl_formatter -.. doxygenfunction:: operator""_a(const char *s, size_t) +.. doxygenfunction:: operator""_a(const char *s, size_t) -> detail::udl_arg Utilities --------- -.. doxygenstruct:: fmt::is_char - .. doxygentypedef:: fmt::char_t .. doxygenfunction:: fmt::ptr(const T *p) @@ -315,8 +312,6 @@ Utilities .. doxygenfunction:: fmt::to_string(const T &value) -.. doxygenfunction:: fmt::to_wstring(const T &value) - .. doxygenfunction:: fmt::to_string_view(const Char *s) .. doxygenfunction:: fmt::join(Range &&range, string_view sep) @@ -526,6 +521,20 @@ argument type doesn't match its format specification. .. doxygenfunction:: sprintf(const S&, const Args&...) +``wchar_t`` Support +=================== + +The optional header ``fmt/wchar_t.h`` provides support for ``wchar_t`` and +exotic character types. + +.. doxygenstruct:: fmt::is_char + +.. doxygentypedef:: fmt::wstring_view + +.. doxygentypedef:: fmt::wformat_context + +.. doxygenfunction:: fmt::to_wstring(const T &value) + Compatibility with C++20 ``std::format`` ========================================