Explain the difference to g_key_file_get_value(). Pointed out by Mart

        * glib/gkeyfile.c (g_key_file_get_string): Explain the difference
        to g_key_file_get_value(). Pointed out by Mart Raudsepp.

svn path=/trunk/; revision=7705

diff --git a/ChangeLog b/ChangeLog
index da731ed..0490322 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,13 @@
 2008-11-28  Matthias Clasen  <mclasen@redhat.com>
 
+       Bug 562544 – g_key_file_get_string and g_key_file_get_value
+       documentation does not explain the difference
+
+       * glib/gkeyfile.c (g_key_file_get_string): Explain the difference
+       to g_key_file_get_value(). Pointed out by Mart Raudsepp.
+
+2008-11-28  Matthias Clasen  <mclasen@redhat.com>
+
        * glib/gkeyfile.c: Refer to @locale parameters as locale identifier
        in docs.
 

diff --git a/glib/gkeyfile.c b/glib/gkeyfile.c
index d49a17d..474adbc 100644 (file)
--- a/glib/gkeyfile.c
+++ b/glib/gkeyfile.c
@@ -1343,7 +1343,9 @@ g_key_file_set_value (GKeyFile    *key_file,
  * @key: a key
  * @error: return location for a #GError, or %NULL
  *
- * Returns the value associated with @key under @group_name.  
+ * Returns the string value associated with @key under @group_name.
+ * Unlike g_key_file_get_value(), this function handled escape sequences
+ * like \s.
  *
  * In the event the key cannot be found, %NULL is returned and 
  * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND.  In the