From c23536cefeacc72d03ad8a83f315758d751cb127 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 10 Jul 2009 11:18:31 -0400 Subject: [PATCH] Improve g_str_equal docs Add a reference to g_strcmp0(), cf. bug 587938. --- glib/gstring.c | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/glib/gstring.c b/glib/gstring.c index bc2a9d24..dcd9ffb1 100644 --- a/glib/gstring.c +++ b/glib/gstring.c @@ -60,11 +60,15 @@ struct _GStringChunk * g_str_equal: * @v1: a key * @v2: a key to compare with @v1 - * - * Compares two strings for byte-by-byte equality and returns %TRUE - * if they are equal. It can be passed to g_hash_table_new() as the + * + * Compares two strings for byte-by-byte equality and returns %TRUE + * if they are equal. It can be passed to g_hash_table_new() as the * @key_equal_func parameter, when using strings as keys in a #GHashTable. * + * Note that this function is primarily meant as a hash table comparison + * function. For a general-purpose, %NULL-safe string comparison function, + * see g_strcmp0(). + * * Returns: %TRUE if the two keys match */ gboolean -- 2.34.1