Behdad Esfahbod
8b46a518bd
Update documentation for removal of blanks
...
Patch from Jerry Casiano.
2017-09-12 17:09:43 -04:00
Akira TAGOH
36a3ced949
Update docs
2017-09-09 22:17:16 +09:00
Akira TAGOH
12b7501bad
Add FcConfigParseAndLoadFromMemory() to load a configuration from memory.
...
https://bugs.freedesktop.org/show_bug.cgi?id=78452
2017-07-07 15:52:15 +09:00
Behdad Esfahbod
46ec6a52d4
Revert changes made to FcConfigAppFontAddDir() recently
...
In 32ac7c75e8
the behavior of
FcConfigAppFontAddFile/Dir() were changed to return false
if not fonts were found. While this is welldefined and useful
for AddFile(), it's quite problematic for AddDir(). For example,
if the directory is empty, is that a failure or success? Worse,
the false value from AddDir() was being propagated all the way
to FcInit() returning false now. This only happened upon memory
allocation failure before, and some clients assert that FcInit()
is successful.
With this change, AddDir() is reverted back to what it was.
AddFont() change (which was actually in fcdir.c) from the original
commit is left in.
2015-06-26 17:02:13 -07:00
Akira TAGOH
32ac7c75e8
Returns False if no fonts found
...
https://bugs.freedesktop.org/show_bug.cgi?id=86950
2014-12-09 19:06:46 +09:00
Akira TAGOH
f094539687
Note FcConfigSetCurrent() increases the refcount in document
2014-08-13 11:39:29 +09:00
Akira TAGOH
f8ccf379eb
Update doc to include the version info of `since when'
...
Version section was getting confused to the API's availability,
even though it was the version the doc was genereated.
So moving it into the footer and added @SINCE@ field in the data.
2014-03-07 19:42:21 +09:00
Akira TAGOH
e96d776088
Bug 59456 - Adding a --sysroot like option to fc-cache
...
Add an ability to set the system root to generate the caches.
In order to do this, new APIs, FcConfigGetSysRoot() and
FcConfigSetSysRoot() is available.
2013-03-05 18:38:50 +09:00
Akira TAGOH
06d6b7c312
Create CACHEDIR.TAG when fc-cache is run or only when the cache directory is created at the runtime.
...
Also add FcCacheCreateTagFile() API to do create CACHEDIR.TAG on the cache
directory.
2012-04-23 11:26:32 +09:00
Akira TAGOH
94c2cc58a0
doc: Fix a typo of the environment variable name.
2012-04-16 20:25:52 +09:00
Behdad Esfahbod
b5617e636c
More doc typo fixes
2011-03-14 18:23:56 -03:00
Behdad Esfahbod
5aaf466d38
Cleanup copyright notices to replace "Keith Packard" with "the author(s)"
2010-11-10 16:45:42 -05:00
Behdad Esfahbod
3074a73b41
Replace 'KEITH PACKARD' with 'THE AUTHOR(S)' in license text in all files
2009-03-13 17:59:28 -04:00
Behdad Esfahbod
3b725d0a31
[doc] Note that fontset returned by FcConfigGetFonts should not be modified
2009-02-13 16:54:05 -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
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
b21bea3731
[doc] Fix inaccuracy in FcFontRenderPrepare docs ( #16985 )
2009-02-13 16:53:54 -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
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
a190678e3c
Document previously undocumented functions. (bug 12963)
2007-11-03 22:23:28 -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
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
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
Patrick Lam
971cf18018
Add documentation for FcConfigNormalizeFontDir.
...
Write directory information to global caches to fix make check (reported by
Ronny V. Vindenes). This changes the global cache format again.
2006-01-30 04:27:53 +00:00
Keith Packard
46b51147d1
Change files from ISO-Latin-1 to UTF-8
2004-12-07 01:14:46 +00:00
Keith Packard
39381776a4
Finish reformatting developer documentation
2003-03-07 19:01:41 +00:00
Keith Packard
2df0c66230
Use <parameter> tags. Add copyrights
2003-03-07 08:51:14 +00:00
Keith Packard
bfc2dc3ac4
Add lots more function documentation
2003-03-07 08:44:32 +00:00