Improve docs

svn path=/trunk/; revision=7896

diff --git a/ChangeLog b/ChangeLog
index 0f3bfc680cc7444e67935b1bcba90712fac6165a..2a4f2e9849623f70efb707f337ed035ee2b9b1dc 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2009-02-22  Matthias Clasen  <mclasen@redhat.com>
+
+       Bug 572464 – Doc for g_file_get_contents
+
+       * glib/gfileutils.c (g_file_get_contents): Improve docs. Pointed
+       out by Øystein Johansen.
+
 2009-02-22  Matthias Clasen  <mclasen@redhat.com>
 
        Bug 572672 – glib/gthread.c: argument is different type

diff --git a/glib/gfileutils.c b/glib/gfileutils.c
index 82b1d59fb01794ae588206ba4f9160774e20d4e4..547beff4d67ecbdb73e6753386135cddcfa91c94 100644 (file)
--- a/glib/gfileutils.c
+++ b/glib/gfileutils.c
@@ -798,19 +798,20 @@ get_contents_win32 (const gchar  *filename,
 /**
  * g_file_get_contents:
  * @filename: name of a file to read contents from, in the GLib file name encoding
- * @contents: location to store an allocated string
+ * @contents: location to store an allocated string, use g_free() to free
+ *     the returned string
  * @length: location to store length in bytes of the contents, or %NULL
  * @error: return location for a #GError, or %NULL
- * 
+ *
  * Reads an entire file into allocated memory, with good error
- * checking. 
+ * checking.
  *
- * If the call was successful, it returns %TRUE and sets @contents to the file 
- * contents and @length to the length of the file contents in bytes. The string 
- * stored in @contents will be nul-terminated, so for text files you can pass 
- * %NULL for the @length argument. If the call was not successful, it returns 
- * %FALSE and sets @error. The error domain is #G_FILE_ERROR. Possible error  
- * codes are those in the #GFileError enumeration. In the error case, 
+ * If the call was successful, it returns %TRUE and sets @contents to the file
+ * contents and @length to the length of the file contents in bytes. The string
+ * stored in @contents will be nul-terminated, so for text files you can pass
+ * %NULL for the @length argument. If the call was not successful, it returns
+ * %FALSE and sets @error. The error domain is #G_FILE_ERROR. Possible error
+ * codes are those in the #GFileError enumeration. In the error case,
  * @contents is set to %NULL and @length is set to zero.
  *
  * Return value: %TRUE on success, %FALSE if an error occurred