Commit Graph

102 Commits

Author SHA1 Message Date
Alexey Khoroshilov 6ca36812b4 Use human-readable file names in the docs (bug #16278) 2009-02-13 16:54:02 -08:00
Behdad Esfahbod 1c7f4de80c Fix two more doc typos 2009-02-13 16:54:00 -08:00
Behdad Esfahbod 8072f4b130 Document how to free return value of FcNameUnparse() 2009-02-13 16:54:00 -08:00
Behdad Esfahbod 241fbde1ab Add FcConfigReference() (#17124) 2009-02-13 16:53:59 -08:00
Behdad Esfahbod 03dcaaa08f Document when config can be NULL (#17105)
Note that this also fixes a bug with FcFontList() where previously
it was NOT checking whether the config is up-to-date.  May want to
keep the old behavior and document that ScanInterval is essentially
unused internally (FcFontSetList uses it, but we can remove that
too).
2009-02-13 16:53:59 -08:00
Behdad Esfahbod 74e16ceeea Fix docs re 'orig' argument of FcPatternBuild and family
Now call it 'p' or 'pattern', since it's modified in place.
There is no copying.
2009-02-13 16:53:57 -08:00
Behdad Esfahbod bb65f58f63 [doc] Fix signature of FcConfigHome()
We should write a test to automatically cross-check signatures
from public headers to docs.
2009-02-13 16:53:57 -08:00
Behdad Esfahbod e690fbb20e Get rid of $Id$ tags 2009-02-13 16:53:57 -08:00
Behdad Esfahbod 3042050954 [doc] Document that a zero rescanInterval disables automatic checks (#17103) 2009-02-13 16:53:57 -08:00
Behdad Esfahbod 41fc0fe68d Add FcPatternFilter() (#13016) 2009-02-13 16:53:56 -08:00
Behdad Esfahbod e6f14d3c51 [doc] Add const decorator for FcPatternDuplicate() 2009-02-13 16:53:56 -08:00
Behdad Esfahbod 77c0d8bce8 Add fc-query (#13019) 2009-02-13 16:53:56 -08:00
Behdad Esfahbod 2e08e0f243 [doc] Fix signatures of FcPatternGetFTFace and FcPatternGetLangSet (#16272) 2009-02-13 16:53:55 -08:00
Behdad Esfahbod b21bea3731 [doc] Fix inaccuracy in FcFontRenderPrepare docs (#16985) 2009-02-13 16:53:54 -08:00
Benjamin Close f7364e6273 Remove build manpage logfile if it exists 2009-02-12 10:23:40 +10:30
Alexey Khoroshilov 0faca4ff82 Fix FcStrDirname documentation. (bug 16068)
Description of FcStrDirname is absent in the official documentation of
fontconfig-2.5.92. At the same time the source documentation contains
description of the function.

The problem is a consequence of a misprint in the format of the source
documentation file 'fcstring.fncs'. The finish mark of description of the
previous function is absent.
2008-05-24 15:44:18 -07:00
Sylvain Pasche 53aec11107 Fontconfig options for freetype sub-pixel filter configuration
David Turner has modified FreeType to be able to render sub-pixel decimated
glyphs using different methods of filtering. Fontconfig needs new
configurables to support selecting these new filtering options. A patch
follows that would correspond to one available for Cairo in bug 10301.
2008-05-03 19:33:45 -07:00
Keith Packard 1315db01b6 Revert "Remove fcprivate.h, move the remaining macros to fcint.h."
This reverts commit b607922909.

Conflicts:

	src/Makefile.am

Xft still uses the macros that are in fcprivate.h. Document those macros and
include fcprivate.h in the published header files.
2007-11-13 15:48:30 -08:00
Keith Packard eaf4470a46 Document that FcConfigGetFonts returns the internal fontset (bug 13197)
FcConfigGetFonts returns the internal font set used by the library which
must not be freed by the application or 'bad things' will happen.
2007-11-13 15:16:58 -08:00
Keith Packard 3fb38716ae Document that Match calls FcFontRenderPrepare (bug 13162).
The behaviour of FcFontMatch and FcFontSetMatch is hard to understand without
knowing that they call FcFontRenderPrepare.
2007-11-13 15:11:35 -08:00
Keith Packard fab44f3cb6 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.
2007-11-13 14:58:39 -08:00
Keith Packard ed7955a58f Fix parallel build in doc directory.
docbook2man has fixed output file names; place output in a subdirectory to
avoid collisions.
2007-11-05 16:08:55 -08:00
Behdad Esfahbod cf223cc7bc Add FcGetLangs() and FcLangGetCharSet(). 2007-11-05 15:29:44 -05:00
Behdad Esfahbod 811995b79d Fix trivial bugs in edit-sgml.c 2007-11-05 15:29:03 -05:00
Keith Packard dc7b6f1d79 Link new function documentation into the fontconfig-devel.sgml 2007-11-03 23:42:32 -07:00
Keith Packard dac27f2f1a Formatting syntax mistake in doc/fclangset.fncs.
<parameter>ls</function> needed to be <parameter>ls</parameter>.
2007-11-03 23:41:38 -07:00
Keith Packard 9bfb41ffef Generate fccache.sgml, fcdircache.sgml and fclangset.sgml.
Just adding the .fncs versions doesn't get these files generated.
2007-11-03 23:23:55 -07:00
Keith Packard bfdc0047c6 Fix formatting syntax in doc/fccache.fncs 2007-11-03 23:23:09 -07:00
Keith Packard f2772d6b45 Replace incorrect documentation uses of 'char' with 'FcChar8' (bug 13002). 2007-11-03 23:03:11 -07:00
Keith Packard b4a3e83412 Remove references to FcConfigParse and FcConfigLoad.
These functions no longer exist.
2007-11-03 22:53:12 -07:00
Keith Packard 7c6939793b Update documentation for stale FcConfigGetConfig function.
The old per-user cache filename is no longer used.
2007-11-03 22:39:54 -07:00
Keith Packard 026fe895e4 Update documentation for FcStrCopyFilename (bug 12964).
FcStrCopyFilename constructs a canonical path for any argument, including
expanding leading ~ and editing '.' and '..' elements out of the resulting
path.
2007-11-03 22:31:16 -07:00
Keith Packard a190678e3c Document previously undocumented functions. (bug 12963) 2007-11-03 22:23:28 -07:00
Keith Packard 9a54f8a194 Verify documentation covers exposed symbols.
Add check-missing-doc script to make sure the documentation matches the
complete list of symbols exported from the header files before release.
2007-11-03 22:01:33 -07:00
Keith Packard b868a14473 Track line numbers in sgml edit tool input.
Errors in the documentation can be hard to find unless the tool outputs the
line number where the problem exists.
2007-11-03 21:55:39 -07:00
Keith Packard 2ddce88cde Document skipping of fonts from FcFileScan/FcDirScan.
FcFileScan and FcDirScan will skip fonts under direction of the
configuration and default fontconfig policy.
2007-11-03 13:44:59 -07:00
Keith Packard 5d82c4c85d Correct documentation for FcConfigUptoDate (bug 12948).
FcConfigUptoDate only checks whether files have been modified since the
configuration was created. Any changes to the configuration through the API
since then are not considered.
2007-11-03 13:26:16 -07:00
Keith Packard 910db318ae Correct documentation for FcAtomicLock (Bug 12947).
FcAtomicLock can only be called once from any process.
2007-11-03 13:05:25 -07:00
Keith Packard 89d6119c02 A few fixups for make distcheck 2007-10-25 15:19:14 -07:00
Keith Packard 28a4ea7f71 Fix parallel build in fontconfig/docs (bug 10481). 2007-10-25 01:09:11 -07:00
Keith Packard 61139cf638 Spelling errors in documentation. (bug 10879).
Thanks to David <ssdk@ispras.ru> for spotting these.
2007-10-25 00:49:19 -07:00
Keith Packard 26437d4924 FcConfigParseAndLoad doc was missing the last param.
Typo lost the last param to this function.
2007-10-18 08:56:42 -07:00
Keith Packard 61895ed16c Add space between type and formal in devel man pages (bug 8935)
Most parameters are pointers and have '*' in the type; for those
which do not, use '%' to mark where a space needs to be inserted.
2006-12-02 15:06:13 -08:00
Peter Breitenlohner b1aa20098f Use <literal> instead of <sgmltag> when documenting fonts.conf. Bug 8935. 2006-12-02 14:28:03 -08:00
Peter Breitenlohner 2cae0512cd A VPATH build of fontconfig-2.4.1 fails for various reasons. Bug 8933.
VPATH builds without doctools breaks as it cannot find the distributed
pre-formatted documentation.
2006-12-02 14:18:11 -08:00
Keith Packard 72ffe6536a Add FcFreeTypeQueryFace external API. Bug #7311.
Expose ability to build an FcPattern directly from an FT_Face
object.
2006-12-02 13:22:27 -08:00
Keith Packard 6262fefe54 Remove documentation for non-existant FcConfigNormalizeFontDir.
FcConfigNormalizeFontDir was present in some of the 2.3.9x release but not
in the final 2.4 release. However, the documentation persisted.
2006-09-17 13:50:31 -07:00
Keith Packard 34227592c2 Remove all .cvsignore files 2006-09-03 16:27:09 -07:00
Keith Packard c2c6976d1a Add FcMatchScan to resolve Delicious font matching issues (bug #6769)
The Delicious family includes one named Delicious Heavy, a bold variant
which is unfortunately marked as having normal weight. Because the family
name is 'Delicious', fontconfig accidentally selects this font instead of
the normal weight variant. The fix here rewrites the scanned data by running
the scanned pattern through a new substitution sequence tagged with
<match target=scan>; a sample for the Delicious family is included to
demonstrate how it works (and fix Delicious at the same time).

Also added was a new match predicate -- the 'decorative' predicate which is
automatically detected in fonts by searching style names for key decorative
phrases like SmallCaps, Shadow, Embosed and Antiqua. Suggestions for
additional decorative key words are welcome. This should have little effect
on font matching except when two fonts share the same characteristics except
for this value.
2006-09-02 17:52:12 -07:00
Keith Packard 5cafbd4da0 Document FC_DEBUG values (bug 6393). Document name \ escape syntax.
Limited FC_DEBUG documentation (just shows values and vague idea of what
they're related to). Also document \ escape syntax for font names, including
how family name and values have different escape requirements.
2006-09-01 22:04:52 -07:00