Document several function return values (Bug 13145).

[fontconfig.git] / doc / fcinit.fncs

diff --git a/doc/fcinit.fncs b/doc/fcinit.fncs
index 7b56282548f74166378b24936e17c044b12ae585..13e4604e5917d037779a48f5e316a82d0c1bb633 100644 (file)
--- a/doc/fcinit.fncs
+++ b/doc/fcinit.fncs
@@ -75,7 +75,9 @@ Returns the version number of the library.
 @PURPOSE@      re-initialize library
 @DESC@
 Forces the default configuration file to be reloaded and resets the default
-configuration.
+configuration. Returns FcFalse if the configuration cannot be reloaded (due
+to config file errors, allocation failures or other issues) and leaves the
+existing configuration unchanged. Otherwise returns FcTrue.
 @@
 
 @RET@           FcBool       
@@ -85,5 +87,6 @@ configuration.
 @DESC@
 Checks the rescan interval in the default configuration, checking the
 configuration if the interval has passed and reloading the configuration if
-when any changes are detected.
+when any changes are detected. Returns FcFalse if the configuration cannot
+be reloaded (see FcInitReinitialize). Otherwise returns FcTrue.
 @@