Document how to free return value of FcNameUnparse()

[fontconfig.git] / doc / fcconstant.fncs

diff --git a/doc/fcconstant.fncs b/doc/fcconstant.fncs
index 9617cba20cc61c70e1f2bdb87174e731deb48798..e49235963c3397275cb3e8bbfcf476f289506933 100644 (file)
--- a/doc/fcconstant.fncs
+++ b/doc/fcconstant.fncs
@@ -1,5 +1,5 @@
 /*
- * $Id$
+ * fontconfig/doc/fcconstant.fncs
  *
  * Copyright © 2003 Keith Packard
  *
@@ -24,19 +24,23 @@
 @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 *