[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.
This commit is contained in:
Javier Jardón 2010-06-06 05:05:15 +02:00
parent e40b5ae3ef
commit 07777db60d

View File

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