Add new spacing value FC_DUAL (dual-width, as some CJK fonts). (bug #111)

[fontconfig.git] / doc / fcpattern.fncs

diff --git a/doc/fcpattern.fncs b/doc/fcpattern.fncs
index 0d6069fc0422b2dd9f7c8a8d0eb520b192218965..4011a2633f7dca49f2837a66b0c4faab70629d3b 100644 (file)
--- a/doc/fcpattern.fncs
+++ b/doc/fcpattern.fncs
@@ -1,3 +1,26 @@
+/*
+ * $Id$
+ *
+ * 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
+ * the above copyright notice appear in all copies and that both that
+ * copyright notice and this permission notice appear in supporting
+ * documentation, and that the name of Keith Packard not be used in
+ * advertising or publicity pertaining to distribution of the software without
+ * specific, written prior permission.  Keith Packard makes no
+ * representations about the suitability of this software for any purpose.  It
+ * is provided "as is" without express or implied warranty.
+ *
+ * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+ * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
+ * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+ * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
+ * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ */
 @RET@          FcPattern *     
 @FUNC@         FcPatternCreate
 @TYPE1@        void
@@ -20,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
@@ -30,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
@@ -52,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.
@@ -67,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
@@ -127,7 +150,7 @@ 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 `v<parameter> the `id</parameter>th value associated with the property `object'.
 The value returned is not a copy, but rather refers to the data stored
 within the pattern directly.  Applications must not free this value.
 @@
@@ -203,6 +226,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.
@@ -273,7 +297,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 *