Replace incorrect documentation uses of 'char' with 'FcChar8' (bug 13002).

[fontconfig.git] / doc / fcconfig.fncs

diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs
index 998974fb55a82873fcb794d0af57a58f3d85bc7a..bf4f1dd5654f884f070dfe3ab7f61336cbe44b03 100644 (file)
--- a/doc/fcconfig.fncs
+++ b/doc/fcconfig.fncs
@@ -121,15 +121,15 @@ filesystem.
 @PURPOSE@      Get config files
 @DESC@
 Returns the list of known configuration files used to generate <parameter>config</parameter>.
-Note that this will not include any configuration done with FcConfigParse.
 @@
 
-@RET@           char *
+@RET@           FcChar8 *
 @FUNC@          FcConfigGetCache
 @TYPE1@         FcConfig *                      @ARG1@          config
-@PURPOSE@      Get cache filename
+@PURPOSE@      DEPRECATED used to return per-user cache filename
 @DESC@
-Returns the name of the file used to store per-user font information.
+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 *
@@ -183,7 +183,7 @@ Sets the rescan interval; returns FcFalse if an error occurred.
 @RET@           FcBool
 @FUNC@          FcConfigAppFontAddFile
 @TYPE1@         FcConfig *                     @ARG1@          config
-@TYPE2@                const char *                    @ARG2@          file
+@TYPE2@                const FcChar8 *                 @ARG2@          file
 @PURPOSE@      Add font file to font database
 @DESC@
 Adds an application-specific font to the configuration.
@@ -192,7 +192,7 @@ Adds an application-specific font to the configuration.
 @RET@           FcBool
 @FUNC@          FcConfigAppFontAddDir
 @TYPE1@         FcConfig *                     @ARG1@          config
-@TYPE2@                const char *                    @ARG1@          dir
+@TYPE2@                const FcChar8 *                 @ARG2@          dir
 @PURPOSE@      Add fonts from directory to font database
 @DESC@
 Scans the specified directory for fonts, adding each one found to the
@@ -291,9 +291,9 @@ Selects fonts matching <parameter>p</parameter>, creates patterns from those fon
 only the objects in <parameter>os</parameter> and returns the set of unique such patterns.
 @@
 
-@RET@           char *
+@RET@           FcChar8 *
 @FUNC@          FcConfigFilename
-@TYPE1@         const char *                    @ARG1@          name
+@TYPE1@         const FcChar8 *                        @ARG1@          name
 @PURPOSE@      Find a config file
 @DESC@
 Given the specified external entity name, return the associated filename.
@@ -318,6 +318,6 @@ FC_CONFIG_DIR environment variable.
 @DESC@
 Walks the configuration in 'file' and constructs the internal representation
 in 'config'.  Any include files referenced from within 'file' will be loaded
-with FcConfigLoad and also parsed.  If 'complain' is FcFalse, no warning
+and parsed.  If 'complain' is FcFalse, no warning
 will be displayed if 'file' does not exist.
 @@