[glib] Improve g_str_equal docs

[Matthias Clasen <matthiasc src gnome org>]

commit c23536cefeacc72d03ad8a83f315758d751cb127
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Jul 10 11:18:31 2009 -0400

    Improve g_str_equal docs
    
    Add a reference to g_strcmp0(), cf. bug 587938.

 glib/gstring.c |   10 +++++++---
 1 files changed, 7 insertions(+), 3 deletions(-)
---
diff --git a/glib/gstring.c b/glib/gstring.c
index bc2a9d2..dcd9ffb 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