This is the mail archive of the
libstdc++@gcc.gnu.org
mailing list for the libstdc++ project.
Re: [PATCH] Improve API docs for <system_error> header
- From: Jonathan Wakely <jwakely at redhat dot com>
- To: Daniel Krügler <daniel dot kruegler at gmail dot com>
- Cc: libstdc++ <libstdc++ at gcc dot gnu dot org>, gcc-patches List <gcc-patches at gcc dot gnu dot org>
- Date: Sat, 4 May 2019 16:53:04 +0100
- Subject: Re: [PATCH] Improve API docs for <system_error> header
- References: <20190504143652.GA11692@redhat.com> <CAGNvRgCPLCZp-_4AX6J4YtHx=pi9KxmXgGV1R0deRSQMgZGDgA@mail.gmail.com>
On 04/05/19 17:43 +0200, Daniel Krügler wrote:
Am Sa., 4. Mai 2019 um 16:37 Uhr schrieb Jonathan Wakely <jwakely@redhat.com>:
* include/std/system_error (error_category, error_code)
(error_condition): Improve docs.
* libsupc++/exception: Add missing @addtogroup Doxygen command.
* libsupc++/exception_ptr.h (exception_ptr): Link equality operators
to class documentation. Suppress documentation for implementation
details.
* libsupc++/nested_exception.h (throw_with_nested, rethrow_if_nested):
Suppress documentation for implementation details.
Committed to trunk.
The new docs for error_category say now:
"An error category defines a context that give meaning to the integer
* stored in an `error_code` or `error_category` object."
The last "or `error_category`" looks misleading to me, did you mean
"or `error_condition`" instead?
I did, thanks. Fixed by the attached patch.
commit b971ba70dce2532f14478f9beea173bb0180bd08
Author: Jonathan Wakely <jwakely@redhat.com>
Date: Sat May 4 16:52:18 2019 +0100
Fix reference to wrong class in comment
* include/std/system_error (error_category): Fix comment.
diff --git a/libstdc++-v3/include/std/system_error b/libstdc++-v3/include/std/system_error
index 768eddaefd1..3685348ee4d 100644
--- a/libstdc++-v3/include/std/system_error
+++ b/libstdc++-v3/include/std/system_error
@@ -77,7 +77,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
/** Abstract base class for types defining a category of error codes.
*
* An error category defines a context that give meaning to the integer
- * stored in an `error_code` or `error_category` object. For example,
+ * stored in an `error_code` or `error_condition` object. For example,
* the standard `errno` constants such a `EINVAL` and `ENOMEM` are
* associated with the "generic" category and other OS-specific error
* numbers are associated with the "system" category, but a user-defined