]> git.wh0rd.org - fontconfig.git/blobdiff - doc/fcpattern.fncs
Documentation fixes
[fontconfig.git] / doc / fcpattern.fncs
index 8948e88a3a7d98ea48e90377207dcf3c44444743..1df1c4f6184bfd9051b433cfb2e0f3d7e3751f42 100644 (file)
@@ -7,9 +7,9 @@
  * 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
+ * documentation, and that the name of the author(s) not be used in
  * advertising or publicity pertaining to distribution of the software without
- * specific, written prior permission.  Keith Packard makes no
+ * specific, written prior permission.  The authors make no
  * representations about the suitability of this software for any purpose.  It
  * is provided "as is" without express or implied warranty.
  *
@@ -108,7 +108,7 @@ equal.
 @DESC@
 Adds a single value to the list of values associated with the property named
 `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
+existing list, otherwise it is inserted at the beginning.  `value' is saved
 (with FcValueSave) when inserted into the pattern so that the library
 retains no reference to any application-supplied data structure.
 @@
@@ -395,23 +395,3 @@ 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.
-@@