luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-01 00:36:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source 
svn path=/trunk/; revision=7704
This commit is contained in:
Matthias Clasen 2008-11-28 20:29:42 +00:00
parent 181c615ca4
commit a2830c774d
4 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2008-11-28 Matthias Clasen <mclasen@redhat.com>
* glib/gkeyfile.c: Refer to @locale parameters as locale identifier
in docs.
2008-11-28 Matthias Clasen <mclasen@redhat.com> 2008-11-28 Matthias Clasen <mclasen@redhat.com>
Bug 557603 – carbon check output misplaced Bug 557603 – carbon check output misplaced

5
docs/reference/ChangeLog
View File

@ -1,3 +1,8 @@
@008-11-28 Matthias Clasen <mclasen@redhat.com>
* glib/tmpl/keyfile.sgml: Explain locale identifiers in
more detail
@008-11-28 Matthias Clasen <mclasen@redhat.com> @008-11-28 Matthias Clasen <mclasen@redhat.com>
Bug 562549 – g_byte_array_free should tell how free data Bug 562549 – g_byte_array_free should tell how free data

7
docs/reference/glib/tmpl/keyfile.sgml
View File

@ -34,8 +34,9 @@ Name=Key File Example\tthis value shows\nescaping
# localized strings are stored in multiple key-value pairs # localized strings are stored in multiple key-value pairs
Welcome=Hello Welcome=Hello
Welcome[de]=Hallo Welcome[de]=Hallo
Welcome[fr]=Bonjour Welcome[fr_FR]=Bonjour
Welcome[it]=Ciao Welcome[it]=Ciao
Welcome[be@latin]=Hello
[Another Group] [Another Group]
@ -58,7 +59,9 @@ the end of the file. Each key-value pair must be contained in a group.
<para> <para>
Key-value pairs generally have the form <literal>key=value</literal>, Key-value pairs generally have the form <literal>key=value</literal>,
with the exception of localized strings, which have the form with the exception of localized strings, which have the form
<literal>key[locale]=value</literal>. Space before and after the <literal>key[locale]=value</literal>, with a locale identifier of the form
<literal>lang_COUNTRY@MODIFIER</literal> where <literal>COUNTRY</literal> and
<literal>MODIFIER</literal> are optional. Space before and after the
'=' character are ignored. Newline, tab, carriage return and backslash '=' character are ignored. Newline, tab, carriage return and backslash
characters in value are escaped as \n, \t, \r, and \\, respectively. characters in value are escaped as \n, \t, \r, and \\, respectively.
To preserve leading spaces in values, these can also be escaped as \s. To preserve leading spaces in values, these can also be escaped as \s.

8
glib/gkeyfile.c
View File

@ -1589,7 +1589,7 @@ g_key_file_set_string_list (GKeyFile *key_file,
* @key_file: a #GKeyFile * @key_file: a #GKeyFile
* @group_name: a group name * @group_name: a group name
* @key: a key * @key: a key
* @locale: a locale * @locale: a locale identifier
* @string: a string * @string: a string
* *
* Associates a string value for @key and @locale under @group_name. * Associates a string value for @key and @locale under @group_name.
@ -1625,7 +1625,7 @@ extern GSList *_g_compute_locale_variants (const gchar *locale);
* @key_file: a #GKeyFile * @key_file: a #GKeyFile
* @group_name: a group name * @group_name: a group name
* @key: a key * @key: a key
* @locale: a locale or %NULL * @locale: a locale identifier or %NULL
* @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 value associated with @key under @group_name
@ -1721,7 +1721,7 @@ g_key_file_get_locale_string (GKeyFile *key_file,
* @key_file: a #GKeyFile * @key_file: a #GKeyFile
* @group_name: a group name * @group_name: a group name
* @key: a key * @key: a key
* @locale: a locale * @locale: a locale identifier or %NULL
* @length: return location for the number of returned strings or %NULL * @length: return location for the number of returned strings or %NULL
* @error: return location for a #GError or %NULL * @error: return location for a #GError or %NULL
* *
@ -1796,7 +1796,7 @@ g_key_file_get_locale_string_list (GKeyFile *key_file,
* @key_file: a #GKeyFile * @key_file: a #GKeyFile
* @group_name: a group name * @group_name: a group name
* @key: a key * @key: a key
* @locale: a locale * @locale: a locale identifier
* @list: a %NULL-terminated array of locale string values * @list: a %NULL-terminated array of locale string values
* @length: the length of @list * @length: the length of @list
* *