From b2718ee71ad85f2536e5e127239a5a438648de0c Mon Sep 17 00:00:00 2001
From: =?utf8?q?Javier=20Jard=C3=B3n?= <jjardon@gnome.org>
Date: Sat, 5 Jun 2010 18:34:38 +0200
Subject: [PATCH] [docs] Improve the g_get_user_config_dir() docs a bit

The retrieved directory is XDG_CONFIG_HOME on UNIX platforms.
Also mention the retrieved directory on Windows: CSIDL_APPDATA.
---
 glib/gutils.c | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/glib/gutils.c b/glib/gutils.c
index 744663e..f74f0ec 100644
--- a/glib/gutils.c
+++ b/glib/gutils.c
@@ -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
-- 
2.7.4