diff options
| author | Keith Packard <keithp@koto.keithp.com> | 2007-11-13 14:58:39 -0800 |
|---|---|---|
| committer | Keith Packard <keithp@koto.keithp.com> | 2007-11-13 14:58:39 -0800 |
| commit | fab44f3cb63dc8bd1285dcbd6ad4f1f468f91daf (patch) | |
| tree | 1a5bd53ce2a1f863243f8030de369f0bbf842f47 /doc/fcconstant.fncs | |
| parent | ed7955a58f93927eb304ecf8d4d5274dbdc2362b (diff) | |
Document several function return values (Bug 13145).
Several functions had no indication of what the return value would be,
mostly these were allocation failure returns.
Diffstat (limited to 'doc/fcconstant.fncs')
| -rw-r--r-- | doc/fcconstant.fncs | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/fcconstant.fncs b/doc/fcconstant.fncs index a09bb392..8fb4e901 100644 --- 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 * |