Bug 556422 – g_file_enumerator_next_file: unclear whether return value

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

svn path=/trunk/; revision=7603

diff --git a/gio/ChangeLog b/gio/ChangeLog
index 719e97d..da6906a 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,11 @@
+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
+
 2008-10-14  Matthias Clasen  <mclasen@redhat.com>
 
        Bug 556334 – Warning when building without selinux support

diff --git a/gio/gfileenumerator.c b/gio/gfileenumerator.c
index 07acc60..579215f 100644 (file)
--- a/gio/gfileenumerator.c
+++ b/gio/gfileenumerator.c
@@ -186,7 +186,8 @@ g_file_enumerator_init (GFileEnumerator *enumerator)
  * 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,