[glib] ghash: Document order of parameters in GEqualFunc usage
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] ghash: Document order of parameters in GEqualFunc usage
- Date: Thu, 23 Mar 2017 15:56:01 +0000 (UTC)
commit b3362bb834d49932cc84cfe3e21ca4eff8d6e315
Author: Philip Withnall <withnall endlessm com>
Date: Thu Mar 23 15:55:18 2017 +0000
ghash: Document order of parameters in GEqualFunc usage
See https://bugzilla.gnome.org/show_bug.cgi?id=698064#c15.
glib/ghash.c | 4 +++-
1 files changed, 3 insertions(+), 1 deletions(-)
---
diff --git a/glib/ghash.c b/glib/ghash.c
index 5d93353..25b8c56 100644
--- a/glib/ghash.c
+++ b/glib/ghash.c
@@ -663,7 +663,9 @@ g_hash_table_maybe_resize (GHashTable *hash_table)
* and g_str_equal() functions are provided for the most common types
* of keys. If @key_equal_func is %NULL, keys are compared directly in
* a similar fashion to g_direct_equal(), but without the overhead of
- * a function call.
+ * a function call. @key_equal_func is called with the key from the hash table
+ * as its first parameter, and the user-provided key to check against as
+ * its second.
*
* Returns: a new #GHashTable
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]