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

diff --git a/glib/gerror.c b/glib/gerror.c
index dc28cb2..7e2d636 100644 (file)
--- a/glib/gerror.c
+++ b/glib/gerror.c
@@ -265,7 +265,7 @@
  * <listitem><para>
  *   The quark function for the error domain is called
  *   <literal>&lt;namespace&gt;_&lt;module&gt;_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>