Document skipping of fonts from FcFileScan/FcDirScan.

[fontconfig.git] / doc / fcfile.fncs

diff --git a/doc/fcfile.fncs b/doc/fcfile.fncs
index b20b099fe718a85ed6c36b07c8177111b2cef393..df7400bdaf84162641361664d849d94eb1afb636 100644 (file)
--- a/doc/fcfile.fncs
+++ b/doc/fcfile.fncs
@@ -1,7 +1,7 @@
 /*
  * $Id$
  *
- * Copyright © 2003 Keith Packard
+ * Copyright © 2003 Keith Packard
  *
  * Permission to use, copy, modify, distribute, and sell this software and its
  * documentation for any purpose is hereby granted without fee, provided that
@@ -29,14 +29,15 @@
 @TYPE3@                FcFileCache *                   @ARG3@          cache   
 @TYPE4@                FcBlanks *                      @ARG4@          blanks  
 @TYPE5@                const char *                    @ARG5@          file    
-@TYPE6@                FcBool                          @ARG6@          force   
+@TYPE6@                FcBool%                                 @ARG6@          force   
 @PURPOSE@      scan a font file
 @DESC@
 Scans a single file and adds all fonts found to <parameter>set</parameter>.
 If <parameter>force</parameter> is FcTrue, then the file is scanned even if
 associated information is found in <parameter>cache</parameter>.  If
 <parameter>file</parameter> is a directory, it is added to
-<parameter>dirs</parameter>.
+<parameter>dirs</parameter>. Whether fonts are found depends on fontconfig
+poliy as well as the current configuration.
 @@
 
 @RET@          FcBool  
@@ -46,14 +47,16 @@ associated information is found in <parameter>cache</parameter>.  If
 @TYPE3@                FcFileCache *                   @ARG3@          cache   
 @TYPE4@                FcBlanks *                      @ARG4@          blanks  
 @TYPE5@                const char *                    @ARG5@          dir     
-@TYPE6@                FcBool                          @ARG6@          force   
+@TYPE6@                FcBool%                                 @ARG6@          force   
 @PURPOSE@      scan a font directory
 @DESC@
 Scans an entire directory and adds all fonts found to
 <parameter>set</parameter>.  If <parameter>force</parameter> is FcTrue, then
 the directory and all files within it are scanned even if information is
 present in the per-directory cache file or <parameter>cache</parameter>.  Any
-subdirectories found are added to <parameter>dirs</parameter>.
+subdirectories found are added to <parameter>dirs</parameter>. Whether fonts
+or directories are found depends on fontconfig
+policy as well as the current configuration.
 @@
 
 @RET@          FcBool