Bug 555224 – Improve g_format_size_for_display doc

* glib/gfileutils.c: change g_format_size_for_display API doc to
explicitly say that the returned string has to be freed. Change
spelling of "newly allocated" to "newly-allocated" in g_file_read_link
API doc to be more consistent with what is done in that file.

svn path=/trunk/; revision=7572

diff --git a/ChangeLog b/ChangeLog
index 6fd02c0..d21b0c7 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2008-10-06  Christophe Fergeau  <teuf@gnome.org>
+
+       Bug 555224 – Improve g_format_size_for_display doc
+       
+       * glib/gfileutils.c: change g_format_size_for_display API doc to
+       explicitly say that the returned string has to be freed. Change
+       spelling of "newly allocated" to "newly-allocated" in g_file_read_link
+       API doc to be more consistent with what is done in that file.
+
 2008-10-01  David Zeuthen  <davidz@redhat.com>
 
        * README.in: Add "Notes about glib 2.20" section detailing the

diff --git a/glib/gfileutils.c b/glib/gfileutils.c
index 34ecc64..fb6536d 100644 (file)
--- a/glib/gfileutils.c
+++ b/glib/gfileutils.c
@@ -1824,13 +1824,16 @@ g_build_filename (const gchar *first_element,
  * @size: a size in bytes.
  * 
  * Formats a size (for example the size of a file) into a human readable string.
- * Sizes are rounded to the nearest size prefix (KB, MB, GB) and are displayed rounded to
- * the nearest  tenth. E.g. the file size 3292528 bytes will be converted into
- * the string "3.1 MB".
+ * Sizes are rounded to the nearest size prefix (KB, MB, GB) and are displayed 
+ * rounded to the nearest  tenth. E.g. the file size 3292528 bytes will be
+ * converted into the string "3.1 MB".
  *
  * The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
- * 
- * Returns: a formatted string containing a human readable file size.
+ *
+ * This string should be freed with g_free() when not needed any longer.
+ *
+ * Returns: a newly-allocated formatted string containing a human readable
+ *          file size.
  *
  * Since: 2.16
  **/
@@ -1871,7 +1874,7 @@ g_format_size_for_display (goffset size)
  * readlink() function.  The returned string is in the encoding used
  * for filenames. Use g_filename_to_utf8() to convert it to UTF-8.
  *
- * Returns: A newly allocated string with the contents of the symbolic link, 
+ * Returns: A newly-allocated string with the contents of the symbolic link, 
  *          or %NULL if an error occurred.
  *
  * Since: 2.4