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
This commit is contained in:
Sébastien Wilmet 2014-06-27 20:43:39 +02:00
parent 82352ab8e7
commit ffe286e647

View File

@ -650,7 +650,6 @@ g_file_hash (gconstpointer file)
* This call does no blocking I/O. * This call does no blocking I/O.
* *
* Returns: %TRUE if @file1 and @file2 are equal. * Returns: %TRUE if @file1 and @file2 are equal.
* %FALSE if either is not a #GFile.
*/ */
gboolean gboolean
g_file_equal (GFile *file1, g_file_equal (GFile *file1,