glib r7726 - in trunk: . glib
- From: matthiasc svn gnome org
- To: svn-commits-list gnome org
- Subject: glib r7726 - in trunk: . glib
- Date: Tue, 2 Dec 2008 05:53:49 +0000 (UTC)
Author: matthiasc
Date: Tue Dec 2 05:53:48 2008
New Revision: 7726
URL: http://svn.gnome.org/viewvc/glib?rev=7726&view=rev
Log:
Some more documentation additions
Modified:
trunk/ChangeLog
trunk/glib/gkeyfile.c
Modified: trunk/glib/gkeyfile.c
==============================================================================
--- trunk/glib/gkeyfile.c (original)
+++ trunk/glib/gkeyfile.c Tue Dec 2 05:53:48 2008
@@ -1237,13 +1237,15 @@
* @key: a key
* @error: return location for a #GError, or %NULL
*
- * Returns the value associated with @key under @group_name.
+ * Returns the raw value associated with @key under @group_name.
+ * Use g_key_file_get_string() to retrieve an unescaped UTF-8 string.
*
* 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
* event that the @group_name cannot be found, %NULL is returned
* and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
*
+ *
* Return value: a newly allocated string or %NULL if the specified
* key cannot be found.
*
@@ -1294,8 +1296,11 @@
* @value: a string
*
* Associates a new value with @key under @group_name.
- * If @key cannot be found then it is created.
- * If @group_name cannot be found then it is created.
+ *
+ * If @key cannot be found then it is created. If @group_name cannot
+ * be found then it is created. To set an UTF-8 string which may contain
+ * characters that need escaping (such as newlines or spaces), use
+ * g_key_file_set_string().
*
* Since: 2.6
**/
@@ -1344,7 +1349,7 @@
* @error: return location for a #GError, or %NULL
*
* Returns the string value associated with @key under @group_name.
- * Unlike g_key_file_get_value(), this function handled escape sequences
+ * Unlike g_key_file_get_value(), this function handles escape sequences
* like \s.
*
* In the event the key cannot be found, %NULL is returned and
@@ -1427,6 +1432,8 @@
* Associates a new string value with @key under @group_name.
* If @key cannot be found then it is created.
* If @group_name cannot be found then it is created.
+ * Unlike g_key_file_set_value(), this function handles characters
+ * that need escaping, such as newlines.
*
* Since: 2.6
**/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]