]> git.wh0rd.org - fontconfig.git/blobdiff - doc/fcconstant.fncs
[xml] Remove unused code
[fontconfig.git] / doc / fcconstant.fncs
index 9617cba20cc61c70e1f2bdb87174e731deb48798..86150f203a5739109011d1925f7ceda68b087c07 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * $Id$
+ * fontconfig/doc/fcconstant.fncs
  *
  * Copyright © 2003 Keith Packard
  *
@@ -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
 @RET@          FcBool
 @FUNC@         FcNameRegisterConstants 
 @TYPE1@                const FcConstant *              @ARG1@          consts
-@TYPE2@                int                             @ARG2@          nconsts
+@TYPE2@                int%                            @ARG2@          nconsts
 @PURPOSE@      Register symbolic constants
 @DESC@
-Register <parameter>nconsts</parameter> new symbolic constants.
+Register <parameter>nconsts</parameter> new symbolic constants. Returns
+FcFalse if the constants cannot be registered (due to allocation failure).
+Otherwise returns FcTrue.
 @@
 
 @RET@          FcBool
 @FUNC@         FcNameUnregisterConstants
 @TYPE1@                const FcConstant *              @ARG1@          consts
-@TYPE2@                int                             @ARG2@          nconsts
+@TYPE2@                int%                            @ARG2@          nconsts
 @PURPOSE@      Unregister symbolic constants
 @DESC@
-Unregister <parameter>nconsts</parameter> symbolic constants.
+Unregister <parameter>nconsts</parameter> symbolic constants. Returns
+FcFalse if the specified constants were not registered. Otherwise returns
+FcTrue.
 @@
 
 @RET@          const FcConstant *