Document previously undocumented functions. (bug 12963)

[fontconfig.git] / doc / fcpattern.fncs

diff --git a/doc/fcpattern.fncs b/doc/fcpattern.fncs
index c04d9b3069bf2d0af8f6cd90ab354f165a3a686e..74f367587d7293911386730cdac8da69603a7637 100644 (file)
--- a/doc/fcpattern.fncs
+++ b/doc/fcpattern.fncs
@@ -29,12 +29,32 @@
 Creates a pattern with no properties; used to build patterns from scratch.
 @@
 
+@RET@          FcPattern *     
+@FUNC@         FcPatternDuplicate
+@TYPE1@                FcPattern *                     @ARG1@           p
+@PURPOSE@      Copy a pattern
+@DESC@
+Copy a pattern, returning a new pattern that matches
+<parameter>p</parameter>. Each pattern may be modified without affecting the
+other.
+@@
+
+@RET@          void
+@FUNC@         FcPatternReference
+@TYPE1@                FcPattern *                     @ARG1@           p
+@PURPOSE@      Increment pattern reference count
+@DESC@
+Add another reference to <parameter>p</parameter>. Patterns are freed only
+when the reference count reaches zero.
+@@
+
 @RET@          void
 @FUNC@         FcPatternDestroy
 @TYPE1@                FcPattern *                     @ARG1@           p
 @PURPOSE@      Destroy a pattern
 @DESC@
-Destroys a pattern, in the process destroying all related values.
+Decrement the pattern reference count. If all references are gone, destroys
+the pattern, in the process destroying all related values.
 @@
 
 @RET@          FcBool
@@ -134,6 +154,21 @@ values added to the list have binding <parameter>weak</parameter> instead of <pa
 @TYPE1+++++@   FcPattern *                     @ARG1+++++@     p
 @TYPE2+++++@   const char *                    @ARG2+++++@     object
 @TYPE3+++++@   FcBool%                         @ARG3+++++@     b
+
+@PROTOTYPE++++++@
+@RET++++++@    FcBool
+@FUNC++++++@   FcPatternAddFTFace
+@TYPE1++++++@  FcPattern *                     @ARG1++++++@    p
+@TYPE2++++++@  const char *                    @ARG2++++++@    object
+@TYPE3++++++@  const FT_Face                   @ARG3++++++@    f
+
+@PROTOTYPE+++++++@
+@RET+++++++@   FcBool
+@FUNC+++++++@  FcPatternAddLangSet
+@TYPE1+++++++@         FcPattern *                     @ARG1+++++++@   p
+@TYPE2+++++++@ const char *                    @ARG2+++++++@   object
+@TYPE3+++++++@ const FcLangSet *               @ARG3+++++++@   l
+
 @PURPOSE@      Add a typed value to a pattern
 @DESC@
 These are all convenience functions that insert objects of the specified
@@ -204,6 +239,21 @@ within the pattern directly.  Applications must not free this value.
 @TYPE2+++++@   const char *                    @ARG2+++++@     object 
 @TYPE3+++++@   int%                            @ARG3+++++@     n 
 @TYPE4+++++@   FcBool *                        @ARG4+++++@     b 
+
+@PROTOTYPE++++++@
+@RET++++++@    FcBool
+@FUNC++++++@   FcPatternGetFTFace
+@TYPE1++++++@  FcPattern *                     @ARG1++++++@    p
+@TYPE2++++++@  const char *                    @ARG2++++++@    object
+@TYPE3++++++@  const FT_Face *                 @ARG3++++++@    f
+
+@PROTOTYPE+++++++@
+@RET+++++++@   FcBool
+@FUNC+++++++@  FcPatternGetLangSet
+@TYPE1+++++++@         FcPattern *                     @ARG1+++++++@   p
+@TYPE2+++++++@ const char *                    @ARG2+++++++@   object
+@TYPE3+++++++@ const FcLangSet **              @ARG3+++++++@   l
+
 @PURPOSE@      Return a typed value from a pattern
 @DESC@
 These are convenience functions that call FcPatternGet and verify that the