Make 'make distcheck' work with automake 1.6.3.

[fontconfig.git] / doc / fcpattern.fncs

diff --git a/doc/fcpattern.fncs b/doc/fcpattern.fncs
index 4dbbed7b1c7429d99c193529d5066e572c524fa1..b049966f64d4f24d00764812054b91103fd4d3a8 100644 (file)
--- a/doc/fcpattern.fncs
+++ b/doc/fcpattern.fncs
@@ -1,7 +1,7 @@
 /*
  * $Id$
  *
- * Copyright © 2003 Keith Packard
+ * Copyright © 2003 Keith Packard
  *
  * Permission to use, copy, modify, distribute, and sell this software and its
  * documentation for any purpose is hereby granted without fee, provided that
@@ -43,7 +43,7 @@ Destroys a pattern, in the process destroying all related values.
 @TYPE2@                const FcPattern *               @ARG2@          pb 
 @PURPOSE@      Compare patterns
 @DESC@
-Returns whether 'pa' and 'pb' are exactly alike.
+Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> are exactly alike.
 @@
 
 @RET@          FcBool
@@ -53,8 +53,8 @@ Returns whether 'pa' and 'pb' are exactly alike.
 @TYPE3@        const FcObjectSet *             @ARG3@          os 
 @PURPOSE@      Compare portions of patterns
 @DESC@
-Returns whether 'pa' and 'pb' have exactly the same values for all of the
-objects in 'os'.
+Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> have exactly the same values for all of the
+objects in <parameter>os</parameter>.
 @@
 
 @RET@          FcChar32
@@ -75,7 +75,7 @@ equal.
 @PURPOSE@      Add a value to a pattern
 @DESC@
 Adds a single value to the list of values associated with the property named
-`object'.  If `append' is FcTrue, the value is added at the end of any
+`object<parameter>.  If `append</parameter> is FcTrue, the value is added at the end of any
 existing list, otherwise it is inserted at the begining.  `value' is saved
 (with FcValueSave) when inserted into the pattern so that the library
 retains no reference to any application-supplied data structure.
@@ -90,7 +90,7 @@ retains no reference to any application-supplied data structure.
 @PURPOSE@      Add a value to a pattern with weak binding
 @DESC@
 FcPatternAddWeak is essentially the same as FcPatternAdd except that any
-values added to the list have binding 'weak' instead of 'strong'.
+values added to the list have binding <parameter>weak</parameter> instead of <parameter>strong</parameter>.
 @@
 
 @TITLE@                FcPatternAdd-Type
@@ -150,7 +150,8 @@ any existing list of values.
 @TYPE4@                FcValue *                       @ARG4@          v 
 @PURPOSE@      Return a value from a pattern
 @DESC@
-Returns in `v' the `id'th value associated with the property `object'.
+Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
+associated with the property <parameter>object</parameter>.
 The value returned is not a copy, but rather refers to the data stored
 within the pattern directly.  Applications must not free this value.
 @@
@@ -226,6 +227,7 @@ in preference to FcPatternGet to provide compile-time typechecking.
 @DESC@
 Builds a pattern using a list of objects, types and values.  Each
 value to be entered in the pattern is specified with three arguments:
+</para>
 <orderedlist>
 <listitem><para>
 Object name, a string describing the property to be added.
@@ -244,7 +246,7 @@ value need be passed for this.  The values are added to `pattern', if
 returned. Example
 </para>
 <programlisting>
-pattern = FcPatternBuild (0, FC_FAMILY, FtTypeString, "Times", (char *) 0);
+pattern = FcPatternBuild (0, FC_FAMILY, FcTypeString, "Times", (char *) 0);
 </programlisting>
 <para>
 FcPatternVaBuild is used when the arguments are already in the form of a
@@ -261,6 +263,17 @@ Deletes all values associated with the property `object', returning
 whether the property existed or not.
 @@
 
+@RET@          FcBool
+@FUNC@         FcPatternRemove
+@TYPE1@                FcPattern *                     @ARG1@          p
+@TYPE2@                const char *                    @ARG2@          object 
+@TYPE3@                int                             @ARG3@          id
+@PURPOSE@      Remove one object of the specified type from the pattern
+@DESC@
+Removes the value associated with the property `object' at position `id', returning 
+whether the property existed and had a value at that position or not.
+@@
+               
 @RET@          void
 @FUNC@         FcPatternPrint
 @TYPE1@                const FcPattern *               @ARG1@          p 
@@ -296,7 +309,7 @@ specified point size (default 12), dpi (default 75) and scale (default 1).
 @TYPE1@                const char *                    @ARG1@          name 
 @PURPOSE@      Parse a pattern string
 @DESC@
-Converts 'name' from the standard text format described above into a pattern.
+Converts <parameter>name</parameter> from the standard text format described above into a pattern.
 @@
 
 @RET@          FcChar8 *