[docs] Improve the g_get_user_cache_dir() docs
authorJavier Jardón <jjardon@gnome.org>
Sun, 6 Jun 2010 03:05:15 +0000 (05:05 +0200)
committerJavier Jardón <jjardon@gnome.org>
Sun, 6 Jun 2010 03:05:15 +0000 (05:05 +0200)
The retrieved directory is XDG_CACHE_HOME on UNIX platforms.
Also mention the retrieved directory on Windows: CSIDL_INTERNET_CACHE.

glib/gutils.c

index 04d77bc..7337f74 100644 (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