Document previously undocumented functions. (bug 12963)

[fontconfig.git] / doc / fcconfig.fncs

diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs
index db7ee027aa40510039d23dbf746a807ae616efb9..998974fb55a82873fcb794d0af57a58f3d85bc7a 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
@@ -111,10 +132,20 @@ Note that this will not include any configuration done with FcConfigParse.
 Returns the name of the file used to store per-user font information.
 @@
 
+@RET@          FcStrList *
+@FUNC@         FcConfigGetCacheDirs
+@TYPE1@                FcConfig *                      @ARG1@          config
+@PURPOSE@      return the list of directories searched for cache files
+@DESC@
+<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 *
 @FUNC@          FcConfigGetFonts
 @TYPE1@         FcConfig *                     @ARG1@          config
-@TYPE2@                FcSetName                       @ARG2@          set
+@TYPE2@                FcSetName%                      @ARG2@          set
 @PURPOSE@      Get config font set
 @DESC@
 Returns one of the two sets of fonts from the configuration as specified
@@ -131,7 +162,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,9 +172,9 @@ 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
+@TYPE2@                int%                            @ARG2@          rescanInterval
 @PURPOSE@      Set config rescan interval
 @DESC@
 Sets the rescan interval; returns FcFalse if an error occurred.
@@ -181,7 +212,7 @@ Clears the set of application-specific fonts.
 @TYPE1@         FcConfig *                     @ARG1@          config
 @TYPE2@                FcPattern *                     @ARG2@          p
 @TYPE3@                FcPattern *                     @ARG3@          p_pat
-@TYPE4@                FcMatchKind                     @ARG4@          kind
+@TYPE4@                FcMatchKind%                     @ARG4@          kind
 @PURPOSE@      Execute substitutions
 @DESC@
 Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
@@ -194,7 +225,7 @@ p_pat is used for &lt;test&gt; elements with target=pattern.
 @FUNC@          FcConfigSubstitute
 @TYPE1@         FcConfig *                     @ARG1@          config
 @TYPE2@                FcPattern *                     @ARG2@          p
-@TYPE3@                FcMatchKind                     @ARG3@          kind
+@TYPE3@                FcMatchKind%                    @ARG3@          kind
 @PURPOSE@      Execute substitutions
 @DESC@
 Calls FcConfigSubstituteWithPat setting p_pat to NULL.
@@ -216,7 +247,7 @@ been called for <parameter>p</parameter>; otherwise the results will not be corr
 @FUNC@          FcFontSort
 @TYPE1@         FcConfig *                     @ARG1@          config
 @TYPE2@                FcPattern *                     @ARG2@          p
-@TYPE3@                FcBool                          @ARG3@          trim
+@TYPE3@                FcBool%                         @ARG3@          trim
 @TYPE4@                FcCharSet **                    @ARG4@          csp
 @TYPE5@                FcResult *                      @ARG5@          result
 @PURPOSE@      Return list of matching fonts
@@ -282,7 +313,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
@@ -290,14 +321,3 @@ in 'config'.  Any include files referenced from within 'file' will be loaded
 with FcConfigLoad and also parsed.  If 'complain' is FcFalse, no warning
 will be displayed if 'file' does not exist.
 @@
-
-@RET@          const FcChar8 *
-@FUNC@         FcConfigNormalizeFontDir
-@TYPE1@                FcConfig *                      @ARG1@          config
-@TYPE2@                const FcChar8 *                 @ARG2@          dir
-@PURPOSE@      normalize a font directory
-@DESC@
-Converts the directory name given in 'dir' to a normal form, i.e. one 
-of the forms which are derived from the font directories specified
-in the config file.
-@@