Rename Bambara orthography from 'bam' to 'bm' (bug #20175)

[fontconfig.git] / doc / fcpattern.fncs

diff --git a/doc/fcpattern.fncs b/doc/fcpattern.fncs
index e071c8134c83734c4e6d509e684721a2aad813ba..35ef68bdfbf9eb04da21ff638250c398bd270262 100644 (file)
--- a/doc/fcpattern.fncs
+++ b/doc/fcpattern.fncs
@@ -253,7 +253,7 @@ within the pattern directly.  Applications must not free this value.
 @TYPE4+++++@   FcBool *                        @ARG4+++++@     b 
 
 @PROTOTYPE++++++@
-@RET++++++@    FcBool
+@RET++++++@    FcResult
 @FUNC++++++@   FcPatternGetFTFace
 @TYPE1++++++@  FcPattern *                     @ARG1++++++@    p
 @TYPE2++++++@  const char *                    @ARG2++++++@    object
@@ -261,7 +261,7 @@ within the pattern directly.  Applications must not free this value.
 @TYPE3++++++@  FT_Face *                       @ARG3++++++@    f
 
 @PROTOTYPE+++++++@
-@RET+++++++@   FcBool
+@RET+++++++@   FcResult
 @FUNC+++++++@  FcPatternGetLangSet
 @TYPE1+++++++@         FcPattern *                     @ARG1+++++++@   p
 @TYPE2+++++++@ const char *                    @ARG2+++++++@   object
@@ -395,3 +395,23 @@ Converts the given pattern into the standard text format described above.
 The return value is not static, but instead refers to newly allocated memory
 which should be freed by the caller using free().
 @@
+
+@RET@          FcChar8 *
+@FUNC@         FcPatternFormat
+@TYPE1@                FcPattern *                     @ARG1@          pat
+@TYPE2@                const FcChar8 *                 @ARG2@          format
+@PURPOSE@      Format a pattern into a string according to a format specifier
+@DESC@
+
+Converts the given pattern into text format described by the format specifier.
+The format specifier is similar to a C style printf string, which the
+printf(2) man page provides a good introduction to. However, as fontconfig
+already knows the type of data that is being printed, you must omit the type
+specifier. In its place put the element name you wish to print enclosed in
+curly braces ({}). For example, to print the family name and style the
+pattern, use the format "%{family} %{style}\n".
+There can be an option width specifier after the percent sign and before
+the opening brace.  The width modifier acts similar to those in printf.
+The return value refers to newly allocated memory which should be freed by the
+caller using free(), or NULL if <parameter>format</parameter> is invalid.
+@@