Document several function return values (Bug 13145).

[fontconfig.git] / doc / fcconstant.fncs

diff --git a/doc/fcconstant.fncs b/doc/fcconstant.fncs
index a09bb39211b838d155fef4e5821c72827c5bb6b2..8fb4e90107c6058ea9667e17d6844cd3c80f31f4 100644 (file)
--- a/doc/fcconstant.fncs
+++ b/doc/fcconstant.fncs
@@ -27,7 +27,9 @@
 @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
@@ -36,7 +38,9 @@ Register <parameter>nconsts</parameter> new symbolic constants.
 @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 *