luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-10 19:36:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Improve the g_get_user_config_dir() docs a bit

Browse Source 
The retrieved directory is XDG_CONFIG_HOME on UNIX platforms.
Also mention the retrieved directory on Windows: CSIDL_APPDATA.
This commit is contained in:
Javier Jardón 2010-06-05 18:34:38 +02:00
parent 61f3f45cb9
commit b2718ee71a
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
glib/gutils.c
View File

@ -2131,7 +2131,13 @@ 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.