Document previously undocumented functions. (bug 12963)

[fontconfig.git] / doc / fcfontset.fncs

diff --git a/doc/fcfontset.fncs b/doc/fcfontset.fncs
index 9c739c6c7ed3c874884f93cdea36c91d5939a3d5..bcf4bd3e7fa979fd0e40b119d9f999c9807adf99 100644 (file)
--- a/doc/fcfontset.fncs
+++ b/doc/fcfontset.fncs
@@ -47,3 +47,86 @@ well.
 Adds a pattern to a font set.  Note that the pattern is not copied before
 being inserted into the set.
 @@
+
+@RET@          FcFontSet *
+@FUNC@         FcFontSetList
+@TYPE1@                FcConfig *                      @ARG1@          config
+@TYPE2@                FcFontSet **                    @ARG2@          sets
+@TYPE3@                int                             @ARG3@          nsets
+@TYPE4@                FcPattern *                     @ARG4@          pattern
+@TYPE5@                FcObjectSet *                   @ARG5@          object_set
+@PURPOSE@      List fonts from a set of font sets
+@DESC@
+Selects fonts matching <parameter>pattern</parameter> from
+<parameter>sets</parameter>, creates patterns from those
+fonts containing only the objects in <parameter>object_set</parameter> and returns
+the set of unique such patterns.
+@@
+
+@RET@          FcPattern *
+@FUNC@         FcFontSetMatch
+@TYPE1@                FcConfig *                      @ARG1@          config
+@TYPE2@                FcFontSet **                    @ARG2@          sets
+@TYPE3@                int                             @ARG3@          nsets
+@TYPE4@                FcPattern *                     @ARG4@          pattern
+@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
+<parameter>pattern</parameter>; otherwise the results will not be correct.
+@@
+
+@RET@          void
+@FUNC@         FcFontSetPrint
+@TYPE1@                FcFontSet *                     @ARG1@          set
+@PURPOSE@      Print a set of patterns to stdout
+@DESC@
+This function is useful for diagnosing font related issues, printing the
+complete contents of every pattern in <parameter>set</parameter>. The format
+of the output is designed to be of help to users and developers, and may
+change at any time.
+@@
+
+@RET@          
+@FUNC@         FcFontSetSort
+@TYPE1@         FcConfig *                     @ARG1@          config
+@TYPE2@                FcFontSet **                    @ARG2@          sets
+@TYPE3@                int                             @ARG3@          nsets
+@TYPE4@                FcPattern *                     @ARG4@          pattern
+@TYPE5@                FcBool%                         @ARG5@          trim
+@TYPE6@                FcCharSet **                    @ARG6@          csp
+@TYPE7@                FcResult *                      @ARG7@          result
+@PURPOSE@      Add to a font set
+@DESC@
+Returns the list of fonts from <parameter>sets</parameter>
+sorted by closeness to <parameter>pattern</parameter>.  
+If <parameter>trim</parameter> is FcTrue,
+elements in the list which don't include Unicode coverage not provided by
+earlier elements in the list are elided.  The union of Unicode coverage of
+all of the fonts is returned in <parameter>csp</parameter>,
+if <parameter>csp</parameter> is not NULL.  This function
+should be called only after FcConfigSubstitute and FcDefaultSubstitute have
+been called for <parameter>p</parameter>;
+otherwise the results will not be correct.
+    </para><para>
+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.
+    </para><para>
+The FcFontSet returned by FcFontSetSort is destroyed by caling FcFontSetDestroy.
+@@
+
+@RET@          
+@FUNC@         FcFontSetSortDestroy
+@TYPE1@                FcFontSet *                     @ARG1@          set
+@PURPOSE@      DEPRECATED destroy a font set
+@DESC@
+This function is DEPRECATED. <function>FcFontSetSortDestroy</function>
+destroys <parameter>set</parameter> by calling
+<function>FcFontSetDestroy</function>. Applications should use
+<function>FcFontSetDestroy</function> directly instead.
+@@