Document several function return values (Bug 13145).

[fontconfig.git] / doc / fcatomic.fncs

diff --git a/doc/fcatomic.fncs b/doc/fcatomic.fncs
index 9cd633c7547ce6778cc0dbde7e572f3530221880..54ea6961fd5f9bdc326068f4d5dcfe0e501eba17 100644 (file)
--- a/doc/fcatomic.fncs
+++ b/doc/fcatomic.fncs
@@ -38,9 +38,9 @@ a consistent and complete file without the need to lock for reading.
 @TYPE1@         FcAtomic *                      @ARG1@          atomic
 @PURPOSE@      lock a file
 @DESC@
-Attempts to lock the file referenced by <parameter>atomic</parameter>.  Returns FcFalse if the
-file is locked by another process, else returns FcTrue and leaves the file
-locked.
+Attempts to lock the file referenced by <parameter>atomic</parameter>.
+Returns FcFalse if the file is already locked, else returns FcTrue and
+leaves the file locked.
 @@
 
 @RET@           FcChar8 *
@@ -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