[glib] doc: improve doc of g_file_equal()



commit ffe286e647ce9ba9bb8e1631ba3cf0194038f438
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Fri Jun 27 20:43:39 2014 +0200

    doc: improve doc of g_file_equal()
    
    A critical message is printed when a parameter of g_file_equal() is not
    a GFile. When we read the documentation before this commit, we can think
    that passing NULL or another type than GFile is allowed, but it is not
    the case.
    
    Another option is to allow NULL parameters. But for consistency with
    e.g. g_str_equal(), it's probably better to keep the code as is.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=732357

 gio/gfile.c |    1 -
 1 files changed, 0 insertions(+), 1 deletions(-)
---
diff --git a/gio/gfile.c b/gio/gfile.c
index 3e9123f..9cf3f4d 100644
--- a/gio/gfile.c
+++ b/gio/gfile.c
@@ -650,7 +650,6 @@ g_file_hash (gconstpointer file)
  * This call does no blocking I/O.
  *
  * Returns: %TRUE if @file1 and @file2 are equal.
- *     %FALSE if either is not a #GFile.
  */
 gboolean
 g_file_equal (GFile *file1,


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]