Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
F
fmt
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Libraries
fmt
Commits
cbd861f1
Commit
cbd861f1
authored
Jun 02, 2021
by
Victor Zverovich
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update docs
parent
faf972f0
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
18 additions
and
9 deletions
+18
-9
doc/api.rst
doc/api.rst
+18
-9
No files found.
doc/api.rst
View file @
cbd861f1
...
@@ -19,6 +19,7 @@ The {fmt} library API consists of the following parts:
...
@@ -19,6 +19,7 @@ The {fmt} library API consists of the following parts:
* :ref:`fmt/os.h <os-api>`: system APIs
* :ref:`fmt/os.h <os-api>`: system APIs
* :ref:`fmt/ostream.h <ostream-api>`: ``std::ostream`` support
* :ref:`fmt/ostream.h <ostream-api>`: ``std::ostream`` support
* :ref:`fmt/printf.h <printf-api>`: ``printf`` formatting
* :ref:`fmt/printf.h <printf-api>`: ``printf`` formatting
* :ref:`fmt/xchar.h <xchar-api>`: optional ``wchar_t`` support
All functions and types provided by the library reside in namespace ``fmt`` and
All functions and types provided by the library reside in namespace ``fmt`` and
macros have prefix ``FMT_``.
macros have prefix ``FMT_``.
...
@@ -49,7 +50,7 @@ participate in an overload resolution if the latter is not a string.
...
@@ -49,7 +50,7 @@ participate in an overload resolution if the latter is not a string.
.. doxygenfunction:: format(format_string<T...> fmt, T&&... args) -> std::string
.. doxygenfunction:: format(format_string<T...> fmt, T&&... args) -> std::string
.. doxygenfunction:: vformat(string_view fmt, format_args 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, const T&... args) -> format_to_n_result<OutputIt>
.. doxygenfunction:: format_to_n(OutputIt out, size_t n, format_string<T...> fmt, const 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
...
@@ -123,7 +124,6 @@ times and reduces binary code size compared to a fully parameterized version.
...
@@ -123,7 +124,6 @@ times and reduces binary code size compared to a fully parameterized version.
:members:
:members:
.. doxygentypedef:: fmt::format_context
.. doxygentypedef:: fmt::format_context
.. doxygentypedef:: fmt::wformat_context
Compatibility
Compatibility
-------------
-------------
...
@@ -132,7 +132,6 @@ Compatibility
...
@@ -132,7 +132,6 @@ Compatibility
:members:
:members:
.. doxygentypedef:: fmt::string_view
.. doxygentypedef:: fmt::string_view
.. doxygentypedef:: fmt::wstring_view
Locale
Locale
------
------
...
@@ -297,15 +296,13 @@ Literal-based API
...
@@ -297,15 +296,13 @@ Literal-based API
The following user-defined literals are defined in ``fmt/format.h``.
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<char>
.. doxygenfunction:: operator""_a(const char *s, size_t)
.. doxygenfunction:: operator""_a(const char *s, size_t)
-> detail::udl_arg<char>
Utilities
Utilities
---------
---------
.. doxygenstruct:: fmt::is_char
.. doxygentypedef:: fmt::char_t
.. doxygentypedef:: fmt::char_t
.. doxygenfunction:: fmt::ptr(const T *p)
.. doxygenfunction:: fmt::ptr(const T *p)
...
@@ -315,8 +312,6 @@ Utilities
...
@@ -315,8 +312,6 @@ Utilities
.. doxygenfunction:: fmt::to_string(const T &value)
.. doxygenfunction:: fmt::to_string(const T &value)
.. doxygenfunction:: fmt::to_wstring(const T &value)
.. doxygenfunction:: fmt::to_string_view(const Char *s)
.. doxygenfunction:: fmt::to_string_view(const Char *s)
.. doxygenfunction:: fmt::join(Range &&range, string_view sep)
.. doxygenfunction:: fmt::join(Range &&range, string_view sep)
...
@@ -526,6 +521,20 @@ argument type doesn't match its format specification.
...
@@ -526,6 +521,20 @@ argument type doesn't match its format specification.
.. doxygenfunction:: sprintf(const S&, const Args&...)
.. 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``
Compatibility with C++20 ``std::format``
========================================
========================================
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment