X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=doc%2Ffcfile.fncs;h=5f5f32a8a27baffaa46f7832aaaea58b0dde741f;hb=a53553b4b65d6230b1a91b1a7433c8c5852ab055;hp=48213655457f743b68ddbb22dc7eec724d9bd285;hpb=f2772d6b45bcfc27618968fdbb08dcc50a18be22;p=fontconfig.git
diff --git a/doc/fcfile.fncs b/doc/fcfile.fncs
index 4821365..5f5f32a 100644
--- a/doc/fcfile.fncs
+++ b/doc/fcfile.fncs
@@ -1,5 +1,5 @@
/*
- * $Id$
+ * fontconfig/doc/fcfile.fncs
*
* Copyright © 2003 Keith Packard
*
@@ -7,15 +7,15 @@
* documentation for any purpose is hereby granted without fee, provided that
* the above copyright notice appear in all copies and that both that
* copyright notice and this permission notice appear in supporting
- * documentation, and that the name of Keith Packard not be used in
+ * documentation, and that the name of the author(s) not be used in
* advertising or publicity pertaining to distribution of the software without
- * specific, written prior permission. Keith Packard makes no
+ * specific, written prior permission. The authors make no
* representations about the suitability of this software for any purpose. It
* is provided "as is" without express or implied warranty.
*
- * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+ * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
- * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+ * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
* DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
@@ -29,7 +29,7 @@
@TYPE3@ FcFileCache * @ARG3@ cache
@TYPE4@ FcBlanks * @ARG4@ blanks
@TYPE5@ const FcChar8 * @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 set.
@@ -41,7 +41,8 @@ policy as well as the current configuration. Internally, fontconfig will
ignore BDF and PCF fonts which are not in Unicode (or the effectively
equivalent ISO Latin-1) encoding as those are not usable by Unicode-based
applications. The configuration can ignore fonts based on filename or
-contents of the font file itself.
+contents of the font file itself. Returns FcFalse if any of the fonts cannot be
+added (due to allocation failure). Otherwise returns FcTrue.
@@
@RET@ FcBool
@@ -60,16 +61,15 @@ returns FcFalse.
@TYPE3@ FcFileCache * @ARG3@ cache
@TYPE4@ FcBlanks * @ARG4@ blanks
@TYPE5@ const FcChar8 * @ARG5@ dir
-@TYPE6@ FcBool% @ARG6@ force
-@PURPOSE@ scan a font directory
+@TYPE6@ FcBool% @ARG6@ force
+@PURPOSE@ scan a font directory without caching it
@DESC@
-Scans an entire directory and adds all fonts found to
-set. If force is FcTrue, then
-the directory and all files within it are scanned even if information is
-present in the per-directory cache file or cache. Any
-subdirectories found are added to dirs. See the
-manual for FcFileScan for a description of how
-fontconfig selects which fonts to include.
+If cache is not zero or if force
+is FcFalse, this function currently returns FcFalse. Otherwise, it scans an
+entire directory and adds all fonts found to set.
+Any subdirectories found are added to dirs. Calling
+this function does not create any cache files. Use FcDirCacheRead() if
+caching is desired.
@@
@RET@ FcBool
@@ -77,10 +77,12 @@ fontconfig selects which fonts to include.
@TYPE1@ FcFontSet * @ARG1@ set
@TYPE2@ FcStrSet * @ARG2@ dirs
@TYPE3@ const FcChar8 * @ARG3@ dir
-@PURPOSE@ save a directory cache
+@PURPOSE@ DEPRECATED: formerly used to save a directory cache
@DESC@
-Creates the per-directory cache file for dir and
-populates it with the fonts in set and subdirectories
-in dirs.
+This function now does nothing aside from returning FcFalse. It used to creates the
+per-directory cache file for dir and populates it
+with the fonts in set and subdirectories in
+dirs. All of this functionality is now automatically
+managed by FcDirCacheLoad and FcDirCacheRead.
@@