AuroraMiddleware/fmt
1
0
Fork 0
mirror of https://github.com/fmtlib/fmt.git synced 2024-12-17 20:31:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Write docs.

Browse Source
This commit is contained in:
Victor Zverovich 2014-05-14 07:29:47 -07:00
parent 3303708e94
commit d2e7554f74
2 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/index.rst
View File

@ -50,8 +50,11 @@ Write API
.. _formatstrings:
System Error Reporting
----------------------
System Errors
-------------
.. doxygenclass:: fmt::SystemError
:members:
.. doxygenfunction:: fmt::ThrowSystemError

16
format.h
View File

@ -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.