diff options
| author | Javier Jardón <jjardon@gnome.org> | 2010-06-06 05:05:15 +0200 |
|---|---|---|
| committer | Javier Jardón <jjardon@gnome.org> | 2010-06-06 05:05:15 +0200 |
| commit | 07777db60d82c8f81feb407ec453f244ba10787c (patch) | |
| tree | 5a32a36744f3d009241a9953a0a420b0237d73f4 | |
| parent | e40b5ae3ef6a637f1469557b8d7be94a9cf59f6e (diff) | |
[docs] Improve the g_get_user_cache_dir() docs
The retrieved directory is XDG_CACHE_HOME on UNIX platforms.
Also mention the retrieved directory on Windows: CSIDL_INTERNET_CACHE.
| -rw-r--r-- | glib/gutils.c | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/glib/gutils.c b/glib/gutils.c index 04d77bc17..7337f74e3 100644 --- a/glib/gutils.c +++ b/glib/gutils.c @@ -2167,8 +2167,14 @@ g_get_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_CACHE_HOME. + * + * On Windows is the directory that serves as a common repository for + * temporary Internet files. A typical path is + * C:\Documents and Settings\username\Local Settings\Temporary Internet Files. + * See documentation for CSIDL_INTERNET_CACHE. + * * Return value: a string owned by GLib that must not be modified * or freed. * Since: 2.6 |