From: Matthias Clasen <matthiasc@src.gnome.org>
Date: Wed, 11 Jun 2008 15:58:02 +0000 (+0000)
Subject: Improve the docs
X-Git-Url: http://git.openbox.org/?a=commitdiff_plain;h=1d7f6706328fd076f72a5c7d8807c8696df90614;p=dana%2Fcg-glib.git

Improve the docs

svn path=/trunk/; revision=7002
---

diff --git a/ChangeLog b/ChangeLog
index 571ba674..9135ccfd 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2008-06-11  Matthias Clasen  <mclasen@redhat.com>
+
+	Bug 498732 – g_key_file_to_data cannot fail
+
+	* glib/gkeyfile.c (g_key_file_to_data): Improve the docs.
+	Proposed by Christian Persch
+
 2008-06-11  Ross Burton  <ross@burtonini.com>
 
 	Bug 511367 - add g_file_make_directory_with_parents.
diff --git a/glib/gkeyfile.c b/glib/gkeyfile.c
index f0a26374..4246f511 100644
--- a/glib/gkeyfile.c
+++ b/glib/gkeyfile.c
@@ -1010,6 +1010,9 @@ g_key_file_flush_parse_buffer (GKeyFile  *key_file,
  *
  * This function outputs @key_file as a string.  
  *
+ * Note that this function never reports an error,
+ * so it is safe to pass %NULL as @error.
+ *
  * Return value: a newly allocated string holding
  *   the contents of the #GKeyFile 
  *