]> git.wh0rd.org - fontconfig.git/blobdiff - doc/fcconstant.fncs
Cleanup copyright notices to replace "Keith Packard" with "the author(s)"
[fontconfig.git] / doc / fcconstant.fncs
index 0ba9d8d395fddba6b5388e0bb0cac03fb264e043..2ead0a6f0bb8bd0e769cc9ef8f61633528eb8361 100644 (file)
@@ -1,21 +1,21 @@
 /*
- * $Id$
+ * fontconfig/doc/fcconstant.fncs
  *
- * Copyright © 2003 Keith Packard
+ * 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
+ * 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
 @RET@          FcBool
 @FUNC@         FcNameRegisterConstants 
 @TYPE1@                const FcConstant *              @ARG1@          consts
-@TYPE2@                int                             @ARG2@          nconsts
+@TYPE2@                int%                            @ARG2@          nconsts
 @PURPOSE@      Register symbolic constants
 @DESC@
-Register 'nconsts' 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 'nconsts' symbolic constants.
+Unregister <parameter>nconsts</parameter> symbolic constants. Returns
+FcFalse if the specified constants were not registered. Otherwise returns
+FcTrue.
 @@
 
 @RET@          const FcConstant *
@@ -44,7 +48,7 @@ Unregister 'nconsts' symbolic constants.
 @TYPE1@                FcChar8 *                       @ARG1@          string
 @PURPOSE@      Lookup symbolic constant
 @DESC@
-Return the FcConstant structure related to symbolic constant 'string'.
+Return the FcConstant structure related to symbolic constant <parameter>string</parameter>.
 @@
 
 @RET@          FcBool
@@ -53,6 +57,6 @@ Return the FcConstant structure related to symbolic constant 'string'.
 @TYPE2@                int *                           @ARG2@          result
 @PURPOSE@      Get the value for a symbolic constant
 @DESC@
-Returns whether a symbolic constant with name 'string' is registered,
-placing the value of the constant in 'result' if present.
+Returns whether a symbolic constant with name <parameter>string</parameter> is registered,
+placing the value of the constant in <parameter>result</parameter> if present.
 @@