glib r7603 - trunk/gio

[matthiasc svn gnome org]

Author: matthiasc
Date: Thu Oct 16 04:19:53 2008
New Revision: 7603
URL: http://svn.gnome.org/viewvc/glib?rev=7603&view=rev

Log:
2008-10-16  Matthias Clasen  <mclasen redhat com>

        Bug 556422 â g_file_enumerator_next_file: unclear whether return
        value needs to be freed

        * gfileenumerator.c (g_file_enumerate_next_file): Clarify
        the return value docs. Pointed out by Armin Burgmeier


Modified:
   trunk/gio/ChangeLog
   trunk/gio/gfileenumerator.c

Modified: trunk/gio/gfileenumerator.c
==============================================================================
--- trunk/gio/gfileenumerator.c	(original)
+++ trunk/gio/gfileenumerator.c	Thu Oct 16 04:19:53 2008
@@ -186,7 +186,8 @@
  * enumerator is at the end, %NULL will be returned and @error will
  * be unset.
  *
- * Return value: A #GFileInfo or %NULL on error or end of enumerator
+ * Return value: A #GFileInfo or %NULL on error or end of enumerator.
+ *    Free the returned object with g_object_unref() when no longer needed.
  **/
 GFileInfo *
 g_file_enumerator_next_file (GFileEnumerator *enumerator,