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

key file: Clarify documentation around comments

Browse Source 
The documentation was not very clear about the handling
of the '#' comment markers. State clearly how these are
handled by the getter and the setter.

https://bugzilla.gnome.org/show_bug.cgi?id=479730
This commit is contained in:
Matthias Clasen 2015-06-16 18:38:27 -04:00
parent 7a295f063f
commit 6e57650387
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
glib/gkeyfile.c
View File

@ -3230,10 +3230,14 @@ g_key_file_set_top_comment (GKeyFile *key_file,
* @error: return location for a #GError * @error: return location for a #GError
* *
* Places a comment above @key from @group_name. * Places a comment above @key from @group_name.
*
* If @key is %NULL then @comment will be written above @group_name. * If @key is %NULL then @comment will be written above @group_name.
* If both @key and @group_name are %NULL, then @comment will be * If both @key and @group_name are %NULL, then @comment will be
* written above the first group in the file. * written above the first group in the file.
* *
* Note that this function prepends a '#' comment marker to
* each line of @comment.
*
* Returns: %TRUE if the comment was written, %FALSE otherwise * Returns: %TRUE if the comment was written, %FALSE otherwise
* *
* Since: 2.6 * Since: 2.6
@ -3460,6 +3464,8 @@ g_key_file_get_top_comment (GKeyFile *key_file,
* @group_name. If both @key and @group_name are %NULL, then * @group_name. If both @key and @group_name are %NULL, then
* @comment will be read from above the first group in the file. * @comment will be read from above the first group in the file.
* *
* Note that the returned string includes the '#' comment markers.
*
* Returns: a comment that should be freed with g_free() * Returns: a comment that should be freed with g_free()
* *
* Since: 2.6 * Since: 2.6