Commit b2718ee7 authored by Javier Jardón's avatar Javier Jardón

[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.
parent 61f3f45c
......@@ -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
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment