Document several function return values (Bug 13145).

[fontconfig.git] / doc / fcatomic.fncs

diff --git a/doc/fcatomic.fncs b/doc/fcatomic.fncs
index ae27c687f5e2d5be3beba4a8bd4f842ba01eb02e..54ea6961fd5f9bdc326068f4d5dcfe0e501eba17 100644 (file)
--- a/doc/fcatomic.fncs
+++ b/doc/fcatomic.fncs
@@ -65,7 +65,9 @@ Returns the file refernced by <parameter>atomic</parameter>.
 @TYPE1@         FcAtomic *                      @ARG1@          atomic
 @PURPOSE@      replace original with new
 @DESC@
-Replaces the original file referenced by <parameter>atomic</parameter> with the new file.
+Replaces the original file referenced by <parameter>atomic</parameter> with
+the new file. Returns FcFalse if the file cannot be replaced due to
+permission issues in the filesystem. Otherwise returns FcTrue.
 @@
 
 @RET@           void