diff options
| author | Keith Packard <keithp@koto.keithp.com> | 2007-11-13 14:58:39 -0800 |
|---|---|---|
| committer | Keith Packard <keithp@koto.keithp.com> | 2007-11-13 14:58:39 -0800 |
| commit | fab44f3cb63dc8bd1285dcbd6ad4f1f468f91daf (patch) | |
| tree | 1a5bd53ce2a1f863243f8030de369f0bbf842f47 /doc/fcfile.fncs | |
| parent | ed7955a58f93927eb304ecf8d4d5274dbdc2362b (diff) | |
Document several function return values (Bug 13145).
Several functions had no indication of what the return value would be,
mostly these were allocation failure returns.
Diffstat (limited to 'doc/fcfile.fncs')
| -rw-r--r-- | doc/fcfile.fncs | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/doc/fcfile.fncs b/doc/fcfile.fncs index 48213655..80d7e7f7 100644 --- a/doc/fcfile.fncs +++ b/doc/fcfile.fncs @@ -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 @@ -61,15 +62,14 @@ returns FcFalse. @TYPE4@ FcBlanks * @ARG4@ blanks @TYPE5@ const FcChar8 * @ARG5@ dir @TYPE6@ FcBool% @ARG6@ force -@PURPOSE@ scan a font directory +@PURPOSE@ DEPRECATED: formerly used to 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>. See the -manual for <function>FcFileScan</function> for a description of how -fontconfig selects which fonts to include. +This function does nothing aside from returning FcFalse. It used to scan an +entire directory and add all fonts found to +<parameter>set</parameter>. If <parameter>force</parameter> was FcTrue, then +the directory and all files within it were scanned even if information was +present in the per-directory cache file or <parameter>cache</parameter>. Any +subdirectories found were added to <parameter>dirs</parameter>. @@ @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 <parameter>dir</parameter> and -populates it with the fonts in <parameter>set</parameter> and subdirectories -in <parameter>dirs</parameter>. +This function now does nothing aside from returning FcFalse. It used to creates the +per-directory cache file for <parameter>dir</parameter> and populates it +with the fonts in <parameter>set</parameter> and subdirectories in +<parameter>dirs</parameter>. All of this functionality is now automatically +managed by FcDirCacheLoad and FcDirCacheRead. @@ |