Improve documentation for g_error_matches()
authorBenjamin Otte <otte@gnome.org>
Thu, 6 Aug 2009 16:17:32 +0000 (18:17 +0200)
committerBenjamin Otte <otte@gnome.org>
Tue, 18 Aug 2009 09:35:01 +0000 (11:35 +0200)
glib/gerror.c

index ea454d5..4327f9a 100644 (file)
@@ -166,12 +166,13 @@ g_error_copy (const GError *error)
 
 /**
  * g_error_matches:
- * @error: a #GError
+ * @error: a #GError or %NULL
  * @domain: an error domain
  * @code: an error code
  *
  * Returns %TRUE if @error matches @domain and @code, %FALSE
- * otherwise.
+ * otherwise. In particular, when @error is %NULL, %FALSE will
+ * be returned.
  *
  * Return value: whether @error has @domain and @code
  */