Update documentation for stale FcConfigGetConfig function.

[fontconfig.git] / doc / fcconfig.fncs

diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs
index e29c392c8f17f336697d42e7e74b2232e08ab5dd..3c3ea06a605f0929a7c7ad956693c507eb267073 100644 (file)
--- a/doc/fcconfig.fncs
+++ b/doc/fcconfig.fncs
@@ -61,8 +61,29 @@ Returns the current default configuration.
 @TYPE1@         FcConfig *                      @ARG1@          config
 @PURPOSE@      Check timestamps on config files
 @DESC@
-Checks all of the files related to <parameter>config</parameter> and returns whether the
-in-memory version is in sync with the disk version.
+Checks all of the files related to <parameter>config</parameter> and returns
+whether any of them has been modified since the configuration was created.
+@@
+
+@RET@          FcBool
+@FUNC@         FcConfigHome
+@TYPE1@                void
+@PURPOSE@      return the current home directory.
+@DESC@
+Return the current user's home directory, if it is available, and if using it
+is enabled. See also <function>FcConfigEnableHome</function>).
+@@
+
+@RET@          FcBol
+@FUNC@         FcConfigEnableHome
+@TYPE1@                FcBool%                         @ARG1@          enable
+@PURPOSE@      controls use of the home directory.
+@DESC@
+If <parameter>enable</parameter> is FcTrue, then Fontconfig will use various
+files which are specified relative to the user's home directory (using the ~
+notation in the configuration). When <parameter>enable</parameter> is
+FcFalse, then all use of the home directory in these contexts will be
+disabled. The previous setting of the value is returned.
 @@
 
 @RET@           FcBool
@@ -106,9 +127,20 @@ Note that this will not include any configuration done with FcConfigParse.
 @RET@           char *
 @FUNC@          FcConfigGetCache
 @TYPE1@         FcConfig *                      @ARG1@          config
-@PURPOSE@      Get cache filename
+@PURPOSE@      DEPRECATED used to return per-user cache filename
+@DESC@
+With fontconfig no longer using per-user cache files, this function now
+simply returns NULL to indicate that no per-user file exists.
+@@
+
+@RET@          FcStrList *
+@FUNC@         FcConfigGetCacheDirs
+@TYPE1@                FcConfig *                      @ARG1@          config
+@PURPOSE@      return the list of directories searched for cache files
 @DESC@
-Returns the name of the file used to store per-user font information.
+<function>FcConfigGetCacheDirs</function> returns a string list containing
+all of the directories that fontconfig will search when attempting to load a
+cache file for a font directory.
 @@
 
 @RET@           FcFontSet *
@@ -131,7 +163,7 @@ blanks were present in the configuration, this function will return 0.
 @@
 
 @RET@           int
-@FUNC@          FcConfigGetRescanInverval
+@FUNC@          FcConfigGetRescanInterval
 @TYPE1@         FcConfig *                      @ARG1@          config
 @PURPOSE@      Get config rescan interval
 @DESC@
@@ -141,7 +173,7 @@ a call to FcFontList when this interval has passed since the last check.
 @@
 
 @RET@           FcBool
-@FUNC@          FcConfigSetRescanInverval
+@FUNC@          FcConfigSetRescanInterval
 @TYPE1@         FcConfig *                     @ARG1@          config
 @TYPE2@                int%                            @ARG2@          rescanInterval
 @PURPOSE@      Set config rescan interval
@@ -282,7 +314,7 @@ FC_CONFIG_DIR environment variable.
 @FUNC@         FcConfigParseAndLoad
 @TYPE1@                FcConfig *                      @ARG1@          config
 @TYPE2@                const FcChar8 *                 @ARG2@          file
-@TYPE2@                FcBool%                         @ARG3@          complain
+@TYPE3@                FcBool%                         @ARG3@          complain
 @PURPOSE@      load a configuration file
 @DESC@
 Walks the configuration in 'file' and constructs the internal representation