Update documentation for FcStrCopyFilename (bug 12964).

[fontconfig.git] / doc / fcstring.fncs

diff --git a/doc/fcstring.fncs b/doc/fcstring.fncs
index cea8981756b47d6d9551093f25e67be610d60159..8ee20e51c6ffd0e4b7ad891cc5585a48e1caa28c 100644 (file)
--- a/doc/fcstring.fncs
+++ b/doc/fcstring.fncs
@@ -146,11 +146,16 @@ letters to lower case and returns the allocated buffer.
 @RET@          FcChar8 *
 @FUNC@         FcStrCopyFilename
 @TYPE1@                const FcChar8 *                 @ARG1@          s
-@PURPOSE@      copy a string, expanding '~'
-@DESC@
-Just like FcStrCopy except that it converts any leading '~' characters in
-<parameter>s</parameter> to the value of the HOME environment variable.
-Returns NULL if '~' is present in <parameter>s</parameter> and HOME is unset.
+@PURPOSE@      create a complete path from a filename
+@DESC@
+<function>FcStrCopyFilename</function> constructs an absolute pathname from
+<parameter>s</parameter>. It converts any leading '~' characters in
+to the value of the HOME environment variable, and any relative paths are
+converted to absolute paths using the current working directory. Sequences
+of '/' characters are converted to a single '/', and names containing the
+current directory '.' or parent directory '..' are correctly reconstructed.
+Returns NULL if '~' is the leading character and HOME is unset or disabled
+(see <function>FcConfigEnableHome</function>).
 @@
 
 @RET@          int