Remove build manpage logfile if it exists

[fontconfig.git] / doc / fcconfig.fncs

diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs
index 0081d06575f7648b9c111fccc49870532186d87c..a3a3a26cd5cbf35b1e2dcdc0a8219caf92560531 100644 (file)
--- a/doc/fcconfig.fncs
+++ b/doc/fcconfig.fncs
@@ -123,7 +123,7 @@ filesystem.
 Returns the list of known configuration files used to generate <parameter>config</parameter>.
 @@
 
-@RET@           char *
+@RET@           FcChar8 *
 @FUNC@          FcConfigGetCache
 @TYPE1@         FcConfig *                      @ARG1@          config
 @PURPOSE@      DEPRECATED used to return per-user cache filename
@@ -149,7 +149,8 @@ cache file for a font directory.
 @PURPOSE@      Get config font set
 @DESC@
 Returns one of the two sets of fonts from the configuration as specified
-by <parameter>set</parameter>.
+by <parameter>set</parameter>. This font set is owned by the library and must
+not be freed.
 @@
 
 @RET@           FcBlanks *
@@ -177,26 +178,29 @@ a call to FcFontList when this interval has passed since the last check.
 @TYPE2@                int%                            @ARG2@          rescanInterval
 @PURPOSE@      Set config rescan interval
 @DESC@
-Sets the rescan interval; returns FcFalse if an error occurred.
+Sets the rescan interval. Returns FcFalse if the interval cannot be set (due
+to allocation failure). Otherwise returns FcTrue.
 @@
 
 @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.
+Adds an application-specific font to the configuration. Returns FcFalse
+if the fonts cannot be added (due to allocation failure). Otherwise returns FcTrue.
 @@
 
 @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
-application-specific set of fonts.
+application-specific set of fonts. Returns FcFalse
+if the fonts cannot be added (due to allocation failure). Otherwise returns FcTrue.
 @@
 
 @RET@           void
@@ -218,7 +222,8 @@ Clears the set of application-specific fonts.
 Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
 FcMatchPattern, then those tagged as pattern operations are applied, else
 if <parameter>kind</parameter> is FcMatchFont, those tagged as font operations are applied and
-p_pat is used for &lt;test&gt; elements with target=pattern.
+p_pat is used for &lt;test&gt; elements with target=pattern. Returns FcFalse
+if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue.
 @@
 
 @RET@           FcBool
@@ -228,7 +233,8 @@ p_pat is used for &lt;test&gt; elements with target=pattern.
 @TYPE3@                FcMatchKind%                    @ARG3@          kind
 @PURPOSE@      Execute substitutions
 @DESC@
-Calls FcConfigSubstituteWithPat setting p_pat to NULL.
+Calls FcConfigSubstituteWithPat setting p_pat to NULL. Returns FcFalse
+if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue.
 @@
 
 @RET@           FcPattern *
@@ -238,9 +244,13 @@ Calls FcConfigSubstituteWithPat setting p_pat to NULL.
 @TYPE3@                FcResult *                      @ARG3@          result
 @PURPOSE@      Return best font
 @DESC@
-Returns the font in <parameter>config</parameter> most close matching <parameter>p</parameter>.  This function
-should be called only after FcConfigSubstitute and FcDefaultSubstitute have
-been called for <parameter>p</parameter>; otherwise the results will not be correct.
+Finds the font in <parameter>sets</parameter> most closely matching
+<parameter>pattern</parameter> and returns the result of
+<function>FcFontRenderPrepare</function> for that font and the provided
+pattern. This function should be called only after
+<function>FcConfigSubstitute</function> and
+<function>FcDefaultSubstitute</function> have been called for
+<parameter>p</parameter>; otherwise the results will not be correct.
 @@
 
 @RET@           FcFontSet *
@@ -262,7 +272,7 @@ been called for <parameter>p</parameter>; otherwise the results will not be corr
 The returned FcFontSet references FcPattern structures which may be shared
 by the return value from multiple FcFontSort calls, applications must not
 modify these patterns.  Instead, they should be passed, along with <parameter>p</parameter> to
-FcFontRenderPrepare which combines them into a complete pattern.
+<function>FcFontRenderPrepare</function> which combines them into a complete pattern.
     </para><para>
 The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
 @@
@@ -291,9 +301,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 +328,8 @@ 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
-and parsed.  If 'complain' is FcFalse, no warning
-will be displayed if 'file' does not exist.
+and parsed.  If 'complain' is FcFalse, no warning will be displayed if
+'file' does not exist. Error and warning messages will be output to stderr.
+Returns FcFalse if some error occurred while loading the file, either a
+parse error, semantic error or allocation failure. Otherwise returns FcTrue.
 @@