From: Javier Jardón <jjardon@gnome.org>
Date: Sun, 6 Jun 2010 02:57:46 +0000 (+0200)
Subject: [docs] Improve the g_get_user_data_dir() docs
X-Git-Tag: 2.25.8~29
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e40b5ae3ef6a637f1469557b8d7be94a9cf59f6e;p=platform%2Fupstream%2Fglib.git

[docs] Improve the g_get_user_data_dir() docs

The retrieved directory is XDG_DATA_HOME on UNIX platforms.
Also mention the retrieved directory on Windows: CSIDL_PERSONAL.
---

diff --git a/glib/gutils.c b/glib/gutils.c
index f74f0ec..04d77bc 100644
--- a/glib/gutils.c
+++ b/glib/gutils.c
@@ -2049,8 +2049,12 @@ g_set_application_name (const gchar *application_name)
  *
  * 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_DATA_HOME.
+ *
+ * On Windows is the virtual folder that represents the My Documents
+ * desktop item. See documentation for CSIDL_PERSONAL.
+ *
  * Return value: a string owned by GLib that must not be modified 
  *               or freed.
  * Since: 2.6