Clarify docs. (#364026, Bastian Nocera)

2007-03-06  Matthias Clasen  <mclasen@redhat.com>

        * glib/gstring.c (g_str_equal): Clarify docs.  (#364026,
        Bastian Nocera)

svn path=/trunk/; revision=5379

diff --git a/ChangeLog b/ChangeLog
index 9403240..66b1403 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-03-06  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gstring.c (g_str_equal): Clarify docs.  (#364026, 
+       Bastian Nocera)
+
 2007-03-06  Matthew Barnes  <mbarnes@redhat.com>
 
        * glib/gqueue.h:

diff --git a/glib/gstring.c b/glib/gstring.c
index 9e0e295..b17bb1b 100644 (file)
--- a/glib/gstring.c
+++ b/glib/gstring.c
@@ -61,9 +61,9 @@ struct _GStringChunk
  * @v1: a key. 
  * @v2: a key to compare with @v1.
  * 
- * Compares two strings 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.
+ * 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.
  *
  * Returns: %TRUE if the two keys match.
  */