Bug 41171 - Invalid use of memset

[fontconfig.git] / doc / fccharset.fncs

diff --git a/doc/fccharset.fncs b/doc/fccharset.fncs
index 93e1f5c1e5fcfac1f3e0e14bd8d466930185a61b..036870d3b3630469217d20d7df7e2388cbd72c2c 100644 (file)
--- a/doc/fccharset.fncs
+++ b/doc/fccharset.fncs
@@ -7,15 +7,15 @@
  * 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.
  *
- * 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
@@ -46,11 +46,22 @@ memory referenced is freed.
 @TYPE2@                FcChar32%               @ARG2@          ucs4 
 @PURPOSE@      Add a character to a charset
 @DESC@
-<function>FcCharSetAddChar</function> adds a single unicode char to the set,
+<function>FcCharSetAddChar</function> adds a single Unicode char to the set,
 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
@@ -67,7 +78,7 @@ than increment the reference count on <parameter>src</parameter>.
 @PURPOSE@      Compare two charsets
 @DESC@
 Returns whether <parameter>a</parameter> and <parameter>b</parameter>
-contain the same set of unicode chars.
+contain the same set of Unicode chars.
 @@
 
 @RET@          FcCharSet *
@@ -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 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 
@@ -125,7 +138,7 @@ Returns whether <parameter>fcs</parameter> contains the char <parameter>ucs4</pa
 @TYPE1@                const FcCharSet *       @ARG1@          a
 @PURPOSE@      Count entries in a charset
 @DESC@
-Returns the total number of unicode chars in <parameter>a</parameter>. 
+Returns the total number of Unicode chars in <parameter>a</parameter>. 
 @@
 
 @RET@          FcChar32