Change FcCharSetMerge API

[fontconfig.git] / doc / fccharset.fncs

diff --git a/doc/fccharset.fncs b/doc/fccharset.fncs
index cb07680947b46cf412c4366168781c09f8a6e11e..de06aa49be40fd8caec8e3086caadd676d0d230d 100644 (file)
--- a/doc/fccharset.fncs
+++ b/doc/fccharset.fncs
@@ -1,5 +1,5 @@
 /*
- * $Id$
+ * fontconfig/doc/fccharset.fncs
  *
  * Copyright © 2003 Keith Packard
  *
@@ -98,6 +98,21 @@ Returns a set including only those chars found in either <parameter>a</parameter
 Returns a set including only those chars found in <parameter>a</parameter> but not <parameter>b</parameter>. 
 @@
 
+@RET@          FcBool
+@FUNC@         FcCharSetMerge
+@TYPE1@                FcCharSet *             @ARG1@          a
+@TYPE2@                const FcCharSet *       @ARG2@          b
+@TYPE3@                FcBool *                @ARG3@          changed
+@PURPOSE@      Merge charsets
+@DESC@
+Adds all chars in <parameter>b</parameter> to <parameter>a</parameter>.
+In other words, this is an in-place version of FcCharSetUnion.
+If <parameter>changed</parameter> is not NULL, then it returns whether any new
+chars from <parameter>b</parameter> were added to <parameter>a</parameter>.
+Returns FcFalse on failure, either when <parameter>a</parameter> is a constant
+set or from running out of memory.
+@@
+
 @RET@          FcBool 
 @FUNC@         FcCharSetHasChar
 @TYPE1@                const FcCharSet *       @ARG1@          fcs
@@ -165,3 +180,27 @@ Builds an array of bits marking the Unicode coverage of <parameter>a</parameter>
 <parameter>*next</parameter>. Returns the base of the array. <parameter>next</parameter> contains the next page in
 the font. 
 @@
+
+@RET@          FcChar32
+@FUNC@         FcCharSetCoverage
+@TYPE1@                const FcCharSet *       @ARG1@          a
+@TYPE2@                FcChar32                @ARG2@          page
+@TYPE3@                FcChar32[8]             @ARG3@          result
+@PURPOSE@      DEPRECATED return coverage for a Unicode page
+@DESC@
+DEPRECATED
+This function returns a bitmask in <parameter>result</parameter> which
+indicates which code points in
+<parameter>page</parameter> are included in <parameter>a</parameter>.
+<function>FcCharSetCoverage</function> returns the next page in the charset which has any
+coverage.
+@@
+
+@RET@          FcCharSet *
+@FUNC@         FcCharSetNew
+@TYPE1@                void
+@PURPOSE@      DEPRECATED alias for FcCharSetCreate
+@DESC@
+<function>FcCharSetNew</function> is a DEPRECATED alias for FcCharSetCreate.
+@@
+