Document previously undocumented functions. (bug 12963)

[fontconfig.git] / doc / fccharset.fncs

diff --git a/doc/fccharset.fncs b/doc/fccharset.fncs
index ea22aa173bd13f8c102738752446b02c5bfed336..f4e81a76b45bc8a65e211c7372b40d576ef11571 100644 (file)
--- a/doc/fccharset.fncs
+++ b/doc/fccharset.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@          FcCharSet *
 @FUNC@         FcCharSetCreate
 @TYPE1@                void
@@ -20,7 +43,7 @@ memory referenced is freed.
 @RET@          FcBool 
 @FUNC@         FcCharSetAddChar
 @TYPE1@                FcCharSet *             @ARG1@          fcs
-@TYPE2@                FcChar32                @ARG2@          ucs4 
+@TYPE2@                FcChar32%               @ARG2@          ucs4 
 @PURPOSE@      Add a character to a charset
 @DESC@
 <function>FcCharSetAddChar</function> adds a single unicode char to the set,
@@ -78,7 +101,7 @@ Returns a set including only those chars found in <parameter>a</parameter> but n
 @RET@          FcBool 
 @FUNC@         FcCharSetHasChar
 @TYPE1@                const FcCharSet *       @ARG1@          fcs
-@TYPE2@                FcChar32                @ARG2@          ucs4
+@TYPE2@                FcChar32%               @ARG2@          ucs4
 @PURPOSE@      Check a charset for a char
 @DESC@
 Returns whether <parameter>fcs</parameter> contains the char <parameter>ucs4</parameter>. 
@@ -122,7 +145,7 @@ Returns whether <parameter>a</parameter> is a subset of <parameter>b</parameter>
 @RET@          FcChar32
 @FUNC@         FcCharSetFirstPage
 @TYPE1@                const FcCharSet *       @ARG1@          a
-@TYPE2@                FcChar32[FC_CHARSET_MAP_SIZE]   @ARG2@  map
+@TYPE2@                FcChar32[FC_CHARSET_MAP_SIZE]%  @ARG2@  map
 @TYPE3@                FcChar32 *              @ARG3@          next
 @PURPOSE@      Start enumerating charset contents
 @DESC@
@@ -134,7 +157,7 @@ font.
 @RET@          FcChar32
 @FUNC@         FcCharSetNextPage
 @TYPE1@                const FcCharSet *       @ARG1@          a
-@TYPE2@                FcChar32[FC_CHARSET_MAP_SIZE]   @ARG2@  map
+@TYPE2@                FcChar32[FC_CHARSET_MAP_SIZE]%  @ARG2@  map
 @TYPE3@                FcChar32 *              @ARG3@          next
 @PURPOSE@      Continue enumerating charset contents
 @DESC@
@@ -142,3 +165,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.
+@@
+