Document that Match calls FcFontRenderPrepare (bug 13162).

The behaviour of FcFontMatch and FcFontSetMatch is hard to understand without
knowing that they call FcFontRenderPrepare.

diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs
index 468bb77b833ea97a8c89799fccf60abd380c37a9..4a83f46085ed254e5137f5f5357ca0a9bafbe46a 100644 (file)
--- a/doc/fcconfig.fncs
+++ b/doc/fcconfig.fncs
@@ -243,9 +243,13 @@ if the substitution cannot be performed (due to allocation failure). Otherwise r
 @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 *
@@ -267,7 +271,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.
 @@

diff --git a/doc/fcfontset.fncs b/doc/fcfontset.fncs
index e9e170143e5f5c1877ad8a5d8b1c42782070b0f9..3e214aa180dbf654414bb248897a8d78534fcf6d 100644 (file)
--- a/doc/fcfontset.fncs
+++ b/doc/fcfontset.fncs
@@ -73,10 +73,14 @@ the set of unique such patterns.
 @TYPE5@                FcResult *                      @ARG5@          result
 @PURPOSE@      Return the best font from a set of font sets
 @DESC@
-Returns the font in <parameter>sets</parameter> most close matching
-<parameter>pattern</parameter>.  This function should be called only after
-FcConfigSubstitute and FcDefaultSubstitute have been called for
+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>pattern</parameter>; otherwise the results will not be correct.
+Returns NULL if an error occurs during this process.
 @@
 
 @RET@          void
@@ -116,7 +120,7 @@ The returned FcFontSet references FcPattern structures which may be shared
 by the return value from multiple FcFontSort calls, applications cannot
 modify these patterns.  Instead, they should be passed, along with
 <parameter>pattern</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 FcFontSetSort is destroyed by caling FcFontSetDestroy.
 @@