Commit d2e7554f authored by Victor Zverovich's avatar Victor Zverovich

Write docs.

parent 3303708e
......@@ -50,8 +50,11 @@ Write API
.. _formatstrings:
System Error Reporting
----------------------
System Errors
-------------
.. doxygenclass:: fmt::SystemError
:members:
.. doxygenfunction:: fmt::ThrowSystemError
......
......@@ -521,7 +521,7 @@ class FormatError : public std::runtime_error {
};
/**
An error returned by the operating system or the language runtime,
An error returned by an operating system or a language runtime,
for example a file opening error.
*/
class SystemError : public std::runtime_error {
......@@ -1589,9 +1589,10 @@ class SystemErrorSink {
/**
\rst
Formats a message and throws SystemError with the description of the form
"<message>: <system-message>", where *<message>* is the formatted message
and *<system-message>* is the system message corresponding to the error code.
Formats a message and throws :cpp:class:`fmt::SystemError` with
the description of the form "*<message>*: *<system-message>*",
where *<message>* is the formatted message and *<system-message>*
is the system message corresponding to the error code.
*error_code* is a system error code as given by ``errno``.
\endrst
*/
......@@ -1623,9 +1624,10 @@ class WinErrorSink {
/**
\rst
Formats a message and throws SystemError with the description of the form
"<message>: <system-message>", where *<message>* is the formatted message
and *<system-message>* is the system message corresponding to the error code.
Formats a message and throws :cpp:class:`fmt::SystemError` with
the description of the form "*<message>*: *<system-message>*",
where *<message>* is the formatted message and *<system-message>*
is the system message corresponding to the error code.
*error_code* is a Windows error code as given by ``GetLastError``.
This function is only available on Windows.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment