[docs] Improve the g_get_user_config_dir() docs a bit
authorJavier Jardón <jjardon@gnome.org>
Sat, 5 Jun 2010 16:34:38 +0000 (18:34 +0200)
committerJavier Jardón <jjardon@gnome.org>
Sat, 5 Jun 2010 16:40:07 +0000 (18:40 +0200)
The retrieved directory is XDG_CONFIG_HOME on UNIX platforms.
Also mention the retrieved directory on Windows: CSIDL_APPDATA.

glib/gutils.c

index 744663e..f74f0ec 100644 (file)
@@ -2131,8 +2131,14 @@ g_init_user_config_dir (void)
  *
  * On UNIX platforms this is determined using the mechanisms described in
  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
- * XDG Base Directory Specification</ulink>
- * 
+ * XDG Base Directory Specification</ulink>.
+ * In this case the directory retrieved will be XDG_CONFIG_HOME.
+ *
+ * On Windows is the directory that serves as a common repository for
+ * application-specific data. A typical path is
+ * C:\Documents and Settings\username\Application. See documentation for
+ * CSIDL_APPDATA.
+ *
  * Return value: a string owned by GLib that must not be modified 
  *               or freed.
  * Since: 2.6