luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-31 04:43:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Some more documentation additions

Browse Source 
svn path=/trunk/; revision=7726
This commit is contained in:
Matthias Clasen 2008-12-02 05:53:48 +00:00
parent 6537b5e11d
commit 20bc7adfb8
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,3 +1,7 @@
2008-12-02 Matthias Clasen <mclasen@redhat.com>
* glib/gkeyfile.c: Some more documentation additions.
2008-12-01 Matthias Clasen <mclasen@redhat.com> 2008-12-01 Matthias Clasen <mclasen@redhat.com>
* configure.in: Bump version * configure.in: Bump version

15
glib/gkeyfile.c
View File

@ -1237,13 +1237,15 @@ g_key_file_get_groups (GKeyFile *key_file,
* @key: a key * @key: a key
* @error: return location for a #GError, or %NULL * @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 * 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 * @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
* event that the @group_name cannot be found, %NULL is returned * event that the @group_name cannot be found, %NULL is returned
* and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
* *
*
* Return value: a newly allocated string or %NULL if the specified * Return value: a newly allocated string or %NULL if the specified
* key cannot be found. * key cannot be found.
* *
@ -1294,8 +1296,11 @@ g_key_file_get_value (GKeyFile *key_file,
* @value: a string * @value: a string
* *
* Associates a new value with @key under @group_name. * 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 * Since: 2.6
**/ **/
@ -1344,7 +1349,7 @@ g_key_file_set_value (GKeyFile *key_file,
* @error: return location for a #GError, or %NULL * @error: return location for a #GError, or %NULL
* *
* Returns the string 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 * Unlike g_key_file_get_value(), this function handles escape sequences
* like \s. * like \s.
* *
* In the event the key cannot be found, %NULL is returned and * In the event the key cannot be found, %NULL is returned and
@ -1427,6 +1432,8 @@ g_key_file_get_string (GKeyFile *key_file,
* Associates a new string value with @key under @group_name. * Associates a new string value with @key under @group_name.
* If @key 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. * 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 * Since: 2.6
**/ **/