[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.
This commit is contained in:
Javier Jardón 2010-06-06 04:57:46 +02:00
parent b2718ee71a
commit e40b5ae3ef

View File

@ -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