Add new public API: FcCharSetDelChar()

[fontconfig.git] / doc / fccharset.fncs

diff --git a/doc/fccharset.fncs b/doc/fccharset.fncs
index 0dd7d1a5c644d4a00ac052d2c7aba176515486c6..004fdc3a0b9f67a550354d2b9b5a562054d9f2c7 100644 (file)
--- a/doc/fccharset.fncs
+++ b/doc/fccharset.fncs
@@ -13,9 +13,9 @@
  * 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,
+ * THE AUTHOR(S) 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
+ * EVENT SHALL THE AUTHOR(S) 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
@@ -51,6 +51,17 @@ returning FcFalse on failure, either as a result of a constant set or from
 running out of memory. 
 @@
 
+@RET@          FcBool 
+@FUNC@         FcCharSetDelChar
+@TYPE1@                FcCharSet *             @ARG1@          fcs
+@TYPE2@                FcChar32%               @ARG2@          ucs4 
+@PURPOSE@      Add a character to a charset
+@DESC@
+<function>FcCharSetDelChar</function> deletes a single unicode char from the set,
+returning FcFalse on failure, either as a result of a constant set or from
+running out of memory.
+@@
+
 @RET@          FcCharSet *
 @FUNC@         FcCharSetCopy
 @TYPE1@                FcCharSet *             @ARG1@          src
@@ -98,17 +109,19 @@ 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@          FcCharSet *
+@RET@          FcBool
 @FUNC@         FcCharSetMerge
-@TYPE1@                const FcCharSet *       @ARG1@          a
+@TYPE1@                FcCharSet *             @ARG1@          a
 @TYPE2@                const FcCharSet *       @ARG2@          b
+@TYPE3@                FcBool *                @ARG3@          changed
 @PURPOSE@      Merge charsets
 @DESC@
-If <parameter>a</parameter> is NULL, returns a newly-created copy of <parameter>b</parameter>.
-If <parameter>a</parameter> is an FcCharSet object owned by fontconfig that
-cannot be modified, it returns the union of <parameter>a</parameter> and
-<parameter>b</parameter> in a newly-created FcCharSet object.
-Otherwise, adds all chars in <parameter>b</parameter> to <parameter>a</parameter> and returns <parameter>a</parameter>.  In other words, this is an in-place versionof FcCharSetUnion.
+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