luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-25 11:42:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Be completely clear about what g_direct_hash, g_direct_equal do

Browse Source 
Also annotate them as (allow-none), more for the benefit of gtk-doc
readers than introspection.

Bug: https://bugzilla.gnome.org/show_bug.cgi?id=592715
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Reviewed-by: Colin Walters <walters@verbum.org>
This commit is contained in:
Simon McVittie 2011-10-04 09:44:27 +01:00
parent 06c96ab1e5
commit 34a1224549
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
glib/ghash.c
View File

@ -1658,11 +1658,15 @@ g_str_hash (gconstpointer v)
/** /**
* g_direct_hash: * g_direct_hash:
* @v: a #gpointer key * @v: (allow-none): a #gpointer key
* *
* Converts a gpointer to a hash value. * Converts a gpointer to a hash value.
* It can be passed to g_hash_table_new() as the @hash_func parameter, * It can be passed to g_hash_table_new() as the @hash_func parameter,
* when using pointers as keys in a #GHashTable. * when using opaque pointers compared by pointer value as keys in a
* #GHashTable.
*
* This hash function is also appropriate for keys that are integers stored
* in pointers, such as <literal>GINT_TO_POINTER (n)</literal>.
* *
* Returns: a hash value corresponding to the key. * Returns: a hash value corresponding to the key.
*/ */
@ -1674,12 +1678,16 @@ g_direct_hash (gconstpointer v)
/** /**
* g_direct_equal: * g_direct_equal:
* @v1: a key * @v1: (allow-none): a key
* @v2: a key to compare with @v1 * @v2: (allow-none): a key to compare with @v1
* *
* Compares two #gpointer arguments and returns %TRUE if they are equal. * Compares two #gpointer arguments and returns %TRUE if they are equal.
* It can be passed to g_hash_table_new() as the @key_equal_func * It can be passed to g_hash_table_new() as the @key_equal_func
* parameter, when using pointers as keys in a #GHashTable. * parameter, when using opaque pointers compared by pointer value as keys
* in a #GHashTable.
*
* This equality function is also appropriate for keys that are integers stored
* in pointers, such as <literal>GINT_TO_POINTER (n)</literal>.
* *
* Returns: %TRUE if the two keys match. * Returns: %TRUE if the two keys match.
*/ */