[glib] GError: small documentation addition
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] GError: small documentation addition
- Date: Mon, 16 Jan 2012 04:19:17 +0000 (UTC)
commit 186c15fc879606866215b40f1bfb730b1c47a727
Author: Matthias Clasen <mclasen redhat com>
Date: Sun Jan 15 23:18:09 2012 -0500
GError: small documentation addition
Document that out variables are not guaranteed to be set to
defined values if an error is thrown. Inspired by bug 658315
glib/gerror.c | 6 +++++-
1 files changed, 5 insertions(+), 1 deletions(-)
---
diff --git a/glib/gerror.c b/glib/gerror.c
index dc28cb2..7e2d636 100644
--- a/glib/gerror.c
+++ b/glib/gerror.c
@@ -265,7 +265,7 @@
* <listitem><para>
* The quark function for the error domain is called
* <literal><namespace>_<module>_error_quark</literal>,
- * for example g_spawn_error_quark() or %g_thread_error_quark().
+ * for example g_spawn_error_quark() or g_thread_error_quark().
* </para></listitem>
* <listitem><para>
* The error codes are in an enumeration called
@@ -315,6 +315,10 @@
* immediately.
* </para></listitem>
* <listitem><para>
+ * If a #GError is reported, out parameters are not guaranteed to
+ * be set to any defined value.
+ * </para></listitem>
+ * <listitem><para>
* A #GError* must be initialized to %NULL before passing its address
* to a function that can report errors.
* </para></listitem>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]