glib r7704 - in trunk: . docs/reference docs/reference/glib/tmpl glib

[matthiasc svn gnome org]

Author: matthiasc
Date: Fri Nov 28 20:29:42 2008
New Revision: 7704
URL: http://svn.gnome.org/viewvc/glib?rev=7704&view=rev

Log:
Improve docs


Modified:
   trunk/ChangeLog
   trunk/docs/reference/ChangeLog
   trunk/docs/reference/glib/tmpl/keyfile.sgml
   trunk/glib/gkeyfile.c

Modified: trunk/docs/reference/glib/tmpl/keyfile.sgml
==============================================================================
--- trunk/docs/reference/glib/tmpl/keyfile.sgml	(original)
+++ trunk/docs/reference/glib/tmpl/keyfile.sgml	Fri Nov 28 20:29:42 2008
@@ -34,8 +34,9 @@
 # localized strings are stored in multiple key-value pairs
 Welcome=Hello
 Welcome[de]=Hallo
-Welcome[fr]=Bonjour
+Welcome[fr_FR]=Bonjour
 Welcome[it]=Ciao
+Welcome[be latin]=Hello
 
 [Another Group]
 
@@ -58,7 +59,9 @@
 <para>
 Key-value pairs generally have the form <literal>key=value</literal>, 
 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 
 characters in value are escaped as \n, \t, \r, and \\, respectively. 
 To preserve leading spaces in values, these can also be escaped as \s.

Modified: trunk/glib/gkeyfile.c
==============================================================================
--- trunk/glib/gkeyfile.c	(original)
+++ trunk/glib/gkeyfile.c	Fri Nov 28 20:29:42 2008
@@ -1589,7 +1589,7 @@
  * @key_file: a #GKeyFile
  * @group_name: a group name
  * @key: a key
- * @locale: a locale
+ * @locale: a locale identifier
  * @string: a string
  *
  * Associates a string value for @key and @locale under @group_name.  
@@ -1625,7 +1625,7 @@
  * @key_file: a #GKeyFile
  * @group_name: a group name
  * @key: a key
- * @locale: a locale or %NULL
+ * @locale: a locale identifier or %NULL
  * @error: return location for a #GError, or %NULL
  *
  * Returns the value associated with @key under @group_name
@@ -1721,7 +1721,7 @@
  * @key_file: a #GKeyFile
  * @group_name: a group name
  * @key: a key
- * @locale: a locale
+ * @locale: a locale identifier or %NULL
  * @length: return location for the number of returned strings or %NULL
  * @error: return location for a #GError or %NULL
  *
@@ -1796,7 +1796,7 @@
  * @key_file: a #GKeyFile
  * @group_name: a group name
  * @key: a key
- * @locale: a locale
+ * @locale: a locale identifier
  * @list: a %NULL-terminated array of locale string values
  * @length: the length of @list
  *