From 27a21ccef06b92c0f5cf120f7fdc29cdec259e1b Mon Sep 17 00:00:00 2001 From: Akira TAGOH Date: Tue, 13 Dec 2022 16:05:41 +0900 Subject: Convert tabs to spaces This fixes broken layout on pdf. Fixes https://gitlab.freedesktop.org/fontconfig/fontconfig/-/issues/343 --- doc/fcatomic.fncs | 18 +- doc/fcblanks.fncs | 36 +-- doc/fccache.fncs | 88 ++++---- doc/fccharset.fncs | 212 +++++++++--------- doc/fcconfig.fncs | 234 ++++++++++---------- doc/fcconstant.fncs | 38 ++-- doc/fcdircache.fncs | 72 +++--- doc/fcfile.fncs | 56 ++--- doc/fcfontset.fncs | 96 ++++---- doc/fcformat.fncs | 12 +- doc/fcfreetype.fncs | 84 +++---- doc/fcinit.fncs | 56 ++--- doc/fclangset.fncs | 166 +++++++------- doc/fcmatrix.fncs | 94 ++++---- doc/fcobjectset.fncs | 54 ++--- doc/fcobjecttype.fncs | 28 +-- doc/fcpattern.fncs | 544 +++++++++++++++++++++++----------------------- doc/fcrange.fncs | 58 ++--- doc/fcstring.fncs | 202 ++++++++--------- doc/fcstrset.fncs | 100 ++++----- doc/fcvalue.fncs | 34 +-- doc/fcweight.fncs | 40 ++-- doc/fontconfig-devel.sgml | 60 ++--- doc/fontconfig-user.sgml | 196 ++++++++--------- doc/func.sgml | 72 +++--- 25 files changed, 1325 insertions(+), 1325 deletions(-) diff --git a/doc/fcatomic.fncs b/doc/fcatomic.fncs index 017756a..0687d70 100644 --- a/doc/fcatomic.fncs +++ b/doc/fcatomic.fncs @@ -24,8 +24,8 @@ @RET@ FcAtomic * @FUNC@ FcAtomicCreate -@TYPE1@ const FcChar8 * @ARG1@ file -@PURPOSE@ create an FcAtomic object +@TYPE1@ const FcChar8 * @ARG1@ file +@PURPOSE@ create an FcAtomic object @DESC@ Creates a data structure containing data needed to control access to file. Writing is done to a separate file. Once that file is complete, the original @@ -36,7 +36,7 @@ a consistent and complete file without the need to lock for reading. @RET@ FcBool @FUNC@ FcAtomicLock @TYPE1@ FcAtomic * @ARG1@ atomic -@PURPOSE@ lock a file +@PURPOSE@ lock a file @DESC@ Attempts to lock the file referenced by atomic. Returns FcFalse if the file is already locked, else returns FcTrue and @@ -46,7 +46,7 @@ leaves the file locked. @RET@ FcChar8 * @FUNC@ FcAtomicNewFile @TYPE1@ FcAtomic * @ARG1@ atomic -@PURPOSE@ return new temporary file name +@PURPOSE@ return new temporary file name @DESC@ Returns the filename for writing a new version of the file referenced by atomic. @@ -55,7 +55,7 @@ by atomic. @RET@ FcChar8 * @FUNC@ FcAtomicOrigFile @TYPE1@ FcAtomic * @ARG1@ atomic -@PURPOSE@ return original file name +@PURPOSE@ return original file name @DESC@ Returns the file referenced by atomic. @@ @@ -63,7 +63,7 @@ Returns the file referenced by atomic. @RET@ FcBool @FUNC@ FcAtomicReplaceOrig @TYPE1@ FcAtomic * @ARG1@ atomic -@PURPOSE@ replace original with new +@PURPOSE@ replace original with new @DESC@ Replaces the original file referenced by atomic with the new file. Returns FcFalse if the file cannot be replaced due to @@ -73,7 +73,7 @@ permission issues in the filesystem. Otherwise returns FcTrue. @RET@ void @FUNC@ FcAtomicDeleteNew @TYPE1@ FcAtomic * @ARG1@ atomic -@PURPOSE@ delete new file +@PURPOSE@ delete new file @DESC@ Deletes the new file. Used in error recovery to back out changes. @@ @@ -81,7 +81,7 @@ Deletes the new file. Used in error recovery to back out changes. @RET@ void @FUNC@ FcAtomicUnlock @TYPE1@ FcAtomic * @ARG1@ atomic -@PURPOSE@ unlock a file +@PURPOSE@ unlock a file @DESC@ Unlocks the file. @@ @@ -89,7 +89,7 @@ Unlocks the file. @RET@ void @FUNC@ FcAtomicDestroy @TYPE1@ FcAtomic * @ARG1@ atomic -@PURPOSE@ destroy an FcAtomic object +@PURPOSE@ destroy an FcAtomic object @DESC@ Destroys atomic. @@ diff --git a/doc/fcblanks.fncs b/doc/fcblanks.fncs index 776ed70..375235a 100644 --- a/doc/fcblanks.fncs +++ b/doc/fcblanks.fncs @@ -21,39 +21,39 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ FcBlanks * -@FUNC@ FcBlanksCreate -@TYPE1@ void -@PURPOSE@ Create an FcBlanks +@RET@ FcBlanks * +@FUNC@ FcBlanksCreate +@TYPE1@ void +@PURPOSE@ Create an FcBlanks @DESC@ FcBlanks is deprecated. This function always returns NULL. @@ -@RET@ void -@FUNC@ FcBlanksDestroy -@TYPE1@ FcBlanks * @ARG1@ b -@PURPOSE@ Destroy and FcBlanks +@RET@ void +@FUNC@ FcBlanksDestroy +@TYPE1@ FcBlanks * @ARG1@ b +@PURPOSE@ Destroy and FcBlanks @DESC@ FcBlanks is deprecated. This function does nothing. @@ -@RET@ FcBool -@FUNC@ FcBlanksAdd -@TYPE1@ FcBlanks * @ARG1@ b -@TYPE2@ FcChar32% @ARG2@ ucs4 -@PURPOSE@ Add a character to an FcBlanks +@RET@ FcBool +@FUNC@ FcBlanksAdd +@TYPE1@ FcBlanks * @ARG1@ b +@TYPE2@ FcChar32% @ARG2@ ucs4 +@PURPOSE@ Add a character to an FcBlanks @DESC@ FcBlanks is deprecated. This function always returns FALSE. @@ -@RET@ FcBool -@FUNC@ FcBlanksIsMember -@TYPE1@ FcBlanks * @ARG1@ b -@TYPE2@ FcChar32% @ARG2@ ucs4 -@PURPOSE@ Query membership in an FcBlanks +@RET@ FcBool +@FUNC@ FcBlanksIsMember +@TYPE1@ FcBlanks * @ARG1@ b +@TYPE2@ FcChar32% @ARG2@ ucs4 +@PURPOSE@ Query membership in an FcBlanks @DESC@ FcBlanks is deprecated. This function always returns FALSE. diff --git a/doc/fccache.fncs b/doc/fccache.fncs index cf79134..7074b0f 100644 --- a/doc/fccache.fncs +++ b/doc/fccache.fncs @@ -19,30 +19,30 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ - + @RET@ const FcChar8 * @FUNC@ FcCacheDir -@TYPE1@ const FcCache * @ARG1@ cache -@PURPOSE@ Return directory of cache +@TYPE1@ const FcCache * @ARG1@ cache +@PURPOSE@ Return directory of cache @DESC@ This function returns the directory from which the cache was constructed. @@ -@RET@ FcFontSet * -@FUNC@ FcCacheCopySet -@TYPE1@ const FcCache * @ARG1@ cache -@PURPOSE@ Returns a copy of the fontset from cache +@RET@ FcFontSet * +@FUNC@ FcCacheCopySet +@TYPE1@ const FcCache * @ARG1@ cache +@PURPOSE@ Returns a copy of the fontset from cache @DESC@ The returned fontset contains each of the font patterns from cache. This fontset may be modified, but the patterns from the cache are read-only. @@ -@RET@ const FcChar8 * -@FUNC@ FcCacheSubdir -@TYPE1@ const FcCache * @ARG1@ cache -@TYPE2@ int @ARG2@ i -@PURPOSE@ Return the i'th subdirectory. +@RET@ const FcChar8 * +@FUNC@ FcCacheSubdir +@TYPE1@ const FcCache * @ARG1@ cache +@TYPE2@ int @ARG2@ i +@PURPOSE@ Return the i'th subdirectory. @DESC@ The set of subdirectories stored in a cache file are indexed by this function, i should range from 0 to @@ -50,62 +50,62 @@ function, i should range from 0 to value from FcCacheNumSubdir. @@ -@RET@ int -@FUNC@ FcCacheNumSubdir -@TYPE1@ const FcCache * @ARG1@ cache -@PURPOSE@ Return the number of subdirectories in cache. +@RET@ int +@FUNC@ FcCacheNumSubdir +@TYPE1@ const FcCache * @ARG1@ cache +@PURPOSE@ Return the number of subdirectories in cache. @DESC@ This returns the total number of subdirectories in the cache. @@ -@RET@ int -@FUNC@ FcCacheNumFont -@TYPE1@ const FcCache * @ARG1@ cache -@PURPOSE@ Returns the number of fonts in cache. +@RET@ int +@FUNC@ FcCacheNumFont +@TYPE1@ const FcCache * @ARG1@ cache +@PURPOSE@ Returns the number of fonts in cache. @DESC@ This returns the number of fonts which would be included in the return from FcCacheCopySet. @@ -@RET@ FcBool -@FUNC@ FcDirCacheClean -@TYPE1@ const FcChar8 * @ARG1@ cache_dir -@TYPE2@ FcBool @ARG2@ verbose -@PURPOSE@ Clean up a cache directory +@RET@ FcBool +@FUNC@ FcDirCacheClean +@TYPE1@ const FcChar8 * @ARG1@ cache_dir +@TYPE2@ FcBool @ARG2@ verbose +@PURPOSE@ Clean up a cache directory @DESC@ This tries to clean up the cache directory of cache_dir. This returns FcTrue if the operation is successfully complete. otherwise FcFalse. -@SINCE@ 2.9.91 +@SINCE@ 2.9.91 @@ -@RET@ void -@FUNC@ FcCacheCreateTagFile -@TYPE1@ const FcConfig * @ARG1@ config -@PURPOSE@ Create CACHEDIR.TAG at cache directory. +@RET@ void +@FUNC@ FcCacheCreateTagFile +@TYPE1@ const FcConfig * @ARG1@ config +@PURPOSE@ Create CACHEDIR.TAG at cache directory. @DESC@ This tries to create CACHEDIR.TAG file at the cache directory registered to config. -@SINCE@ 2.9.91 +@SINCE@ 2.9.91 @@ -@RET@ FcBool -@FUNC@ FcDirCacheCreateUUID -@TYPE1@ FcChar8 * @ARG1@ dir -@TYPE2@ FcBool @ARG2@ force -@TYPE3@ FcConfig * @ARG3@ config -@PURPOSE@ Create .uuid file at a directory +@RET@ FcBool +@FUNC@ FcDirCacheCreateUUID +@TYPE1@ FcChar8 * @ARG1@ dir +@TYPE2@ FcBool @ARG2@ force +@TYPE3@ FcConfig * @ARG3@ config +@PURPOSE@ Create .uuid file at a directory @DESC@ This function is deprecated. it doesn't take any effects. -@SINCE@ 2.12.92 +@SINCE@ 2.12.92 @@ -@RET@ FcBool -@FUNC@ FcDirCacheDeleteUUID -@TYPE1@ const FcChar8 * @ARG1@ dir -@TYPE2@ FcConfig * @ARG2@ config -@PURPOSE@ Delete .uuid file +@RET@ FcBool +@FUNC@ FcDirCacheDeleteUUID +@TYPE1@ const FcChar8 * @ARG1@ dir +@TYPE2@ FcConfig * @ARG2@ config +@PURPOSE@ Delete .uuid file @DESC@ This is to delete .uuid file containing an UUID at a font directory of dir. -@SINCE@ 2.13.1 +@SINCE@ 2.13.1 @@ diff --git a/doc/fccharset.fncs b/doc/fccharset.fncs index ee35555..da40848 100644 --- a/doc/fccharset.fncs +++ b/doc/fccharset.fncs @@ -21,101 +21,101 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ FcCharSet * -@FUNC@ FcCharSetCreate -@TYPE1@ void -@PURPOSE@ Create an empty character set +@RET@ FcCharSet * +@FUNC@ FcCharSetCreate +@TYPE1@ void +@PURPOSE@ Create an empty character set @DESC@ FcCharSetCreate allocates and initializes a new empty character set object. @@ -@RET@ void -@FUNC@ FcCharSetDestroy -@TYPE1@ FcCharSet * @ARG1@ fcs -@PURPOSE@ Destroy a character set +@RET@ void +@FUNC@ FcCharSetDestroy +@TYPE1@ FcCharSet * @ARG1@ fcs +@PURPOSE@ Destroy a character set @DESC@ -FcCharSetDestroy decrements the reference count +FcCharSetDestroy decrements the reference count fcs. If the reference count becomes zero, all memory referenced is freed. @@ -@RET@ FcBool -@FUNC@ FcCharSetAddChar -@TYPE1@ FcCharSet * @ARG1@ fcs -@TYPE2@ FcChar32% @ARG2@ ucs4 -@PURPOSE@ Add a character to a charset +@RET@ FcBool +@FUNC@ FcCharSetAddChar +@TYPE1@ FcCharSet * @ARG1@ fcs +@TYPE2@ FcChar32% @ARG2@ ucs4 +@PURPOSE@ Add a character to a charset @DESC@ FcCharSetAddChar adds a single Unicode char to the set, returning FcFalse on failure, either as a result of a constant set or from -running out of memory. +running out of memory. @@ -@RET@ FcBool -@FUNC@ FcCharSetDelChar -@TYPE1@ FcCharSet * @ARG1@ fcs -@TYPE2@ FcChar32% @ARG2@ ucs4 -@PURPOSE@ Add a character to a charset +@RET@ FcBool +@FUNC@ FcCharSetDelChar +@TYPE1@ FcCharSet * @ARG1@ fcs +@TYPE2@ FcChar32% @ARG2@ ucs4 +@PURPOSE@ Add a character to a charset @DESC@ FcCharSetDelChar deletes a single Unicode char from the set, returning FcFalse on failure, either as a result of a constant set or from running out of memory. -@SINCE@ 2.9.0 +@SINCE@ 2.9.0 @@ -@RET@ FcCharSet * -@FUNC@ FcCharSetCopy -@TYPE1@ FcCharSet * @ARG1@ src -@PURPOSE@ Copy a charset +@RET@ FcCharSet * +@FUNC@ FcCharSetCopy +@TYPE1@ FcCharSet * @ARG1@ src +@PURPOSE@ Copy a charset @DESC@ Makes a copy of src; note that this may not actually do anything more -than increment the reference count on src. +than increment the reference count on src. @@ -@RET@ FcBool -@FUNC@ FcCharSetEqual -@TYPE1@ const FcCharSet * @ARG1@ a -@TYPE2@ const FcCharSet * @ARG2@ b -@PURPOSE@ Compare two charsets +@RET@ FcBool +@FUNC@ FcCharSetEqual +@TYPE1@ const FcCharSet * @ARG1@ a +@TYPE2@ const FcCharSet * @ARG2@ b +@PURPOSE@ Compare two charsets @DESC@ Returns whether a and b contain the same set of Unicode chars. @@ -@RET@ FcCharSet * -@FUNC@ FcCharSetIntersect -@TYPE1@ const FcCharSet * @ARG1@ a -@TYPE2@ const FcCharSet * @ARG2@ b -@PURPOSE@ Intersect charsets +@RET@ FcCharSet * +@FUNC@ FcCharSetIntersect +@TYPE1@ const FcCharSet * @ARG1@ a +@TYPE2@ const FcCharSet * @ARG2@ b +@PURPOSE@ Intersect charsets @DESC@ Returns a set including only those chars found in both -a and b. +a and b. @@ -@RET@ FcCharSet * -@FUNC@ FcCharSetUnion -@TYPE1@ const FcCharSet * @ARG1@ a -@TYPE2@ const FcCharSet * @ARG2@ b -@PURPOSE@ Add charsets +@RET@ FcCharSet * +@FUNC@ FcCharSetUnion +@TYPE1@ const FcCharSet * @ARG1@ a +@TYPE2@ const FcCharSet * @ARG2@ b +@PURPOSE@ Add charsets @DESC@ -Returns a set including only those chars found in either a or b. +Returns a set including only those chars found in either a or b. @@ -@RET@ FcCharSet * -@FUNC@ FcCharSetSubtract -@TYPE1@ const FcCharSet * @ARG1@ a -@TYPE2@ const FcCharSet * @ARG2@ b -@PURPOSE@ Subtract charsets +@RET@ FcCharSet * +@FUNC@ FcCharSetSubtract +@TYPE1@ const FcCharSet * @ARG1@ a +@TYPE2@ const FcCharSet * @ARG2@ b +@PURPOSE@ Subtract charsets @DESC@ -Returns a set including only those chars found in a but not b. +Returns a set including only those chars found in a but not b. @@ -@RET@ FcBool -@FUNC@ FcCharSetMerge -@TYPE1@ FcCharSet * @ARG1@ a -@TYPE2@ const FcCharSet * @ARG2@ b -@TYPE3@ FcBool * @ARG3@ changed -@PURPOSE@ Merge charsets +@RET@ FcBool +@FUNC@ FcCharSetMerge +@TYPE1@ FcCharSet * @ARG1@ a +@TYPE2@ const FcCharSet * @ARG2@ b +@TYPE3@ FcBool * @ARG3@ changed +@PURPOSE@ Merge charsets @DESC@ Adds all chars in b to a. In other words, this is an in-place version of FcCharSetUnion. @@ -125,56 +125,56 @@ Returns FcFalse on failure, either when a is a constant set or from running out of memory. @@ -@RET@ FcBool -@FUNC@ FcCharSetHasChar -@TYPE1@ const FcCharSet * @ARG1@ fcs -@TYPE2@ FcChar32% @ARG2@ ucs4 -@PURPOSE@ Check a charset for a char +@RET@ FcBool +@FUNC@ FcCharSetHasChar +@TYPE1@ const FcCharSet * @ARG1@ fcs +@TYPE2@ FcChar32% @ARG2@ ucs4 +@PURPOSE@ Check a charset for a char @DESC@ -Returns whether fcs contains the char ucs4. +Returns whether fcs contains the char ucs4. @@ -@RET@ FcChar32 -@FUNC@ FcCharSetCount -@TYPE1@ const FcCharSet * @ARG1@ a -@PURPOSE@ Count entries in a charset +@RET@ FcChar32 +@FUNC@ FcCharSetCount +@TYPE1@ const FcCharSet * @ARG1@ a +@PURPOSE@ Count entries in a charset @DESC@ -Returns the total number of Unicode chars in a. +Returns the total number of Unicode chars in a. @@ -@RET@ FcChar32 -@FUNC@ FcCharSetIntersectCount -@TYPE1@ const FcCharSet * @ARG1@ a -@TYPE2@ const FcCharSet * @ARG2@ b -@PURPOSE@ Intersect and count charsets +@RET@ FcChar32 +@FUNC@ FcCharSetIntersectCount +@TYPE1@ const FcCharSet * @ARG1@ a +@TYPE2@ const FcCharSet * @ARG2@ b +@PURPOSE@ Intersect and count charsets @DESC@ -Returns the number of chars that are in both a and b. +Returns the number of chars that are in both a and b. @@ -@RET@ FcChar32 -@FUNC@ FcCharSetSubtractCount -@TYPE1@ const FcCharSet * @ARG1@ a -@TYPE2@ const FcCharSet * @ARG2@ b -@PURPOSE@ Subtract and count charsets +@RET@ FcChar32 +@FUNC@ FcCharSetSubtractCount +@TYPE1@ const FcCharSet * @ARG1@ a +@TYPE2@ const FcCharSet * @ARG2@ b +@PURPOSE@ Subtract and count charsets @DESC@ -Returns the number of chars that are in a but not in b. +Returns the number of chars that are in a but not in b. @@ -@RET@ FcBool -@FUNC@ FcCharSetIsSubset -@TYPE1@ const FcCharSet * @ARG1@ a -@TYPE2@ const FcCharSet * @ARG2@ b -@PURPOSE@ Test for charset inclusion +@RET@ FcBool +@FUNC@ FcCharSetIsSubset +@TYPE1@ const FcCharSet * @ARG1@ a +@TYPE2@ const FcCharSet * @ARG2@ b +@PURPOSE@ Test for charset inclusion @DESC@ -Returns whether a is a subset of b. +Returns whether a is a subset of b. @@ -@RET@ FcChar32 -@FUNC@ FcCharSetFirstPage -@TYPE1@ const FcCharSet * @ARG1@ a -@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE]% @ARG2@ map -@TYPE3@ FcChar32 * @ARG3@ next -@PURPOSE@ Start enumerating charset contents +@RET@ FcChar32 +@FUNC@ FcCharSetFirstPage +@TYPE1@ const FcCharSet * @ARG1@ a +@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE]% @ARG2@ map +@TYPE3@ FcChar32 * @ARG3@ next +@PURPOSE@ Start enumerating charset contents @DESC@ Builds an array of bits in map marking the first page of Unicode coverage of a. @@ -199,12 +199,12 @@ the 4th and 31st bits set. The code points represented by reader ;). @@ -@RET@ FcChar32 -@FUNC@ FcCharSetNextPage -@TYPE1@ const FcCharSet * @ARG1@ a -@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE]% @ARG2@ map -@TYPE3@ FcChar32 * @ARG3@ next -@PURPOSE@ Continue enumerating charset contents +@RET@ FcChar32 +@FUNC@ FcCharSetNextPage +@TYPE1@ const FcCharSet * @ARG1@ a +@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE]% @ARG2@ map +@TYPE3@ FcChar32 * @ARG3@ next +@PURPOSE@ Continue enumerating charset contents @DESC@ Builds an array of bits in map marking the Unicode coverage of a for page containing @@ -217,12 +217,12 @@ code point for the page, or FC_CHARSET_DONE if *next. @@ -@RET@ FcChar32 -@FUNC@ FcCharSetCoverage -@TYPE1@ const FcCharSet * @ARG1@ a -@TYPE2@ FcChar32 @ARG2@ page -@TYPE3@ FcChar32[8] @ARG3@ result -@PURPOSE@ DEPRECATED return coverage for a Unicode page +@RET@ FcChar32 +@FUNC@ FcCharSetCoverage +@TYPE1@ const FcCharSet * @ARG1@ a +@TYPE2@ FcChar32 @ARG2@ page +@TYPE3@ FcChar32[8] @ARG3@ result +@PURPOSE@ DEPRECATED return coverage for a Unicode page @DESC@ DEPRECATED This function returns a bitmask in result which @@ -232,10 +232,10 @@ indicates which code points in coverage. @@ -@RET@ FcCharSet * -@FUNC@ FcCharSetNew -@TYPE1@ void -@PURPOSE@ DEPRECATED alias for FcCharSetCreate +@RET@ FcCharSet * +@FUNC@ FcCharSetNew +@TYPE1@ void +@PURPOSE@ DEPRECATED alias for FcCharSetCreate @DESC@ FcCharSetNew is a DEPRECATED alias for FcCharSetCreate. @@ diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs index c1e2622..d8f0674 100644 --- a/doc/fcconfig.fncs +++ b/doc/fcconfig.fncs @@ -23,8 +23,8 @@ */ @RET@ FcConfig * @FUNC@ FcConfigCreate -@TYPE1@ void -@PURPOSE@ Create a configuration +@TYPE1@ void +@PURPOSE@ Create a configuration @DESC@ Creates an empty configuration. @@ @@ -32,7 +32,7 @@ Creates an empty configuration. @RET@ FcConfig * @FUNC@ FcConfigReference @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ Increment config reference count +@PURPOSE@ Increment config reference count @DESC@ Add another reference to config. Configs are freed only when the reference count reaches zero. @@ -45,7 +45,7 @@ for destroying the configuration when not needed anymore. @RET@ void @FUNC@ FcConfigDestroy @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ Destroy a configuration +@PURPOSE@ Destroy a configuration @DESC@ Decrements the config reference count. If all references are gone, destroys the configuration and any data associated with it. @@ -56,7 +56,7 @@ cause a new configuration to be created for use as current configuration. @RET@ FcBool @FUNC@ FcConfigSetCurrent @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ Set configuration as default +@PURPOSE@ Set configuration as default @DESC@ Sets the current default configuration to config. Implicitly calls FcConfigBuildFonts if necessary, and FcConfigReference() to inrease the reference count @@ -65,8 +65,8 @@ in config since 2.12.0, returning FcFalse if that call fa @RET@ FcConfig * @FUNC@ FcConfigGetCurrent -@TYPE1@ void -@PURPOSE@ Return current configuration +@TYPE1@ void +@PURPOSE@ Return current configuration @DESC@ Returns the current default configuration. @@ @@ -74,27 +74,27 @@ Returns the current default configuration. @RET@ FcBool @FUNC@ FcConfigUptoDate @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ Check timestamps on config files +@PURPOSE@ Check timestamps on config files @DESC@ Checks all of the files related to config and returns whether any of them has been modified since the configuration was created. If config is NULL, the current configuration is used. @@ -@RET@ FcChar8 * -@FUNC@ FcConfigHome -@TYPE1@ void -@PURPOSE@ return the current home directory. +@RET@ FcChar8 * +@FUNC@ FcConfigHome +@TYPE1@ void +@PURPOSE@ return the current home directory. @DESC@ Return the current user's home directory, if it is available, and if using it is enabled, and NULL otherwise. See also FcConfigEnableHome). @@ -@RET@ FcBool -@FUNC@ FcConfigEnableHome -@TYPE1@ FcBool% @ARG1@ enable -@PURPOSE@ controls use of the home directory. +@RET@ FcBool +@FUNC@ FcConfigEnableHome +@TYPE1@ FcBool% @ARG1@ enable +@PURPOSE@ controls use of the home directory. @DESC@ If enable is FcTrue, then Fontconfig will use various files which are specified relative to the user's home directory (using the ~ @@ -106,7 +106,7 @@ disabled. The previous setting of the value is returned. @RET@ FcBool @FUNC@ FcConfigBuildFonts @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ Build font database +@PURPOSE@ Build font database @DESC@ Builds the set of available fonts for the given configuration. Note that any changes to the configuration after this call have indeterminate effects. @@ -117,7 +117,7 @@ If config is NULL, the current configuration is used. @RET@ FcStrList * @FUNC@ FcConfigGetConfigDirs @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ Get config directories +@PURPOSE@ Get config directories @DESC@ Returns the list of font directories specified in the configuration files for config. Does not include any subdirectories. @@ -127,7 +127,7 @@ If config is NULL, the current configuration is used. @RET@ FcStrList * @FUNC@ FcConfigGetFontDirs @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ Get font directories +@PURPOSE@ Get font directories @DESC@ Returns the list of font directories in config. This includes the configured font directories along with any directories below those in the @@ -138,7 +138,7 @@ If config is NULL, the current configuration is used. @RET@ FcStrList * @FUNC@ FcConfigGetConfigFiles @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ Get config files +@PURPOSE@ Get config files @DESC@ Returns the list of known configuration files used to generate config. If config is NULL, the current configuration is used. @@ -147,16 +147,16 @@ If config is NULL, the current configuration is used. @RET@ FcChar8 * @FUNC@ FcConfigGetCache @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ DEPRECATED used to return per-user cache filename +@PURPOSE@ DEPRECATED used to return per-user cache filename @DESC@ With fontconfig no longer using per-user cache files, this function now simply returns NULL to indicate that no per-user file exists. @@ -@RET@ FcStrList * -@FUNC@ FcConfigGetCacheDirs -@TYPE1@ const FcConfig * @ARG1@ config -@PURPOSE@ return the list of directories searched for cache files +@RET@ FcStrList * +@FUNC@ FcConfigGetCacheDirs +@TYPE1@ const FcConfig * @ARG1@ config +@PURPOSE@ return the list of directories searched for cache files @DESC@ FcConfigGetCacheDirs returns a string list containing all of the directories that fontconfig will search when attempting to load a @@ -166,9 +166,9 @@ If config is NULL, the current configuration is used. @RET@ FcFontSet * @FUNC@ FcConfigGetFonts -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcSetName% @ARG2@ set -@PURPOSE@ Get config font set +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcSetName% @ARG2@ set +@PURPOSE@ Get config font set @DESC@ Returns one of the two sets of fonts from the configuration as specified by set. This font set is owned by the library and must @@ -183,7 +183,7 @@ the return value is no longer referenced. @RET@ FcBlanks * @FUNC@ FcConfigGetBlanks @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ Get config blanks +@PURPOSE@ Get config blanks @DESC@ FcBlanks is deprecated. This function always returns NULL. @@ -192,7 +192,7 @@ This function always returns NULL. @RET@ int @FUNC@ FcConfigGetRescanInterval @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ Get config rescan interval +@PURPOSE@ Get config rescan interval @DESC@ Returns the interval between automatic checks of the configuration (in seconds) specified in config. The configuration is checked during @@ -203,9 +203,9 @@ If config is NULL, the current configuration is used. @RET@ FcBool @FUNC@ FcConfigSetRescanInterval -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ int% @ARG2@ rescanInterval -@PURPOSE@ Set config rescan interval +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ int% @ARG2@ rescanInterval +@PURPOSE@ Set config rescan interval @DESC@ Sets the rescan interval. Returns FcFalse if the interval cannot be set (due to allocation failure). Otherwise returns FcTrue. @@ -215,9 +215,9 @@ If config is NULL, the current configuration is used. @RET@ FcBool @FUNC@ FcConfigAppFontAddFile -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ const FcChar8 * @ARG2@ file -@PURPOSE@ Add font file to font database +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ const FcChar8 * @ARG2@ file +@PURPOSE@ Add font file to font database @DESC@ Adds an application-specific font to the configuration. Returns FcFalse if the fonts cannot be added (due to allocation failure or no fonts found). @@ -227,9 +227,9 @@ the current configuration is used. @RET@ FcBool @FUNC@ FcConfigAppFontAddDir -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ const FcChar8 * @ARG2@ dir -@PURPOSE@ Add fonts from directory to font database +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ const FcChar8 * @ARG2@ dir +@PURPOSE@ Add fonts from directory to font database @DESC@ Scans the specified directory for fonts, adding each one found to the application-specific set of fonts. Returns FcFalse @@ -241,7 +241,7 @@ the current configuration is used. @RET@ void @FUNC@ FcConfigAppFontClear @TYPE1@ FcConfig * @ARG1@ config -@PURPOSE@ Remove all app fonts from font database +@PURPOSE@ Remove all app fonts from font database @DESC@ Clears the set of application-specific fonts. If config is NULL, the current configuration is used. @@ -249,11 +249,11 @@ If config is NULL, the current configuration is used. @RET@ FcBool @FUNC@ FcConfigSubstituteWithPat -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcPattern * @ARG2@ p -@TYPE3@ FcPattern * @ARG3@ p_pat -@TYPE4@ FcMatchKind% @ARG4@ kind -@PURPOSE@ Execute substitutions +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcPattern * @ARG2@ p +@TYPE3@ FcPattern * @ARG3@ p_pat +@TYPE4@ FcMatchKind% @ARG4@ kind +@PURPOSE@ Execute substitutions @DESC@ Performs the sequence of pattern modification operations, if kind is FcMatchPattern, then those tagged as pattern operations are applied, else @@ -265,10 +265,10 @@ If config is NULL, the current configuration is used. @RET@ FcBool @FUNC@ FcConfigSubstitute -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcPattern * @ARG2@ p -@TYPE3@ FcMatchKind% @ARG3@ kind -@PURPOSE@ Execute substitutions +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcPattern * @ARG2@ p +@TYPE3@ FcMatchKind% @ARG3@ kind +@PURPOSE@ Execute substitutions @DESC@ Calls FcConfigSubstituteWithPat setting p_pat to NULL. Returns FcFalse if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue. @@ -277,10 +277,10 @@ If config is NULL, the current configuration is used. @RET@ FcPattern * @FUNC@ FcFontMatch -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcPattern * @ARG2@ p -@TYPE3@ FcResult * @ARG3@ result -@PURPOSE@ Return best font +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcPattern * @ARG2@ p +@TYPE3@ FcResult * @ARG3@ result +@PURPOSE@ Return best font @DESC@ Finds the font in sets most closely matching pattern and returns the result of @@ -294,12 +294,12 @@ If config is NULL, the current configuration is used. @RET@ FcFontSet * @FUNC@ FcFontSort -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcPattern * @ARG2@ p -@TYPE3@ FcBool% @ARG3@ trim -@TYPE4@ FcCharSet ** @ARG4@ csp -@TYPE5@ FcResult * @ARG5@ result -@PURPOSE@ Return list of matching fonts +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcPattern * @ARG2@ p +@TYPE3@ FcBool% @ARG3@ trim +@TYPE4@ FcCharSet ** @ARG4@ csp +@TYPE5@ FcResult * @ARG5@ result +@PURPOSE@ Return list of matching fonts @DESC@ Returns the list of fonts sorted by closeness to p. If trim is FcTrue, elements in the list which don't include Unicode coverage not provided by @@ -319,10 +319,10 @@ If config is NULL, the current configuration is used. @RET@ FcPattern * @FUNC@ FcFontRenderPrepare -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcPattern * @ARG2@ pat -@TYPE3@ FcPattern * @ARG3@ font -@PURPOSE@ Prepare pattern for loading font file +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcPattern * @ARG2@ pat +@TYPE3@ FcPattern * @ARG3@ font +@PURPOSE@ Prepare pattern for loading font file @DESC@ Creates a new pattern consisting of elements of font not appearing in pat, elements of pat not appearing in font and the best matching @@ -332,10 +332,10 @@ FcConfigSubstituteWithPat with kind FcMatchFont and then @RET@ FcFontSet * @FUNC@ FcFontList -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcPattern * @ARG2@ p -@TYPE3@ FcObjectSet * @ARG3@ os -@PURPOSE@ List fonts +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcPattern * @ARG2@ p +@TYPE3@ FcObjectSet * @ARG3@ os +@PURPOSE@ List fonts @DESC@ Selects fonts matching p, creates patterns from those fonts containing only the objects in os and returns the set of unique such patterns. @@ -345,17 +345,17 @@ to be up to date, and used. @RET@ FcChar8 * @FUNC@ FcConfigFilename -@TYPE1@ const FcChar8 * @ARG1@ name -@PURPOSE@ Find a config file +@TYPE1@ const FcChar8 * @ARG1@ name +@PURPOSE@ Find a config file @DESC@ This function is deprecated and is replaced by FcConfigGetFilename. @@ @RET@ FcChar8 * @FUNC@ FcConfigGetFilename -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ const FcChar8 * @ARG2@ name -@PURPOSE@ Find a config file +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ const FcChar8 * @ARG2@ name +@PURPOSE@ Find a config file @DESC@ Given the specified external entity name, return the associated filename. This provides applications a way to convert various configuration file @@ -372,12 +372,12 @@ FONTCONFIG_PATH environment variable. The result of this function is affected by the FONTCONFIG_SYSROOT environment variable or equivalent functionality. @@ -@RET@ FcBool -@FUNC@ FcConfigParseAndLoad -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ const FcChar8 * @ARG2@ file -@TYPE3@ FcBool% @ARG3@ complain -@PURPOSE@ load a configuration file +@RET@ FcBool +@FUNC@ FcConfigParseAndLoad +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ const FcChar8 * @ARG2@ file +@TYPE3@ FcBool% @ARG3@ complain +@PURPOSE@ load a configuration file @DESC@ Walks the configuration in 'file' and constructs the internal representation in 'config'. Any include files referenced from within 'file' will be loaded @@ -387,12 +387,12 @@ Returns FcFalse if some error occurred while loading the file, either a parse error, semantic error or allocation failure. Otherwise returns FcTrue. @@ -@RET@ FcBool -@FUNC@ FcConfigParseAndLoadFromMemory -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ const FcChar8 * @ARG2@ buffer -@TYPE3@ FcBool% @ARG3@ complain -@PURPOSE@ load a configuration from memory +@RET@ FcBool +@FUNC@ FcConfigParseAndLoadFromMemory +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ const FcChar8 * @ARG2@ buffer +@TYPE3@ FcBool% @ARG3@ complain +@PURPOSE@ load a configuration from memory @DESC@ Walks the configuration in 'memory' and constructs the internal representation in 'config'. Any includes files referenced from within 'memory' will be loaded @@ -400,13 +400,13 @@ and dparsed. If 'complain' is FcFalse, no warning will be displayed if 'file' does not exist. Error and warning messages will be output to stderr. Returns FcFalse if fsome error occurred while loading the file, either a parse error, semantic error or allocation failure. Otherwise returns FcTrue. -@SINCE@ 2.12.5 +@SINCE@ 2.12.5 @@ -@RET@ const FcChar8 * -@FUNC@ FcConfigGetSysRoot -@TYPE1@ const FcConfig * @ARG1@ config -@PURPOSE@ Obtain the system root directory +@RET@ const FcChar8 * +@FUNC@ FcConfigGetSysRoot +@TYPE1@ const FcConfig * @ARG1@ config +@PURPOSE@ Obtain the system root directory @DESC@ Obtains the system root directory in 'config' if available. All files (including file properties in patterns) obtained from this 'config' are @@ -415,14 +415,14 @@ relative to this system root directory. This function isn't MT-safe. FcConfigReference must be called before using this and then FcConfigDestroy when the return value is no longer referenced. -@SINCE@ 2.10.92 +@SINCE@ 2.10.92 @@ -@RET@ void -@FUNC@ FcConfigSetSysRoot -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ const FcChar8 * @ARG2@ sysroot -@PURPOSE@ Set the system root directory +@RET@ void +@FUNC@ FcConfigSetSysRoot +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ const FcChar8 * @ARG2@ sysroot +@PURPOSE@ Set the system root directory @DESC@ Set 'sysroot' as the system root directory. All file paths used or created with this 'config' (including file properties in patterns) will be considered or @@ -431,14 +431,14 @@ targets at build time. This also allows a cache to be re-targeted to a different base directory if 'FcConfigGetSysRoot' is used to resolve file paths. When setting this on the current config this causes changing current config (calls FcConfigSetCurrent()). -@SINCE@ 2.10.92 +@SINCE@ 2.10.92 @@ -@RET@ void -@FUNC@ FcConfigFileInfoIterInit -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter -@PURPOSE@ Initialize the iterator +@RET@ void +@FUNC@ FcConfigFileInfoIterInit +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter +@PURPOSE@ Initialize the iterator @DESC@ Initialize 'iter' with the first iterator in the config file information list. @@ -448,14 +448,14 @@ i.e. how fontconfig actually read them. This function isn't MT-safe. FcConfigReference must be called before using this and then FcConfigDestroy when the relevant values are no longer referenced. -@SINCE@ 2.12.91 +@SINCE@ 2.12.91 @@ -@RET@ FcBool -@FUNC@ FcConfigFileInfoIterNext -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter -@PURPOSE@ Set the iterator to point to the next list +@RET@ FcBool +@FUNC@ FcConfigFileInfoIterNext +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter +@PURPOSE@ Set the iterator to point to the next list @DESC@ Set 'iter' to point to the next node in the config file information list. If there is no next node, FcFalse is returned. @@ -463,17 +463,17 @@ If there is no next node, FcFalse is returned. This function isn't MT-safe. FcConfigReference must be called before using FcConfigFileInfoIterInit and then FcConfigDestroy when the relevant values are no longer referenced. -@SINCE@ 2.12.91 +@SINCE@ 2.12.91 @@ -@RET@ FcBool -@FUNC@ FcConfigFileInfoIterGet -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter -@TYPE3@ FcChar8 ** @ARG3@ name -@TYPE4@ FcChar8 ** @ARG4@ description -@TYPE5@ FcBool * @ARG5@ enabled -@PURPOSE@ Obtain the configuration file information +@RET@ FcBool +@FUNC@ FcConfigFileInfoIterGet +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter +@TYPE3@ FcChar8 ** @ARG3@ name +@TYPE4@ FcChar8 ** @ARG4@ description +@TYPE5@ FcBool * @ARG5@ enabled +@PURPOSE@ Obtain the configuration file information @DESC@ Obtain the filename, the description and the flag whether it is enabled or not for 'iter' where points to current configuration file information. @@ -482,5 +482,5 @@ If the iterator is invalid, FcFalse is returned. This function isn't MT-safe. FcConfigReference must be called before using FcConfigFileInfoIterInit and then FcConfigDestroy when the relevant values are no longer referenced. -@SINCE@ 2.12.91 +@SINCE@ 2.12.91 @@ diff --git a/doc/fcconstant.fncs b/doc/fcconstant.fncs index 8f4c878..81eb747 100644 --- a/doc/fcconstant.fncs +++ b/doc/fcconstant.fncs @@ -21,37 +21,37 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ FcBool -@FUNC@ FcNameRegisterConstants -@TYPE1@ const FcConstant * @ARG1@ consts -@TYPE2@ int% @ARG2@ nconsts -@PURPOSE@ Register symbolic constants +@RET@ FcBool +@FUNC@ FcNameRegisterConstants +@TYPE1@ const FcConstant * @ARG1@ consts +@TYPE2@ int% @ARG2@ nconsts +@PURPOSE@ Register symbolic constants @DESC@ Deprecated. Does nothing. Returns FcFalse. @@ -@RET@ FcBool -@FUNC@ FcNameUnregisterConstants -@TYPE1@ const FcConstant * @ARG1@ consts -@TYPE2@ int% @ARG2@ nconsts -@PURPOSE@ Unregister symbolic constants +@RET@ FcBool +@FUNC@ FcNameUnregisterConstants +@TYPE1@ const FcConstant * @ARG1@ consts +@TYPE2@ int% @ARG2@ nconsts +@PURPOSE@ Unregister symbolic constants @DESC@ Deprecated. Does nothing. Returns FcFalse. @@ -@RET@ const FcConstant * -@FUNC@ FcNameGetConstant -@TYPE1@ FcChar8 * @ARG1@ string -@PURPOSE@ Lookup symbolic constant +@RET@ const FcConstant * +@FUNC@ FcNameGetConstant +@TYPE1@ FcChar8 * @ARG1@ string +@PURPOSE@ Lookup symbolic constant @DESC@ Return the FcConstant structure related to symbolic constant string. @@ -@RET@ FcBool -@FUNC@ FcNameConstant -@TYPE1@ FcChar8 * @ARG1@ string -@TYPE2@ int * @ARG2@ result -@PURPOSE@ Get the value for a symbolic constant +@RET@ FcBool +@FUNC@ FcNameConstant +@TYPE1@ FcChar8 * @ARG1@ string +@TYPE2@ int * @ARG2@ result +@PURPOSE@ Get the value for a symbolic constant @DESC@ Returns whether a symbolic constant with name string is registered, placing the value of the constant in result if present. diff --git a/doc/fcdircache.fncs b/doc/fcdircache.fncs index faeba29..056439a 100644 --- a/doc/fcdircache.fncs +++ b/doc/fcdircache.fncs @@ -20,11 +20,11 @@ * OF THIS SOFTWARE. */ -@RET@ FcBool -@FUNC@ FcDirCacheUnlink -@TYPE1@ const FcChar8 * @ARG1@ dir -@TYPE2@ FcConfig * @ARG2@ config -@PURPOSE@ Remove all caches related to dir +@RET@ FcBool +@FUNC@ FcDirCacheUnlink +@TYPE1@ const FcChar8 * @ARG1@ dir +@TYPE2@ FcConfig * @ARG2@ config +@PURPOSE@ Remove all caches related to dir @DESC@ Scans the cache directories in config, removing any instances of the cache file for dir. Returns FcFalse @@ -32,21 +32,21 @@ when some internal error occurs (out of memory, etc). Errors actually unlinking any files are ignored. @@ -@RET@ FcBool -@FUNC@ FcDirCacheValid -@TYPE1@ const FcChar8 * @ARG1@ dir -@PURPOSE@ check directory cache +@RET@ FcBool +@FUNC@ FcDirCacheValid +@TYPE1@ const FcChar8 * @ARG1@ dir +@PURPOSE@ check directory cache @DESC@ Returns FcTrue if dir has an associated valid cache file, else returns FcFalse @@ -@RET@ FcCache * -@FUNC@ FcDirCacheLoad -@TYPE1@ const FcChar8 * @ARG1@ dir -@TYPE2@ FcConfig * @ARG2@ config -@TYPE3@ FcChar8 ** @ARG3@ cache_file -@PURPOSE@ load a directory cache +@RET@ FcCache * +@FUNC@ FcDirCacheLoad +@TYPE1@ const FcChar8 * @ARG1@ dir +@TYPE2@ FcConfig * @ARG2@ config +@TYPE3@ FcChar8 ** @ARG3@ cache_file +@PURPOSE@ load a directory cache @DESC@ Loads the cache related to dir. If no cache file exists, returns NULL. The name of the cache file is returned in @@ -54,23 +54,23 @@ exists, returns NULL. The name of the cache file is returned in FcDirCacheRead. @@ -@RET@ FcCache * -@FUNC@ FcDirCacheRescan -@TYPE1@ const FcChar8 * @ARG1@ dir -@TYPE2@ FcConfig * @ARG2@ config -@PURPOSE@ Re-scan a directory cache +@RET@ FcCache * +@FUNC@ FcDirCacheRescan +@TYPE1@ const FcChar8 * @ARG1@ dir +@TYPE2@ FcConfig * @ARG2@ config +@PURPOSE@ Re-scan a directory cache @DESC@ Re-scan directories only at dir and update the cache. returns NULL if failed. -@SINCE@ 2.11.1 +@SINCE@ 2.11.1 @@ -@RET@ FcCache * -@FUNC@ FcDirCacheRead -@TYPE1@ const FcChar8 * @ARG1@ dir -@TYPE2@ FcBool% @ARG2@ force -@TYPE3@ FcConfig * @ARG3@ config -@PURPOSE@ read or construct a directory cache +@RET@ FcCache * +@FUNC@ FcDirCacheRead +@TYPE1@ const FcChar8 * @ARG1@ dir +@TYPE2@ FcBool% @ARG2@ force +@TYPE3@ FcConfig * @ARG3@ config +@PURPOSE@ read or construct a directory cache @DESC@ This returns a cache for dir. If force is FcFalse, then an existing, valid cache file @@ -78,21 +78,21 @@ will be used. Otherwise, a new cache will be created by scanning the directory and that returned. @@ -@RET@ FcCache * -@FUNC@ FcDirCacheLoadFile -@TYPE1@ const FcChar8 * @ARG1@ cache_file -@TYPE2@ struct stat * @ARG2@ file_stat -@PURPOSE@ load a cache file +@RET@ FcCache * +@FUNC@ FcDirCacheLoadFile +@TYPE1@ const FcChar8 * @ARG1@ cache_file +@TYPE2@ struct stat * @ARG2@ file_stat +@PURPOSE@ load a cache file @DESC@ This function loads a directory cache from cache_file. If file_stat is non-NULL, it will be filled with the results of stat(2) on the cache file. @@ -@RET@ void -@FUNC@ FcDirCacheUnload -@TYPE1@ FcCache * @ARG1@ cache -@PURPOSE@ unload a cache file +@RET@ void +@FUNC@ FcDirCacheUnload +@TYPE1@ FcCache * @ARG1@ cache +@PURPOSE@ unload a cache file @DESC@ This function dereferences cache. When no other references to it remain, all memory associated with the cache will be freed. diff --git a/doc/fcfile.fncs b/doc/fcfile.fncs index 5f5f32a..798c818 100644 --- a/doc/fcfile.fncs +++ b/doc/fcfile.fncs @@ -22,15 +22,15 @@ * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ FcBool -@FUNC@ FcFileScan -@TYPE1@ FcFontSet * @ARG1@ set -@TYPE2@ FcStrSet * @ARG2@ dirs -@TYPE3@ FcFileCache * @ARG3@ cache -@TYPE4@ FcBlanks * @ARG4@ blanks -@TYPE5@ const FcChar8 * @ARG5@ file -@TYPE6@ FcBool% @ARG6@ force -@PURPOSE@ scan a font file +@RET@ FcBool +@FUNC@ FcFileScan +@TYPE1@ FcFontSet * @ARG1@ set +@TYPE2@ FcStrSet * @ARG2@ dirs +@TYPE3@ FcFileCache * @ARG3@ cache +@TYPE4@ FcBlanks * @ARG4@ blanks +@TYPE5@ const FcChar8 * @ARG5@ file +@TYPE6@ FcBool% @ARG6@ force +@PURPOSE@ scan a font file @DESC@ Scans a single file and adds all fonts found to set. If force is FcTrue, then the file is scanned even if @@ -45,24 +45,24 @@ 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 -@FUNC@ FcFileIsDir -@TYPE1@ const FcChar8 * @ARG1@ file -@PURPOSE@ check whether a file is a directory +@RET@ FcBool +@FUNC@ FcFileIsDir +@TYPE1@ const FcChar8 * @ARG1@ file +@PURPOSE@ check whether a file is a directory @DESC@ Returns FcTrue if file is a directory, otherwise returns FcFalse. @@ -@RET@ FcBool -@FUNC@ FcDirScan -@TYPE1@ FcFontSet * @ARG1@ set -@TYPE2@ FcStrSet * @ARG2@ dirs -@TYPE3@ FcFileCache * @ARG3@ cache -@TYPE4@ FcBlanks * @ARG4@ blanks -@TYPE5@ const FcChar8 * @ARG5@ dir -@TYPE6@ FcBool% @ARG6@ force -@PURPOSE@ scan a font directory without caching it +@RET@ FcBool +@FUNC@ FcDirScan +@TYPE1@ FcFontSet * @ARG1@ set +@TYPE2@ FcStrSet * @ARG2@ dirs +@TYPE3@ FcFileCache * @ARG3@ cache +@TYPE4@ FcBlanks * @ARG4@ blanks +@TYPE5@ const FcChar8 * @ARG5@ dir +@TYPE6@ FcBool% @ARG6@ force +@PURPOSE@ scan a font directory without caching it @DESC@ If cache is not zero or if force is FcFalse, this function currently returns FcFalse. Otherwise, it scans an @@ -72,12 +72,12 @@ this function does not create any cache files. Use FcDirCacheRead() if caching is desired. @@ -@RET@ FcBool -@FUNC@ FcDirSave -@TYPE1@ FcFontSet * @ARG1@ set -@TYPE2@ FcStrSet * @ARG2@ dirs -@TYPE3@ const FcChar8 * @ARG3@ dir -@PURPOSE@ DEPRECATED: formerly used to save a directory cache +@RET@ FcBool +@FUNC@ FcDirSave +@TYPE1@ FcFontSet * @ARG1@ set +@TYPE2@ FcStrSet * @ARG2@ dirs +@TYPE3@ const FcChar8 * @ARG3@ dir +@PURPOSE@ DEPRECATED: formerly used to save a directory cache @DESC@ This function now does nothing aside from returning FcFalse. It used to creates the per-directory cache file for dir and populates it diff --git a/doc/fcfontset.fncs b/doc/fcfontset.fncs index f9f5ea5..b4a6a39 100644 --- a/doc/fcfontset.fncs +++ b/doc/fcfontset.fncs @@ -21,42 +21,42 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ FcFontSet * -@FUNC@ FcFontSetCreate -@TYPE1@ void -@PURPOSE@ Create a font set +@RET@ FcFontSet * +@FUNC@ FcFontSetCreate +@TYPE1@ void +@PURPOSE@ Create a font set @DESC@ Creates an empty font set. @@ -@RET@ void -@FUNC@ FcFontSetDestroy -@TYPE1@ FcFontSet * @ARG1@ s -@PURPOSE@ Destroy a font set +@RET@ void +@FUNC@ FcFontSetDestroy +@TYPE1@ FcFontSet * @ARG1@ s +@PURPOSE@ Destroy a font set @DESC@ Destroys a font set. Note that this destroys any referenced patterns as well. @@ -@RET@ FcBool -@FUNC@ FcFontSetAdd -@TYPE1@ FcFontSet * @ARG1@ s -@TYPE2@ FcPattern * @ARG2@ font -@PURPOSE@ Add to a font set +@RET@ FcBool +@FUNC@ FcFontSetAdd +@TYPE1@ FcFontSet * @ARG1@ s +@TYPE2@ FcPattern * @ARG2@ font +@PURPOSE@ Add to a font set @DESC@ Adds a pattern to a font set. Note that the pattern is not copied before being inserted into the set. Returns FcFalse if the pattern cannot be inserted into the set (due to allocation failure). Otherwise returns FcTrue. @@ -@RET@ FcFontSet * -@FUNC@ FcFontSetList -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcFontSet ** @ARG2@ sets -@TYPE3@ int @ARG3@ nsets -@TYPE4@ FcPattern * @ARG4@ pattern -@TYPE5@ FcObjectSet * @ARG5@ object_set -@PURPOSE@ List fonts from a set of font sets +@RET@ FcFontSet * +@FUNC@ FcFontSetList +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcFontSet ** @ARG2@ sets +@TYPE3@ int @ARG3@ nsets +@TYPE4@ FcPattern * @ARG4@ pattern +@TYPE5@ FcObjectSet * @ARG5@ object_set +@PURPOSE@ List fonts from a set of font sets @DESC@ Selects fonts matching pattern from sets, creates patterns from those @@ -66,14 +66,14 @@ If config is NULL, the default configuration is checked to be up to date, and used. @@ -@RET@ FcPattern * -@FUNC@ FcFontSetMatch -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcFontSet ** @ARG2@ sets -@TYPE3@ int @ARG3@ nsets -@TYPE4@ FcPattern * @ARG4@ pattern -@TYPE5@ FcResult * @ARG5@ result -@PURPOSE@ Return the best font from a set of font sets +@RET@ FcPattern * +@FUNC@ FcFontSetMatch +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcFontSet ** @ARG2@ sets +@TYPE3@ int @ARG3@ nsets +@TYPE4@ FcPattern * @ARG4@ pattern +@TYPE5@ FcResult * @ARG5@ result +@PURPOSE@ Return the best font from a set of font sets @DESC@ Finds the font in sets most closely matching pattern and returns the result of @@ -86,10 +86,10 @@ If config is NULL, the current configuration is used. Returns NULL if an error occurs during this process. @@ -@RET@ void -@FUNC@ FcFontSetPrint -@TYPE1@ FcFontSet * @ARG1@ set -@PURPOSE@ Print a set of patterns to stdout +@RET@ void +@FUNC@ FcFontSetPrint +@TYPE1@ FcFontSet * @ARG1@ set +@PURPOSE@ Print a set of patterns to stdout @DESC@ This function is useful for diagnosing font related issues, printing the complete contents of every pattern in set. The format @@ -97,19 +97,19 @@ of the output is designed to be of help to users and developers, and may change at any time. @@ -@RET@ FcFontSet * -@FUNC@ FcFontSetSort -@TYPE1@ FcConfig * @ARG1@ config -@TYPE2@ FcFontSet ** @ARG2@ sets -@TYPE3@ int @ARG3@ nsets -@TYPE4@ FcPattern * @ARG4@ pattern -@TYPE5@ FcBool% @ARG5@ trim -@TYPE6@ FcCharSet ** @ARG6@ csp -@TYPE7@ FcResult * @ARG7@ result -@PURPOSE@ Add to a font set +@RET@ FcFontSet * +@FUNC@ FcFontSetSort +@TYPE1@ FcConfig * @ARG1@ config +@TYPE2@ FcFontSet ** @ARG2@ sets +@TYPE3@ int @ARG3@ nsets +@TYPE4@ FcPattern * @ARG4@ pattern +@TYPE5@ FcBool% @ARG5@ trim +@TYPE6@ FcCharSet ** @ARG6@ csp +@TYPE7@ FcResult * @ARG7@ result +@PURPOSE@ Add to a font set @DESC@ Returns the list of fonts from sets -sorted by closeness to pattern. +sorted by closeness to pattern. If trim is FcTrue, elements in the list which don't include Unicode coverage not provided by earlier elements in the list are elided. The union of Unicode coverage of @@ -128,10 +128,10 @@ modify these patterns. Instead, they should be passed, along with The FcFontSet returned by FcFontSetSort is destroyed by calling FcFontSetDestroy. @@ -@RET@ void -@FUNC@ FcFontSetSortDestroy -@TYPE1@ FcFontSet * @ARG1@ set -@PURPOSE@ DEPRECATED destroy a font set +@RET@ void +@FUNC@ FcFontSetSortDestroy +@TYPE1@ FcFontSet * @ARG1@ set +@PURPOSE@ DEPRECATED destroy a font set @DESC@ This function is DEPRECATED. FcFontSetSortDestroy destroys set by calling diff --git a/doc/fcformat.fncs b/doc/fcformat.fncs index 71b866b..754004f 100644 --- a/doc/fcformat.fncs +++ b/doc/fcformat.fncs @@ -22,11 +22,11 @@ * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ FcChar8 * -@FUNC@ FcPatternFormat -@TYPE1@ FcPattern * @ARG1@ pat -@TYPE2@ const FcChar8 * @ARG2@ format -@PURPOSE@ Format a pattern into a string according to a format specifier +@RET@ FcChar8 * +@FUNC@ FcPatternFormat +@TYPE1@ FcPattern * @ARG1@ pat +@TYPE2@ const FcChar8 * @ARG2@ format +@PURPOSE@ Format a pattern into a string according to a format specifier @DESC@ Converts given pattern pat into text described by @@ -305,5 +305,5 @@ For example, the format "%{family|downcase|delete( )}\n" will expand to the values of the family element in pattern, lower-cased and with spaces removed. -@SINCE@ 2.9.0 +@SINCE@ 2.9.0 @@ diff --git a/doc/fcfreetype.fncs b/doc/fcfreetype.fncs index af63e83..723d34e 100644 --- a/doc/fcfreetype.fncs +++ b/doc/fcfreetype.fncs @@ -25,11 +25,11 @@ @SYNOPSIS@ #include <fontconfig.h> #include <fcfreetype.h> -@RET@ FT_UInt -@FUNC@ FcFreeTypeCharIndex -@TYPE1@ FT_Face% @ARG1@ face -@TYPE2@ FcChar32% @ARG2@ ucs4 -@PURPOSE@ map Unicode to glyph id +@RET@ FT_UInt +@FUNC@ FcFreeTypeCharIndex +@TYPE1@ FT_Face% @ARG1@ face +@TYPE2@ FcChar32% @ARG2@ ucs4 +@PURPOSE@ map Unicode to glyph id @DESC@ Maps a Unicode char to a glyph index. This function uses information from several possible underlying encoding tables to work around broken fonts. @@ -41,11 +41,11 @@ higher level functions. @SYNOPSIS@ #include <fontconfig.h> #include <fcfreetype.h> -@RET@ FcCharSet * -@FUNC@ FcFreeTypeCharSet -@TYPE1@ FT_Face% @ARG1@ face -@TYPE2@ FcBlanks * @ARG2@ blanks -@PURPOSE@ compute Unicode coverage +@RET@ FcCharSet * +@FUNC@ FcFreeTypeCharSet +@TYPE1@ FT_Face% @ARG1@ face +@TYPE2@ FcBlanks * @ARG2@ blanks +@PURPOSE@ compute Unicode coverage @DESC@ Scans a FreeType face and returns the set of encoded Unicode chars. FcBlanks is deprecated, blanks is ignored and @@ -55,12 +55,12 @@ accepted only for compatibility with older code. @SYNOPSIS@ #include <fontconfig.h> #include <fcfreetype.h> -@RET@ FcCharSet * -@FUNC@ FcFreeTypeCharSetAndSpacing -@TYPE1@ FT_Face% @ARG1@ face -@TYPE2@ FcBlanks * @ARG2@ blanks -@TYPE3@ int * @ARG3@ spacing -@PURPOSE@ compute Unicode coverage and spacing type +@RET@ FcCharSet * +@FUNC@ FcFreeTypeCharSetAndSpacing +@TYPE1@ FT_Face% @ARG1@ face +@TYPE2@ FcBlanks * @ARG2@ blanks +@TYPE3@ int * @ARG3@ spacing +@PURPOSE@ compute Unicode coverage and spacing type @DESC@ Scans a FreeType face and returns the set of encoded Unicode chars. FcBlanks is deprecated, blanks is ignored and @@ -69,19 +69,19 @@ accepted only for compatibility with older code. font, one of FC_MONO for a font where all glyphs have the same width, FC_DUAL, where the font has glyphs in precisely two widths, one twice as wide as the other, or FC_PROPORTIONAL where the font has glyphs of many -widths. +widths. @@ @SYNOPSIS@ #include <fontconfig.h> #include <fcfreetype.h> -@RET@ FcPattern * -@FUNC@ FcFreeTypeQuery -@TYPE1@ const FcChar8 * @ARG1@ file -@TYPE2@ int% @ARG2@ id -@TYPE3@ FcBlanks * @ARG3@ blanks -@TYPE4@ int * @ARG4@ count -@PURPOSE@ compute pattern from font file (and index) +@RET@ FcPattern * +@FUNC@ FcFreeTypeQuery +@TYPE1@ const FcChar8 * @ARG1@ file +@TYPE2@ int% @ARG2@ id +@TYPE3@ FcBlanks * @ARG3@ blanks +@TYPE4@ int * @ARG4@ count +@PURPOSE@ compute pattern from font file (and index) @DESC@ Constructs a pattern representing the 'id'th face in 'file'. The number of faces in 'file' is returned in 'count'. @@ -90,22 +90,22 @@ accepted only for compatibility with older code. @@ unsigned int -FcFreeTypeQueryAll(const FcChar8 *file, - int id, - FcBlanks *blanks, - int *count, - FcFontSet *set) +FcFreeTypeQueryAll(const FcChar8 *file, + int id, + FcBlanks *blanks, + int *count, + FcFontSet *set) @SYNOPSIS@ #include <fontconfig.h> #include <fcfreetype.h> @RET@ unsigned int @FUNC@ FcFreeTypeQueryAll -@TYPE1@ const FcChar8 * @ARG1@ file -@TYPE2@ int% @ARG2@ id -@TYPE3@ FcBlanks * @ARG3@ blanks -@TYPE4@ int * @ARG4@ count -@TYPE5@ FcFontSet * @ARG5@ set -@PURPOSE@ compute all patterns from font file (and index) +@TYPE1@ const FcChar8 * @ARG1@ file +@TYPE2@ int% @ARG2@ id +@TYPE3@ FcBlanks * @ARG3@ blanks +@TYPE4@ int * @ARG4@ count +@TYPE5@ FcFontSet * @ARG5@ set +@PURPOSE@ compute all patterns from font file (and index) @DESC@ Constructs patterns found in 'file'. If id is -1, then all patterns found in 'file' are added to 'set'. @@ -114,19 +114,19 @@ The number of faces in 'file' is returned in 'count'. The number of patterns added to 'set' is returned. FcBlanks is deprecated, blanks is ignored and accepted only for compatibility with older code. -@SINCE@ 2.12.91 +@SINCE@ 2.12.91 @@ @SYNOPSIS@ #include <fontconfig.h> #include <fcfreetype.h> -@RET@ FcPattern * +@RET@ FcPattern * @FUNC@ FcFreeTypeQueryFace -@TYPE1@ const FT_Face% @ARG1@ face -@TYPE2@ const FcChar8 * @ARG2@ file -@TYPE3@ int% @ARG3@ id -@TYPE4@ FcBlanks * @ARG4@ blanks -@PURPOSE@ compute pattern from FT_Face +@TYPE1@ const FT_Face% @ARG1@ face +@TYPE2@ const FcChar8 * @ARG2@ file +@TYPE3@ int% @ARG3@ id +@TYPE4@ FcBlanks * @ARG4@ blanks +@PURPOSE@ compute pattern from FT_Face @DESC@ Constructs a pattern representing 'face'. 'file' and 'id' are used solely as data for pattern elements (FC_FILE, FC_INDEX and sometimes FC_FAMILY). diff --git a/doc/fcinit.fncs b/doc/fcinit.fncs index 014af0d..3931857 100644 --- a/doc/fcinit.fncs +++ b/doc/fcinit.fncs @@ -21,28 +21,28 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ FcConfig * -@FUNC@ FcInitLoadConfig -@TYPE1@ void -@PURPOSE@ load configuration +@RET@ FcConfig * +@FUNC@ FcInitLoadConfig +@TYPE1@ void +@PURPOSE@ load configuration @DESC@ Loads the default configuration file and returns the resulting configuration. Does not load any font information. @@ -@RET@ FcConfig * -@FUNC@ FcInitLoadConfigAndFonts -@TYPE1@ void -@PURPOSE@ load configuration and font data +@RET@ FcConfig * +@FUNC@ FcInitLoadConfigAndFonts +@TYPE1@ void +@PURPOSE@ load configuration and font data @DESC@ Loads the default configuration file and builds information about the available fonts. Returns the resulting configuration. @@ -@RET@ FcBool -@FUNC@ FcInit -@TYPE1@ void -@PURPOSE@ initialize fontconfig library +@RET@ FcBool +@FUNC@ FcInit +@TYPE1@ void +@PURPOSE@ initialize fontconfig library @DESC@ Loads the default configuration file and the fonts referenced therein and sets the default configuration to that result. Returns whether this @@ -50,10 +50,10 @@ process succeeded or not. If the default configuration has already been loaded, this routine does nothing and returns FcTrue. @@ -@RET@ void -@FUNC@ FcFini -@TYPE1@ void -@PURPOSE@ finalize fontconfig library +@RET@ void +@FUNC@ FcFini +@TYPE1@ void +@PURPOSE@ finalize fontconfig library @DESC@ Frees all data structures allocated by previous calls to fontconfig functions. Fontconfig returns to an uninitialized state, requiring a @@ -61,18 +61,18 @@ new call to one of the FcInit functions before any other fontconfig function may be called. @@ -@RET@ int -@FUNC@ FcGetVersion -@TYPE1@ void -@PURPOSE@ library version number +@RET@ int +@FUNC@ FcGetVersion +@TYPE1@ void +@PURPOSE@ library version number @DESC@ Returns the version number of the library. @@ -@RET@ FcBool -@FUNC@ FcInitReinitialize -@TYPE1@ void -@PURPOSE@ re-initialize library +@RET@ FcBool +@FUNC@ FcInitReinitialize +@TYPE1@ void +@PURPOSE@ re-initialize library @DESC@ Forces the default configuration file to be reloaded and resets the default configuration. Returns FcFalse if the configuration cannot be reloaded (due @@ -80,10 +80,10 @@ to configuration file errors, allocation failures or other issues) and leaves th existing configuration unchanged. Otherwise returns FcTrue. @@ -@RET@ FcBool -@FUNC@ FcInitBringUptoDate -@TYPE1@ void -@PURPOSE@ reload configuration files if needed +@RET@ FcBool +@FUNC@ FcInitBringUptoDate +@TYPE1@ void +@PURPOSE@ reload configuration files if needed @DESC@ Checks the rescan interval in the default configuration, checking the configuration if the interval has passed and reloading the configuration if diff --git a/doc/fclangset.fncs b/doc/fclangset.fncs index c7ed83b..401abc0 100644 --- a/doc/fclangset.fncs +++ b/doc/fclangset.fncs @@ -20,37 +20,37 @@ * OF THIS SOFTWARE. */ -@RET@ FcLangSet * -@FUNC@ FcLangSetCreate -@TYPE1@ void -@PURPOSE@ create a langset object +@RET@ FcLangSet * +@FUNC@ FcLangSetCreate +@TYPE1@ void +@PURPOSE@ create a langset object @DESC@ FcLangSetCreate creates a new FcLangSet object. @@ -@RET@ void -@FUNC@ FcLangSetDestroy -@TYPE1@ FcLangSet * @ARG1@ ls -@PURPOSE@ destroy a langset object +@RET@ void +@FUNC@ FcLangSetDestroy +@TYPE1@ FcLangSet * @ARG1@ ls +@PURPOSE@ destroy a langset object @DESC@ FcLangSetDestroy destroys a FcLangSet object, freeing all memory associated with it. @@ -@RET@ FcLangSet * -@FUNC@ FcLangSetCopy -@TYPE1@ const FcLangSet * @ARG1@ ls -@PURPOSE@ copy a langset object +@RET@ FcLangSet * +@FUNC@ FcLangSetCopy +@TYPE1@ const FcLangSet * @ARG1@ ls +@PURPOSE@ copy a langset object @DESC@ FcLangSetCopy creates a new FcLangSet object and populates it with the contents of ls. @@ -@RET@ FcBool -@FUNC@ FcLangSetAdd -@TYPE1@ FcLangSet * @ARG1@ ls -@TYPE2@ const FcChar8 * @ARG2@ lang -@PURPOSE@ add a language to a langset +@RET@ FcBool +@FUNC@ FcLangSetAdd +@TYPE1@ FcLangSet * @ARG1@ ls +@TYPE2@ const FcChar8 * @ARG2@ lang +@PURPOSE@ add a language to a langset @DESC@ lang is added to ls. lang should be of the form Ll-Tt where Ll is a @@ -58,44 +58,44 @@ two or three letter language from ISO 639 and Tt is a territory from ISO 3166. @@ -@RET@ FcBool -@FUNC@ FcLangSetDel -@TYPE1@ FcLangSet * @ARG1@ ls -@TYPE2@ const FcChar8 * @ARG2@ lang -@PURPOSE@ delete a language from a langset +@RET@ FcBool +@FUNC@ FcLangSetDel +@TYPE1@ FcLangSet * @ARG1@ ls +@TYPE2@ const FcChar8 * @ARG2@ lang +@PURPOSE@ delete a language from a langset @DESC@ lang is removed from ls. lang should be of the form Ll-Tt where Ll is a two or three letter language from ISO 639 and Tt is a territory from ISO 3166. -@SINCE@ 2.9.0 +@SINCE@ 2.9.0 @@ -@RET@ FcLangSet * -@FUNC@ FcLangSetUnion -@TYPE1@ const FcLangSet * @ARG1@ ls_a -@TYPE2@ const FcLangSet * @ARG2@ ls_b -@PURPOSE@ Add langsets +@RET@ FcLangSet * +@FUNC@ FcLangSetUnion +@TYPE1@ const FcLangSet * @ARG1@ ls_a +@TYPE2@ const FcLangSet * @ARG2@ ls_b +@PURPOSE@ Add langsets @DESC@ Returns a set including only those languages found in either ls_a or ls_b. -@SINCE@ 2.9.0 +@SINCE@ 2.9.0 @@ -@RET@ FcLangSet * -@FUNC@ FcLangSetSubtract -@TYPE1@ const FcLangSet * @ARG1@ ls_a -@TYPE2@ const FcLangSet * @ARG2@ ls_b -@PURPOSE@ Subtract langsets +@RET@ FcLangSet * +@FUNC@ FcLangSetSubtract +@TYPE1@ const FcLangSet * @ARG1@ ls_a +@TYPE2@ const FcLangSet * @ARG2@ ls_b +@PURPOSE@ Subtract langsets @DESC@ Returns a set including only those languages found in ls_a but not in ls_b. -@SINCE@ 2.9.0 +@SINCE@ 2.9.0 @@ -@RET@ FcLangResult -@FUNC@ FcLangSetCompare -@TYPE1@ const FcLangSet * @ARG1@ ls_a -@TYPE2@ const FcLangSet * @ARG2@ ls_b -@PURPOSE@ compare language sets +@RET@ FcLangResult +@FUNC@ FcLangSetCompare +@TYPE1@ const FcLangSet * @ARG1@ ls_a +@TYPE2@ const FcLangSet * @ARG2@ ls_b +@PURPOSE@ compare language sets @DESC@ FcLangSetCompare compares language coverage for ls_a and ls_b. If they share @@ -105,11 +105,11 @@ function returns FcLangDifferentTerritory. If they share no languages in common, this function returns FcLangDifferentLang. @@ -@RET@ FcBool -@FUNC@ FcLangSetContains -@TYPE1@ const FcLangSet * @ARG1@ ls_a -@TYPE2@ const FcLangSet * @ARG2@ ls_b -@PURPOSE@ check langset subset relation +@RET@ FcBool +@FUNC@ FcLangSetContains +@TYPE1@ const FcLangSet * @ARG1@ ls_a +@TYPE2@ const FcLangSet * @ARG2@ ls_b +@PURPOSE@ check langset subset relation @DESC@ FcLangSetContains returns FcTrue if ls_a contains every language in @@ -119,20 +119,20 @@ has exactly the language, or either the language or ls_a has no territory. @@ -@RET@ FcBool -@FUNC@ FcLangSetEqual -@TYPE1@ const FcLangSet * @ARG1@ ls_a -@TYPE2@ const FcLangSet * @ARG2@ ls_b -@PURPOSE@ test for matching langsets +@RET@ FcBool +@FUNC@ FcLangSetEqual +@TYPE1@ const FcLangSet * @ARG1@ ls_a +@TYPE2@ const FcLangSet * @ARG2@ ls_b +@PURPOSE@ test for matching langsets @DESC@ Returns FcTrue if and only if ls_a supports precisely the same language and territory combinations as ls_b. @@ -@RET@ FcChar32 -@FUNC@ FcLangSetHash -@TYPE1@ const FcLangSet * @ARG1@ ls -@PURPOSE@ return a hash value for a langset +@RET@ FcChar32 +@FUNC@ FcLangSetHash +@TYPE1@ const FcLangSet * @ARG1@ ls +@PURPOSE@ return a hash value for a langset @DESC@ This function returns a value which depends solely on the languages supported by ls. Any language which equals @@ -141,61 +141,61 @@ supported by ls. Any language which equals value may not be equal. @@ -@RET@ FcLangResult -@FUNC@ FcLangSetHasLang -@TYPE1@ const FcLangSet * @ARG1@ ls -@TYPE2@ const FcChar8 * @ARG2@ lang -@PURPOSE@ test langset for language support +@RET@ FcLangResult +@FUNC@ FcLangSetHasLang +@TYPE1@ const FcLangSet * @ARG1@ ls +@TYPE2@ const FcChar8 * @ARG2@ lang +@PURPOSE@ test langset for language support @DESC@ FcLangSetHasLang checks whether -ls supports lang. If +ls supports lang. If ls has a matching language and territory pair, this function returns FcLangEqual. If ls has a matching language but differs in which territory that language is for, this -function returns FcLangDifferentTerritory. If ls +function returns FcLangDifferentTerritory. If ls has no matching language, this function returns FcLangDifferentLang. @@ -@RET@ FcStrSet * -@FUNC@ FcGetDefaultLangs -@TYPE1@ void -@PURPOSE@ Get the default languages list +@RET@ FcStrSet * +@FUNC@ FcGetDefaultLangs +@TYPE1@ void +@PURPOSE@ Get the default languages list @DESC@ Returns a string set of the default languages according to the environment variables on the system. This function looks for them in order of FC_LANG, LC_ALL, LC_CTYPE and LANG then. If there are no valid values in those environment variables, "en" will be set as fallback. -@SINCE@ 2.9.91 +@SINCE@ 2.9.91 @@ -@RET@ FcStrSet * -@FUNC@ FcLangSetGetLangs -@TYPE1@ const FcLangSet * @ARG1@ ls -@PURPOSE@ get the list of languages in the langset +@RET@ FcStrSet * +@FUNC@ FcLangSetGetLangs +@TYPE1@ const FcLangSet * @ARG1@ ls +@PURPOSE@ get the list of languages in the langset @DESC@ Returns a string set of all languages in langset. @@ -@RET@ FcStrSet * -@FUNC@ FcGetLangs -@TYPE1@ void -@PURPOSE@ Get list of languages +@RET@ FcStrSet * +@FUNC@ FcGetLangs +@TYPE1@ void +@PURPOSE@ Get list of languages @DESC@ Returns a string set of all known languages. @@ -@RET@ FcChar8 * -@FUNC@ FcLangNormalize -@TYPE1@ const FcChar8 * @ARG1@ lang -@PURPOSE@ Normalize the language string +@RET@ FcChar8 * +@FUNC@ FcLangNormalize +@TYPE1@ const FcChar8 * @ARG1@ lang +@PURPOSE@ Normalize the language string @DESC@ Returns a string to make lang suitable on fontconfig. -@SINCE@ 2.10.91 +@SINCE@ 2.10.91 @@ -@RET@ const FcCharSet * -@FUNC@ FcLangGetCharSet -@TYPE1@ const FcChar8 * @ARG1@ lang -@PURPOSE@ Get character map for a language +@RET@ const FcCharSet * +@FUNC@ FcLangGetCharSet +@TYPE1@ const FcChar8 * @ARG1@ lang +@PURPOSE@ Get character map for a language @DESC@ Returns the FcCharMap for a language. @@ diff --git a/doc/fcmatrix.fncs b/doc/fcmatrix.fncs index a53ade9..cda37a2 100644 --- a/doc/fcmatrix.fncs +++ b/doc/fcmatrix.fncs @@ -22,59 +22,59 @@ * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ void -@FUNC@ FcMatrixInit -@PURPOSE@ initialize an FcMatrix structure -@TYPE1@ FcMatrix * -@ARG1@ matrix +@RET@ void +@FUNC@ FcMatrixInit +@PURPOSE@ initialize an FcMatrix structure +@TYPE1@ FcMatrix * +@ARG1@ matrix @DESC@ FcMatrixInit initializes matrix to the identity matrix. @@ -@FUNC@ FcMatrixCopy -@PURPOSE@ Copy a matrix -@TYPE1@ const FcMatrix * -@ARG1@ matrix +@FUNC@ FcMatrixCopy +@PURPOSE@ Copy a matrix +@TYPE1@ const FcMatrix * +@ARG1@ matrix @DESC@ FcMatrixCopy allocates a new FcMatrix and copies mat into it. @@ -@FUNC@ FcMatrixEqual -@PURPOSE@ Compare two matrices -@TYPE1@ const FcMatrix * -@ARG1@ matrix1 -@TYPE2@ const FcMatrix * -@ARG2@ matrix2 +@FUNC@ FcMatrixEqual +@PURPOSE@ Compare two matrices +@TYPE1@ const FcMatrix * +@ARG1@ matrix1 +@TYPE2@ const FcMatrix * +@ARG2@ matrix2 @DESC@ FcMatrixEqual compares matrix1 and matrix2 returning FcTrue when they are equal and FcFalse when they are not. @@ -@FUNC@ FcMatrixMultiply -@PURPOSE@ Multiply matrices -@TYPE1@ FcMatrix * -@ARG1@ result -@TYPE2@ const FcMatrix * -@ARG2@ matrix1 -@TYPE3@ const FcMatrix * -@ARG3@ matrix2 +@FUNC@ FcMatrixMultiply +@PURPOSE@ Multiply matrices +@TYPE1@ FcMatrix * +@ARG1@ result +@TYPE2@ const FcMatrix * +@ARG2@ matrix1 +@TYPE3@ const FcMatrix * +@ARG3@ matrix2 @DESC@ FcMatrixMultiply multiplies matrix1 and matrix2 storing the result in result. @@ -@FUNC@ FcMatrixRotate -@PURPOSE@ Rotate a matrix -@TYPE1@ FcMatrix * -@ARG1@ matrix -@TYPE2@ double% -@ARG2@ cos -@TYPE3@ double% -@ARG3@ sin +@FUNC@ FcMatrixRotate +@PURPOSE@ Rotate a matrix +@TYPE1@ FcMatrix * +@ARG1@ matrix +@TYPE2@ double% +@ARG2@ cos +@TYPE3@ double% +@ARG3@ sin @DESC@ FcMatrixRotate rotates matrix by the angle who's sine is sin and cosine is @@ -86,14 +86,14 @@ matrix: @@ -@FUNC@ FcMatrixScale -@PURPOSE@ Scale a matrix -@TYPE1@ FcMatrix * -@ARG1@ matrix -@TYPE2@ double% -@ARG2@ sx -@TYPE3@ double% -@ARG3@ dy +@FUNC@ FcMatrixScale +@PURPOSE@ Scale a matrix +@TYPE1@ FcMatrix * +@ARG1@ matrix +@TYPE2@ double% +@ARG2@ sx +@TYPE3@ double% +@ARG3@ dy @DESC@ FcMatrixScale multiplies matrix x values by sx and y values by @@ -105,14 +105,14 @@ the matrix: @@ -@FUNC@ FcMatrixShear -@PURPOSE@ Shear a matrix -@TYPE1@ FcMatrix * -@ARG1@ matrix -@TYPE2@ double% -@ARG2@ sh -@TYPE3@ double% -@ARG3@ sv +@FUNC@ FcMatrixShear +@PURPOSE@ Shear a matrix +@TYPE1@ FcMatrix * +@ARG1@ matrix +@TYPE2@ double% +@ARG2@ sh +@TYPE3@ double% +@ARG3@ sv @DESC@ FcMatrixShare shears matrix horizontally by sh and vertically by diff --git a/doc/fcobjectset.fncs b/doc/fcobjectset.fncs index 57e1750..423f707 100644 --- a/doc/fcobjectset.fncs +++ b/doc/fcobjectset.fncs @@ -21,51 +21,51 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ FcObjectSet * -@FUNC@ FcObjectSetCreate -@TYPE1@ void -@PURPOSE@ Create an object set +@RET@ FcObjectSet * +@FUNC@ FcObjectSetCreate +@TYPE1@ void +@PURPOSE@ Create an object set @DESC@ Creates an empty set. @@ -@RET@ FcBool -@FUNC@ FcObjectSetAdd -@TYPE1@ FcObjectSet * @ARG1@ os -@TYPE2@ const char * @ARG2@ object -@PURPOSE@ Add to an object set +@RET@ FcBool +@FUNC@ FcObjectSetAdd +@TYPE1@ FcObjectSet * @ARG1@ os +@TYPE2@ const char * @ARG2@ object +@PURPOSE@ Add to an object set @DESC@ Adds a property name to the set. Returns FcFalse if the property name cannot be inserted into the set (due to allocation failure). Otherwise returns FcTrue. @@ -@RET@ void -@FUNC@ FcObjectSetDestroy -@TYPE1@ FcObjectSet * @ARG1@ os -@PURPOSE@ Destroy an object set +@RET@ void +@FUNC@ FcObjectSetDestroy +@TYPE1@ FcObjectSet * @ARG1@ os +@PURPOSE@ Destroy an object set @DESC@ Destroys an object set. @@ -@RET@ FcObjectSet * -@FUNC@ FcObjectSetBuild -@TYPE1@ const char * @ARG1@ first -@TYPE2@ ... +@RET@ FcObjectSet * +@FUNC@ FcObjectSetBuild +@TYPE1@ const char * @ARG1@ first +@TYPE2@ ... @PROTOTYPE+@ -@RET+@ FcObjectSet * -@FUNC+@ FcObjectSetVaBuild -@TYPE1+@ const char * @ARG1+@ first -@TYPE2+@ va_list% @ARG2+@ va +@RET+@ FcObjectSet * +@FUNC+@ FcObjectSetVaBuild +@TYPE1+@ const char * @ARG1+@ first +@TYPE2+@ va_list% @ARG2+@ va @PROTOTYPE++@ -@RET++@ void -@FUNC++@ FcObjectSetVapBuild -@TYPE1++@ FcObjectSet * @ARG1++@ result -@TYPE2++@ const char * @ARG2++@ first -@TYPE3++@ va_list% @ARG3++@ va +@RET++@ void +@FUNC++@ FcObjectSetVapBuild +@TYPE1++@ FcObjectSet * @ARG1++@ result +@TYPE2++@ const char * @ARG2++@ first +@TYPE3++@ va_list% @ARG3++@ va -@PURPOSE@ Build object set from args +@PURPOSE@ Build object set from args @DESC@ These build an object set from a null-terminated list of property names. FcObjectSetVapBuild is a macro version of FcObjectSetVaBuild which returns diff --git a/doc/fcobjecttype.fncs b/doc/fcobjecttype.fncs index 3f976e4..1e71e6c 100644 --- a/doc/fcobjecttype.fncs +++ b/doc/fcobjecttype.fncs @@ -21,28 +21,28 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ FcBool -@FUNC@ FcNameRegisterObjectTypes -@TYPE1@ const FcObjectType * @ARG1@ types -@TYPE2@ int% @ARG2@ ntype -@PURPOSE@ Register object types +@RET@ FcBool +@FUNC@ FcNameRegisterObjectTypes +@TYPE1@ const FcObjectType * @ARG1@ types +@TYPE2@ int% @ARG2@ ntype +@PURPOSE@ Register object types @DESC@ Deprecated. Does nothing. Returns FcFalse. @@ -@RET@ FcBool -@FUNC@ FcNameUnregisterObjectTypes -@TYPE1@ const FcObjectType * @ARG1@ types -@TYPE2@ int% @ARG2@ ntype -@PURPOSE@ Unregister object types +@RET@ FcBool +@FUNC@ FcNameUnregisterObjectTypes +@TYPE1@ const FcObjectType * @ARG1@ types +@TYPE2@ int% @ARG2@ ntype +@PURPOSE@ Unregister object types @DESC@ Deprecated. Does nothing. Returns FcFalse. @@ -@RET@ const FcObjectType * -@FUNC@ FcNameGetObjectType -@TYPE1@ const char * @ARG1@ object -@PURPOSE@ Lookup an object type +@RET@ const FcObjectType * +@FUNC@ FcNameGetObjectType +@TYPE1@ const char * @ARG1@ object +@PURPOSE@ Lookup an object type @DESC@ Return the object type for the pattern element named object. @@ diff --git a/doc/fcpattern.fncs b/doc/fcpattern.fncs index 1f5b10d..0da3568 100644 --- a/doc/fcpattern.fncs +++ b/doc/fcpattern.fncs @@ -21,76 +21,76 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ FcPattern * -@FUNC@ FcPatternCreate -@TYPE1@ void -@PURPOSE@ Create a pattern +@RET@ FcPattern * +@FUNC@ FcPatternCreate +@TYPE1@ void +@PURPOSE@ Create a pattern @DESC@ Creates a pattern with no properties; used to build patterns from scratch. @@ -@RET@ FcPattern * -@FUNC@ FcPatternDuplicate -@TYPE1@ const FcPattern * @ARG1@ p -@PURPOSE@ Copy a pattern +@RET@ FcPattern * +@FUNC@ FcPatternDuplicate +@TYPE1@ const FcPattern * @ARG1@ p +@PURPOSE@ Copy a pattern @DESC@ Copy a pattern, returning a new pattern that matches p. Each pattern may be modified without affecting the other. @@ -@RET@ void -@FUNC@ FcPatternReference -@TYPE1@ FcPattern * @ARG1@ p -@PURPOSE@ Increment pattern reference count +@RET@ void +@FUNC@ FcPatternReference +@TYPE1@ FcPattern * @ARG1@ p +@PURPOSE@ Increment pattern reference count @DESC@ Add another reference to p. Patterns are freed only when the reference count reaches zero. @@ -@RET@ void -@FUNC@ FcPatternDestroy -@TYPE1@ FcPattern * @ARG1@ p -@PURPOSE@ Destroy a pattern +@RET@ void +@FUNC@ FcPatternDestroy +@TYPE1@ FcPattern * @ARG1@ p +@PURPOSE@ Destroy a pattern @DESC@ Decrement the pattern reference count. If all references are gone, destroys the pattern, in the process destroying all related values. @@ -@RET@ int -@FUNC@ FcPatternObjectCount -@TYPE1@ const FcPattern * @ARG1@ p -@PURPOSE@ Returns the number of the object +@RET@ int +@FUNC@ FcPatternObjectCount +@TYPE1@ const FcPattern * @ARG1@ p +@PURPOSE@ Returns the number of the object @DESC@ Returns the number of the object p has. -@SINCE@ 2.13.1 +@SINCE@ 2.13.1 @@ -@RET@ FcBool -@FUNC@ FcPatternEqual -@TYPE1@ const FcPattern * @ARG1@ pa -@TYPE2@ const FcPattern * @ARG2@ pb -@PURPOSE@ Compare patterns +@RET@ FcBool +@FUNC@ FcPatternEqual +@TYPE1@ const FcPattern * @ARG1@ pa +@TYPE2@ const FcPattern * @ARG2@ pb +@PURPOSE@ Compare patterns @DESC@ Returns whether pa and pb are exactly alike. @@ -@RET@ FcBool -@FUNC@ FcPatternEqualSubset -@TYPE1@ const FcPattern * @ARG1@ pa -@TYPE2@ const FcPattern * @ARG2@ pb -@TYPE3@ const FcObjectSet * @ARG3@ os -@PURPOSE@ Compare portions of patterns +@RET@ FcBool +@FUNC@ FcPatternEqualSubset +@TYPE1@ const FcPattern * @ARG1@ pa +@TYPE2@ const FcPattern * @ARG2@ pb +@TYPE3@ const FcObjectSet * @ARG3@ os +@PURPOSE@ Compare portions of patterns @DESC@ Returns whether pa and pb have exactly the same values for all of the objects in os. @@ -@RET@ FcPattern * -@FUNC@ FcPatternFilter -@TYPE1@ FcPattern * @ARG1@ p -@TYPE2@ const FcObjectSet * @ARG2@ os -@PURPOSE@ Filter the objects of pattern +@RET@ FcPattern * +@FUNC@ FcPatternFilter +@TYPE1@ FcPattern * @ARG1@ p +@TYPE2@ const FcObjectSet * @ARG2@ os +@PURPOSE@ Filter the objects of pattern @DESC@ Returns a new pattern that only has those objects from p that are in os. @@ -98,22 +98,22 @@ If os is NULL, a duplicate of p is returned. @@ -@RET@ FcChar32 -@FUNC@ FcPatternHash -@TYPE1@ const FcPattern * @ARG1@ p -@PURPOSE@ Compute a pattern hash value +@RET@ FcChar32 +@FUNC@ FcPatternHash +@TYPE1@ const FcPattern * @ARG1@ p +@PURPOSE@ Compute a pattern hash value @DESC@ Returns a 32-bit number which is the same for any two patterns which are equal. @@ -@RET@ FcBool -@FUNC@ FcPatternAdd -@TYPE1@ FcPattern * @ARG1@ p -@TYPE2@ const char * @ARG2@ object -@TYPE3@ FcValue% @ARG3@ value -@TYPE4@ FcBool% @ARG4@ append -@PURPOSE@ Add a value to a pattern +@RET@ FcBool +@FUNC@ FcPatternAdd +@TYPE1@ FcPattern * @ARG1@ p +@TYPE2@ const char * @ARG2@ object +@TYPE3@ FcValue% @ARG3@ value +@TYPE4@ FcBool% @ARG4@ append +@PURPOSE@ Add a value to a pattern @DESC@ Adds a single value to the list of values associated with the property named `object. If `append is FcTrue, the value is added at the end of any @@ -122,82 +122,82 @@ existing list, otherwise it is inserted at the beginning. `value' is saved retains no reference to any application-supplied data structure. @@ -@RET@ FcBool -@FUNC@ FcPatternAddWeak -@TYPE1@ FcPattern * @ARG1@ p -@TYPE2@ const char * @ARG2@ object -@TYPE3@ FcValue% @ARG3@ value -@TYPE4@ FcBool% @ARG4@ append -@PURPOSE@ Add a value to a pattern with weak binding +@RET@ FcBool +@FUNC@ FcPatternAddWeak +@TYPE1@ FcPattern * @ARG1@ p +@TYPE2@ const char * @ARG2@ object +@TYPE3@ FcValue% @ARG3@ value +@TYPE4@ FcBool% @ARG4@ append +@PURPOSE@ Add a value to a pattern with weak binding @DESC@ FcPatternAddWeak is essentially the same as FcPatternAdd except that any values added to the list have binding weak instead of strong. @@ -@TITLE@ FcPatternAdd-Type -@RET@ FcBool -@FUNC@ FcPatternAddInteger -@TYPE1@ FcPattern * @ARG1@ p -@TYPE2@ const char * @ARG2@ object -@TYPE3@ int% @ARG3@ i +@TITLE@ FcPatternAdd-Type +@RET@ FcBool +@FUNC@ FcPatternAddInteger +@TYPE1@ FcPattern * @ARG1@ p +@TYPE2@ const char * @ARG2@ object +@TYPE3@ int% @ARG3@ i @PROTOTYPE+@ -@RET+@ FcBool -@FUNC+@ FcPatternAddDouble -@TYPE1+@ FcPattern * @ARG1+@ p -@TYPE2+@ const char * @ARG2+@ object -@TYPE3+@ double% @ARG3+@ d +@RET+@ FcBool +@FUNC+@ FcPatternAddDouble +@TYPE1+@ FcPattern * @ARG1+@ p +@TYPE2+@ const char * @ARG2+@ object +@TYPE3+@ double% @ARG3+@ d @PROTOTYPE++@ -@RET++@ FcBool -@FUNC++@ FcPatternAddString -@TYPE1++@ FcPattern * @ARG1++@ p -@TYPE2++@ const char * @ARG2++@ object -@TYPE3++@ const FcChar8 * @ARG3++@ s +@RET++@ FcBool +@FUNC++@ FcPatternAddString +@TYPE1++@ FcPattern * @ARG1++@ p +@TYPE2++@ const char * @ARG2++@ object +@TYPE3++@ const FcChar8 * @ARG3++@ s @PROTOTYPE+++@ -@RET+++@ FcBool -@FUNC+++@ FcPatternAddMatrix -@TYPE1+++@ FcPattern * @ARG1+++@ p -@TYPE2+++@ const char * @ARG2+++@ object -@TYPE3+++@ const FcMatrix * @ARG3+++@ m +@RET+++@ FcBool +@FUNC+++@ FcPatternAddMatrix +@TYPE1+++@ FcPattern * @ARG1+++@ p +@TYPE2+++@ const char * @ARG2+++@ object +@TYPE3+++@ const FcMatrix * @ARG3+++@ m @PROTOTYPE++++@ -@RET++++@ FcBool -@FUNC++++@ FcPatternAddCharSet -@TYPE1++++@ FcPattern * @ARG1++++@ p -@TYPE2++++@ const char * @ARG2++++@ object -@TYPE3++++@ const FcCharSet * @ARG3++++@ c +@RET++++@ FcBool +@FUNC++++@ FcPatternAddCharSet +@TYPE1++++@ FcPattern * @ARG1++++@ p +@TYPE2++++@ const char * @ARG2++++@ object +@TYPE3++++@ const FcCharSet * @ARG3++++@ c @PROTOTYPE+++++@ -@RET+++++@ FcBool -@FUNC+++++@ FcPatternAddBool -@TYPE1+++++@ FcPattern * @ARG1+++++@ p -@TYPE2+++++@ const char * @ARG2+++++@ object -@TYPE3+++++@ FcBool% @ARG3+++++@ b +@RET+++++@ FcBool +@FUNC+++++@ FcPatternAddBool +@TYPE1+++++@ FcPattern * @ARG1+++++@ p +@TYPE2+++++@ const char * @ARG2+++++@ object +@TYPE3+++++@ FcBool% @ARG3+++++@ b @PROTOTYPE++++++@ -@RET++++++@ FcBool -@FUNC++++++@ FcPatternAddFTFace -@TYPE1++++++@ FcPattern * @ARG1++++++@ p -@TYPE2++++++@ const char * @ARG2++++++@ object -@TYPE3++++++@ const FT_Face @ARG3++++++@ f +@RET++++++@ FcBool +@FUNC++++++@ FcPatternAddFTFace +@TYPE1++++++@ FcPattern * @ARG1++++++@ p +@TYPE2++++++@ const char * @ARG2++++++@ object +@TYPE3++++++@ const FT_Face @ARG3++++++@ f @PROTOTYPE+++++++@ -@RET+++++++@ FcBool -@FUNC+++++++@ FcPatternAddLangSet -@TYPE1+++++++@ FcPattern * @ARG1+++++++@ p -@TYPE2+++++++@ const char * @ARG2+++++++@ object -@TYPE3+++++++@ const FcLangSet * @ARG3+++++++@ l +@RET+++++++@ FcBool +@FUNC+++++++@ FcPatternAddLangSet +@TYPE1+++++++@ FcPattern * @ARG1+++++++@ p +@TYPE2+++++++@ const char * @ARG2+++++++@ object +@TYPE3+++++++@ const FcLangSet * @ARG3+++++++@ l @PROTOTYPE++++++++@ -@RET++++++++@ FcBool -@FUNC++++++++@ FcPatternAddRange -@TYPE1++++++++@ FcPattern * @ARG1++++++++@ p -@TYPE2++++++++@ const char * @ARG2++++++++@ object -@TYPE3++++++++@ const FcRange * @ARG3++++++++@ r +@RET++++++++@ FcBool +@FUNC++++++++@ FcPatternAddRange +@TYPE1++++++++@ FcPattern * @ARG1++++++++@ p +@TYPE2++++++++@ const char * @ARG2++++++++@ object +@TYPE3++++++++@ const FcRange * @ARG3++++++++@ r -@PURPOSE@ Add a typed value to a pattern +@PURPOSE@ Add a typed value to a pattern @DESC@ These are all convenience functions that insert objects of the specified type into the pattern. Use these in preference to FcPatternAdd as they @@ -207,30 +207,30 @@ any existing list of values. FcPatternAddRange are available since 2.11.91. @@ -@RET@ FcResult -@FUNC@ FcPatternGetWithBinding -@TYPE1@ FcPattern * @ARG1@ p -@TYPE2@ const char * @ARG2@ object -@TYPE3@ int% @ARG3@ id -@TYPE4@ FcValue * @ARG4@ v -@TYPE5@ FcValueBinding * @ARG5@ b -@PURPOSE@ Return a value with binding from a pattern +@RET@ FcResult +@FUNC@ FcPatternGetWithBinding +@TYPE1@ FcPattern * @ARG1@ p +@TYPE2@ const char * @ARG2@ object +@TYPE3@ int% @ARG3@ id +@TYPE4@ FcValue * @ARG4@ v +@TYPE5@ FcValueBinding * @ARG5@ b +@PURPOSE@ Return a value with binding from a pattern @DESC@ Returns in v the id'th value and b binding for that associated with the property object. The Value returned is not a copy, but rather refers to the data stored within the pattern directly. Applications must not free this value. -@SINCE@ 2.12.5 +@SINCE@ 2.12.5 @@ -@RET@ FcResult -@FUNC@ FcPatternGet -@TYPE1@ FcPattern * @ARG1@ p -@TYPE2@ const char * @ARG2@ object -@TYPE3@ int% @ARG3@ id -@TYPE4@ FcValue * @ARG4@ v -@PURPOSE@ Return a value from a pattern +@RET@ FcResult +@FUNC@ FcPatternGet +@TYPE1@ FcPattern * @ARG1@ p +@TYPE2@ const char * @ARG2@ object +@TYPE3@ int% @ARG3@ id +@TYPE4@ FcValue * @ARG4@ v +@PURPOSE@ Return a value from a pattern @DESC@ Returns in v the id'th value associated with the property object. @@ -238,80 +238,80 @@ The value returned is not a copy, but rather refers to the data stored within the pattern directly. Applications must not free this value. @@ -@TITLE@ FcPatternGet-Type +@TITLE@ FcPatternGet-Type @PROTOTYPE@ -@RET@ FcResult -@FUNC@ FcPatternGetInteger -@TYPE1@ FcPattern * @ARG1@ p -@TYPE2@ const char * @ARG2@ object -@TYPE3@ int% @ARG3@ n -@TYPE4@ int * @ARG4@ i +@RET@ FcResult +@FUNC@ FcPatternGetInteger +@TYPE1@ FcPattern * @ARG1@ p +@TYPE2@ const char * @ARG2@ object +@TYPE3@ int% @ARG3@ n +@TYPE4@ int * @ARG4@ i @PROTOTYPE+@ -@RET+@ FcResult -@FUNC+@ FcPatternGetDouble -@TYPE1+@ FcPattern * @ARG1+@ p -@TYPE2+@ const char * @ARG2+@ object -@TYPE3+@ int% @ARG3+@ n -@TYPE4+@ double * @ARG4+@ d +@RET+@ FcResult +@FUNC+@ FcPatternGetDouble +@TYPE1+@ FcPattern * @ARG1+@ p +@TYPE2+@ const char * @ARG2+@ object +@TYPE3+@ int% @ARG3+@ n +@TYPE4+@ double * @ARG4+@ d @PROTOTYPE++@ -@RET++@ FcResult -@FUNC++@ FcPatternGetString -@TYPE1++@ FcPattern * @ARG1++@ p -@TYPE2++@ const char * @ARG2++@ object -@TYPE3++@ int% @ARG3++@ n -@TYPE4++@ FcChar8 ** @ARG4++@ s +@RET++@ FcResult +@FUNC++@ FcPatternGetString +@TYPE1++@ FcPattern * @ARG1++@ p +@TYPE2++@ const char * @ARG2++@ object +@TYPE3++@ int% @ARG3++@ n +@TYPE4++@ FcChar8 ** @ARG4++@ s @PROTOTYPE+++@ -@RET+++@ FcResult -@FUNC+++@ FcPatternGetMatrix -@TYPE1+++@ FcPattern * @ARG1+++@ p -@TYPE2+++@ const char * @ARG2+++@ object -@TYPE3+++@ int% @ARG3+++@ n -@TYPE4+++@ FcMatrix ** @ARG4+++@ s +@RET+++@ FcResult +@FUNC+++@ FcPatternGetMatrix +@TYPE1+++@ FcPattern * @ARG1+++@ p +@TYPE2+++@ const char * @ARG2+++@ object +@TYPE3+++@ int% @ARG3+++@ n +@TYPE4+++@ FcMatrix ** @ARG4+++@ s @PROTOTYPE++++@ -@RET++++@ FcResult -@FUNC++++@ FcPatternGetCharSet -@TYPE1++++@ FcPattern * @ARG1++++@ p -@TYPE2++++@ const char * @ARG2++++@ object -@TYPE3++++@ int% @ARG3++++@ n -@TYPE4++++@ FcCharSet ** @ARG4++++@ c +@RET++++@ FcResult +@FUNC++++@ FcPatternGetCharSet +@TYPE1++++@ FcPattern * @ARG1++++@ p +@TYPE2++++@ const char * @ARG2++++@ object +@TYPE3++++@ int% @ARG3++++@ n +@TYPE4++++@ FcCharSet ** @ARG4++++@ c @PROTOTYPE+++++@ -@RET+++++@ FcResult -@FUNC+++++@ FcPatternGetBool -@TYPE1+++++@ FcPattern * @ARG1+++++@ p -@TYPE2+++++@ const char * @ARG2+++++@ object -@TYPE3+++++@ int% @ARG3+++++@ n -@TYPE4+++++@ FcBool * @ARG4+++++@ b +@RET+++++@ FcResult +@FUNC+++++@ FcPatternGetBool +@TYPE1+++++@ FcPattern * @ARG1+++++@ p +@TYPE2+++++@ const char * @ARG2+++++@ object +@TYPE3+++++@ int% @ARG3+++++@ n +@TYPE4+++++@ FcBool * @ARG4+++++@ b @PROTOTYPE++++++@ -@RET++++++@ FcResult -@FUNC++++++@ FcPatternGetFTFace -@TYPE1++++++@ FcPattern * @ARG1++++++@ p -@TYPE2++++++@ const char * @ARG2++++++@ object -@TYPE3++++++@ int% @ARG3++++++@ n -@TYPE4++++++@ FT_Face * @ARG4++++++@ f +@RET++++++@ FcResult +@FUNC++++++@ FcPatternGetFTFace +@TYPE1++++++@ FcPattern * @ARG1++++++@ p +@TYPE2++++++@ const char * @ARG2++++++@ object +@TYPE3++++++@ int% @ARG3++++++@ n +@TYPE4++++++@ FT_Face * @ARG4++++++@ f @PROTOTYPE+++++++@ -@RET+++++++@ FcResult -@FUNC+++++++@ FcPatternGetLangSet -@TYPE1+++++++@ FcPattern * @ARG1+++++++@ p -@TYPE2+++++++@ const char * @ARG2+++++++@ object -@TYPE3+++++++@ int% @ARG3+++++++@ n -@TYPE4+++++++@ FcLangSet ** @ARG4+++++++@ l +@RET+++++++@ FcResult +@FUNC+++++++@ FcPatternGetLangSet +@TYPE1+++++++@ FcPattern * @ARG1+++++++@ p +@TYPE2+++++++@ const char * @ARG2+++++++@ object +@TYPE3+++++++@ int% @ARG3+++++++@ n +@TYPE4+++++++@ FcLangSet ** @ARG4+++++++@ l @PROTOTYPE++++++++@ -@RET++++++++@ FcResult -@FUNC++++++++@ FcPatternGetRange -@TYPE1++++++++@ FcPattern * @ARG1++++++++@ p -@TYPE2++++++++@ const char * @ARG2++++++++@ object -@TYPE3++++++++@ int% @ARG3++++++++@ n -@TYPE4++++++++@ FcRange ** @ARG4++++++++@ r - -@PURPOSE@ Return a typed value from a pattern +@RET++++++++@ FcResult +@FUNC++++++++@ FcPatternGetRange +@TYPE1++++++++@ FcPattern * @ARG1++++++++@ p +@TYPE2++++++++@ const char * @ARG2++++++++@ object +@TYPE3++++++++@ int% @ARG3++++++++@ n +@TYPE4++++++++@ FcRange ** @ARG4++++++++@ r + +@PURPOSE@ Return a typed value from a pattern @DESC@ These are convenience functions that call FcPatternGet and verify that the returned data is of the expected type. They return FcResultTypeMismatch if @@ -322,25 +322,25 @@ in preference to FcPatternGet to provide compile-time typechecking. FcPatternGetRange are available since 2.11.91. @@ -@RET@ FcPattern * -@FUNC@ FcPatternBuild -@TYPE1@ FcPattern * @ARG1@ pattern -@TYPE2@ ... +@RET@ FcPattern * +@FUNC@ FcPatternBuild +@TYPE1@ FcPattern * @ARG1@ pattern +@TYPE2@ ... @PROTOTYPE+@ -@RET+@ FcPattern * -@FUNC+@ FcPatternVaBuild -@TYPE1+@ FcPattern * @ARG1+@ pattern -@TYPE2+@ va_list% @ARG2+@ va +@RET+@ FcPattern * +@FUNC+@ FcPatternVaBuild +@TYPE1+@ FcPattern * @ARG1+@ pattern +@TYPE2+@ va_list% @ARG2+@ va @PROTOTYPE++@ -@RET++@ void -@FUNC++@ FcPatternVapBuild -@TYPE1++@ FcPattern * @ARG1++@ result -@TYPE2++@ FcPattern * @ARG2++@ pattern -@TYPE3++@ va_list% @ARG3++@ va +@RET++@ void +@FUNC++@ FcPatternVapBuild +@TYPE1++@ FcPattern * @ARG1++@ result +@TYPE2++@ FcPattern * @ARG2++@ pattern +@TYPE3++@ va_list% @ARG3++@ va -@PURPOSE@ Create patterns from arguments +@PURPOSE@ Create patterns from arguments @DESC@ Builds a pattern using a list of objects, types and values. Each value to be entered in the pattern is specified with three arguments: @@ -372,141 +372,141 @@ which returns its result directly in the result variable. @@ -@RET@ FcBool -@FUNC@ FcPatternDel -@TYPE1@ FcPattern * @ARG1@ p -@TYPE2@ const char * @ARG2@ object -@PURPOSE@ Delete a property from a pattern +@RET@ FcBool +@FUNC@ FcPatternDel +@TYPE1@ FcPattern * @ARG1@ p +@TYPE2@ const char * @ARG2@ object +@PURPOSE@ Delete a property from a pattern @DESC@ -Deletes all values associated with the property `object', returning +Deletes all values associated with the property `object', returning whether the property existed or not. @@ -@RET@ FcBool -@FUNC@ FcPatternRemove -@TYPE1@ FcPattern * @ARG1@ p -@TYPE2@ const char * @ARG2@ object -@TYPE3@ int% @ARG3@ id -@PURPOSE@ Remove one object of the specified type from the pattern +@RET@ FcBool +@FUNC@ FcPatternRemove +@TYPE1@ FcPattern * @ARG1@ p +@TYPE2@ const char * @ARG2@ object +@TYPE3@ int% @ARG3@ id +@PURPOSE@ Remove one object of the specified type from the pattern @DESC@ -Removes the value associated with the property `object' at position `id', returning +Removes the value associated with the property `object' at position `id', returning whether the property existed and had a value at that position or not. @@ -@RET@ void -@FUNC@ FcPatternIterStart -@TYPE1@ const FcPattern * @ARG1@ p -@TYPE2@ FcPatternIter * @ARG2@ iter -@PURPOSE@ Initialize the iterator with the first iterator in the pattern +@RET@ void +@FUNC@ FcPatternIterStart +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@PURPOSE@ Initialize the iterator with the first iterator in the pattern @DESC@ Initialize iter with the first iterator in p. If there are no objects in p, iter will not have any valid data. -@SINCE@ 2.13.1 +@SINCE@ 2.13.1 @@ -@RET@ FcBool -@FUNC@ FcPatternIterNext -@TYPE1@ const FcPattern * @ARG1@ p -@TYPE2@ FcPatternIter * @ARG2@ iter -@PURPUSE@ Set the iterator to point to the next object in the pattern +@RET@ FcBool +@FUNC@ FcPatternIterNext +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@PURPUSE@ Set the iterator to point to the next object in the pattern @DESC@ Set iter to point to the next object in p and returns FcTrue if iter has been changed to the next object. returns FcFalse otherwise. -@SINCE@ 2.13.1 +@SINCE@ 2.13.1 @@ -@RET@ FcBool -@FUNC@ FcPatternIterEqual -@TYPE1@ const FcPattern * @ARG1@ p1 -@TYPE2@ FcPatternIter * @ARG2@ i1 -@TYPE3@ const FcPattern * @ARG3@ p2 -@TYPE4@ FcPatternIter * @ARG4@ i2 -@PURPOSE@ Compare iterators +@RET@ FcBool +@FUNC@ FcPatternIterEqual +@TYPE1@ const FcPattern * @ARG1@ p1 +@TYPE2@ FcPatternIter * @ARG2@ i1 +@TYPE3@ const FcPattern * @ARG3@ p2 +@TYPE4@ FcPatternIter * @ARG4@ i2 +@PURPOSE@ Compare iterators @DESC@ Return FcTrue if both i1 and i2 point to same object and contains same values. return FcFalse otherwise. -@SINCE@ 2.13.1 +@SINCE@ 2.13.1 @@ -@RET@ FcBool -@FUNC@ FcPatternFindIter -@TYPE1@ const FcPattern * @ARG1@ p -@TYPE2@ FcPatternIter * @ARG2@ iter -@TYPE3@ const char * @ARG3@ object -@PURPOSE@ Set the iterator to point to the object in the pattern +@RET@ FcBool +@FUNC@ FcPatternFindIter +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@TYPE3@ const char * @ARG3@ object +@PURPOSE@ Set the iterator to point to the object in the pattern @DESC@ Set iter to point to object in p if any and returns FcTrue. returns FcFalse otherwise. -@SINCE@ 2.13.1 +@SINCE@ 2.13.1 @@ -@RET@ FcBool -@FUNC@ FcPatternIterIsValid -@TYPE1@ const FcPattern * @ARG1@ p -@TYPE2@ FcPatternIter : @ARG2@ iter -@PURPOSE@ Check whether the iterator is valid or not +@RET@ FcBool +@FUNC@ FcPatternIterIsValid +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter : @ARG2@ iter +@PURPOSE@ Check whether the iterator is valid or not @DESC@ Returns FcTrue if iter point to the valid entry in p. returns FcFalse otherwise. -@SINCE@ 2.13.1 +@SINCE@ 2.13.1 @@ -@RET@ const char * -@FUNC@ FcPatternIterGetObject -@TYPE1@ const FcPattern * @ARG1@ p -@TYPE2@ FcPatternIter * @ARG2@ iter -@PURPOSE@ Returns an object name which the iterator point to +@RET@ const char * +@FUNC@ FcPatternIterGetObject +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@PURPOSE@ Returns an object name which the iterator point to @DESC@ Returns an object name in p which iter point to. returns NULL if iter isn't valid. -@SINCE@ 2.13.1 +@SINCE@ 2.13.1 @@ -@RET@ int -@FUNC@ FcPatternIterValueCount -@TYPE1@ const FcPattern * @ARG1@ p -@TYPE2@ FcPatternIter * @ARG2@ iter -@PURPOSE@ Returns the number of the values which the iterator point to +@RET@ int +@FUNC@ FcPatternIterValueCount +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@PURPOSE@ Returns the number of the values which the iterator point to @DESC@ Returns the number of the values in the object which iter point to. if iter isn't valid, returns 0. -@SINCE@ 2.13.1 +@SINCE@ 2.13.1 @@ -@RET@ FcResult -@FUNC@ FcPatternIterGetValue -@TYPE1@ const FcPattern * @ARG1@ p -@TYPE2@ FcPatternIter * @ARG2@ iter -@TYPE3@ int @ARG3@ id -@TYPE4@ FcValue * @ARG4@ v -@TYPE5@ FcValueBinding * @ARG5@ b -@PURPOSE@ Returns a value which the iterator point to +@RET@ FcResult +@FUNC@ FcPatternIterGetValue +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@TYPE3@ int @ARG3@ id +@TYPE4@ FcValue * @ARG4@ v +@TYPE5@ FcValueBinding * @ARG5@ b +@PURPOSE@ Returns a value which the iterator point to @DESC@ Returns in v the id'th value which iter point to. also binding to b if given. The value returned is not a copy, but rather refers to the data stored within the pattern directly. Applications must not free this value. -@SINCE@ 2.13.1 +@SINCE@ 2.13.1 @@ -@RET@ void -@FUNC@ FcPatternPrint -@TYPE1@ const FcPattern * @ARG1@ p -@PURPOSE@ Print a pattern for debugging +@RET@ void +@FUNC@ FcPatternPrint +@TYPE1@ const FcPattern * @ARG1@ p +@PURPOSE@ Print a pattern for debugging @DESC@ Prints an easily readable version of the pattern to stdout. There is no provision for reparsing data in this format, it's just for diagnostics and debugging. @@ -@RET@ void -@FUNC@ FcDefaultSubstitute -@TYPE1@ FcPattern * @ARG1@ pattern -@PURPOSE@ Perform default substitutions in a pattern +@RET@ void +@FUNC@ FcDefaultSubstitute +@TYPE1@ FcPattern * @ARG1@ pattern +@PURPOSE@ Perform default substitutions in a pattern @DESC@ Supplies default values for underspecified font patterns: @@ -523,18 +523,18 @@ specified point size (default 12), dpi (default 75) and scale (default 1). @@ -@RET@ FcPattern * -@FUNC@ FcNameParse -@TYPE1@ const FcChar8 * @ARG1@ name -@PURPOSE@ Parse a pattern string +@RET@ FcPattern * +@FUNC@ FcNameParse +@TYPE1@ const FcChar8 * @ARG1@ name +@PURPOSE@ Parse a pattern string @DESC@ Converts name from the standard text format described above into a pattern. @@ -@RET@ FcChar8 * -@FUNC@ FcNameUnparse -@TYPE1@ FcPattern * @ARG1@ pat -@PURPOSE@ Convert a pattern back into a string that can be parsed +@RET@ FcChar8 * +@FUNC@ FcNameUnparse +@TYPE1@ FcPattern * @ARG1@ pat +@PURPOSE@ Convert a pattern back into a string that can be parsed @DESC@ Converts the given pattern into the standard text format described above. The return value is not static, but instead refers to newly allocated memory diff --git a/doc/fcrange.fncs b/doc/fcrange.fncs index ba76f65..c7232bf 100644 --- a/doc/fcrange.fncs +++ b/doc/fcrange.fncs @@ -21,55 +21,55 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ FcRange * -@FUNC@ FcRangeCopy -@TYPE1@ const FcRange * @ARG1@ range -@PURPOSE@ Copy a range object +@RET@ FcRange * +@FUNC@ FcRangeCopy +@TYPE1@ const FcRange * @ARG1@ range +@PURPOSE@ Copy a range object @DESC@ FcRangeCopy creates a new FcRange object and populates it with the contents of range. -@SINCE@ 2.11.91 +@SINCE@ 2.11.91 @@ -@RET@ FcRange * -@FUNC@ FcRangeCreateDouble -@TYPE1@ double @ARG1@ begin -@TYPE2@ double @ARG2@ end -@PURPOSE@ create a range object for double +@RET@ FcRange * +@FUNC@ FcRangeCreateDouble +@TYPE1@ double @ARG1@ begin +@TYPE2@ double @ARG2@ end +@PURPOSE@ create a range object for double @DESC@ FcRangeCreateDouble creates a new FcRange object with double sized value. -@SINCE@ 2.11.91 +@SINCE@ 2.11.91 @@ -@RET@ FcRange * -@FUNC@ FcRangeCreateInteger -@TYPE1@ int @ARG1@ begin -@TYPE2@ int @ARG2@ end -@PURPOSE@ create a range object for integer +@RET@ FcRange * +@FUNC@ FcRangeCreateInteger +@TYPE1@ int @ARG1@ begin +@TYPE2@ int @ARG2@ end +@PURPOSE@ create a range object for integer @DESC@ FcRangeCreateInteger creates a new FcRange object with integer sized value. -@SINCE@ 2.11.91 +@SINCE@ 2.11.91 @@ -@RET@ void -@FUNC@ FcRangeDestroy -@TYPE1@ FcRange * @ARG1@ range -@PURPOSE@ destroy a range object +@RET@ void +@FUNC@ FcRangeDestroy +@TYPE1@ FcRange * @ARG1@ range +@PURPOSE@ destroy a range object @DESC@ FcRangeDestroy destroys a FcRange object, freeing all memory associated with it. -@SINCE@ 2.11.91 +@SINCE@ 2.11.91 @@ -@RET@ FcBool -@FUNC@ FcRangeGetDouble -@TYPE1@ const FcRange * @ARG1@ range -@TYPE2@ double * @ARG2@ begin -@TYPE3@ double * @ARG3@ end -@PURPOSE@ Get the range in double +@RET@ FcBool +@FUNC@ FcRangeGetDouble +@TYPE1@ const FcRange * @ARG1@ range +@TYPE2@ double * @ARG2@ begin +@TYPE3@ double * @ARG3@ end +@PURPOSE@ Get the range in double @DESC@ Returns in begin and end as the range. -@SINCE@ 2.11.91 +@SINCE@ 2.11.91 @@ diff --git a/doc/fcstring.fncs b/doc/fcstring.fncs index c2ef457..7be7697 100644 --- a/doc/fcstring.fncs +++ b/doc/fcstring.fncs @@ -23,12 +23,12 @@ */ -@RET@ int -@FUNC@ FcUtf8ToUcs4 -@TYPE1@ FcChar8 * @ARG1@ src -@TYPE2@ FcChar32 * @ARG2@ dst -@TYPE3@ int% @ARG3@ len -@PURPOSE@ convert UTF-8 to UCS4 +@RET@ int +@FUNC@ FcUtf8ToUcs4 +@TYPE1@ FcChar8 * @ARG1@ src +@TYPE2@ FcChar32 * @ARG2@ dst +@TYPE3@ int% @ARG3@ len +@PURPOSE@ convert UTF-8 to UCS4 @DESC@ Converts the next Unicode char from src into dst and returns the number of bytes containing the @@ -36,24 +36,24 @@ char. src must be at least len bytes long. @@ -@RET@ int -@FUNC@ FcUcs4ToUtf8 -@TYPE1@ FcChar32% @ARG1@ src -@TYPE2@ FcChar8% @ARG2@ dst[FC_UTF8_MAX_LEN] -@PURPOSE@ convert UCS4 to UTF-8 +@RET@ int +@FUNC@ FcUcs4ToUtf8 +@TYPE1@ FcChar32% @ARG1@ src +@TYPE2@ FcChar8% @ARG2@ dst[FC_UTF8_MAX_LEN] +@PURPOSE@ convert UCS4 to UTF-8 @DESC@ Converts the Unicode char from src into dst and returns the number of bytes needed to encode the char. @@ -@RET@ FcBool -@FUNC@ FcUtf8Len -@TYPE1@ FcChar8 * @ARG1@ src -@TYPE2@ int% @ARG2@ len -@TYPE3@ int * @ARG3@ nchar -@TYPE4@ int * @ARG4@ wchar -@PURPOSE@ count UTF-8 encoded chars +@RET@ FcBool +@FUNC@ FcUtf8Len +@TYPE1@ FcChar8 * @ARG1@ src +@TYPE2@ int% @ARG2@ len +@TYPE3@ int * @ARG3@ nchar +@TYPE4@ int * @ARG4@ wchar +@PURPOSE@ count UTF-8 encoded chars @DESC@ Counts the number of Unicode chars in len bytes of src. Places that count in @@ -63,13 +63,13 @@ counted. The return value indicates whether src is a well-formed UTF8 string. @@ -@RET@ int -@FUNC@ FcUtf16ToUcs4 -@TYPE1@ FcChar8 * @ARG1@ src -@TYPE2@ FcEndian% @ARG2@ endian -@TYPE3@ FcChar32 * @ARG3@ dst -@TYPE4@ int% @ARG4@ len -@PURPOSE@ convert UTF-16 to UCS4 +@RET@ int +@FUNC@ FcUtf16ToUcs4 +@TYPE1@ FcChar8 * @ARG1@ src +@TYPE2@ FcEndian% @ARG2@ endian +@TYPE3@ FcChar32 * @ARG3@ dst +@TYPE4@ int% @ARG4@ len +@PURPOSE@ convert UTF-16 to UCS4 @DESC@ Converts the next Unicode char from src into dst and returns the number of bytes containing the @@ -78,14 +78,14 @@ bytes long. Bytes of src are combined into 16-bit units according to endian. @@ -@RET@ FcBool -@FUNC@ FcUtf16Len -@TYPE1@ FcChar8 * @ARG1@ src -@TYPE2@ FcEndian% @ARG2@ endian -@TYPE3@ int% @ARG3@ len -@TYPE4@ int * @ARG4@ nchar -@TYPE5@ int * @ARG5@ wchar -@PURPOSE@ count UTF-16 encoded chars +@RET@ FcBool +@FUNC@ FcUtf16Len +@TYPE1@ FcChar8 * @ARG1@ src +@TYPE2@ FcEndian% @ARG2@ endian +@TYPE3@ int% @ARG3@ len +@TYPE4@ int * @ARG4@ nchar +@TYPE5@ int * @ARG5@ wchar +@PURPOSE@ count UTF-16 encoded chars @DESC@ Counts the number of Unicode chars in len bytes of src. Bytes of src are @@ -97,56 +97,56 @@ indicates whether string is a well-formed UTF16 string. @@ -@RET@ FcBool -@FUNC@ FcIsLower -@TYPE1@ FcChar8 @ARG1@ c -@PURPOSE@ check for lower case ASCII character +@RET@ FcBool +@FUNC@ FcIsLower +@TYPE1@ FcChar8 @ARG1@ c +@PURPOSE@ check for lower case ASCII character @DESC@ This macro checks whether c is an lower case ASCII letter. @@ -@RET@ FcBool -@FUNC@ FcIsUpper -@TYPE1@ FcChar8 @ARG1@ c -@PURPOSE@ check for upper case ASCII character +@RET@ FcBool +@FUNC@ FcIsUpper +@TYPE1@ FcChar8 @ARG1@ c +@PURPOSE@ check for upper case ASCII character @DESC@ This macro checks whether c is a upper case ASCII letter. @@ -@RET@ FcChar8 -@FUNC@ FcToLower -@TYPE1@ FcChar8 @ARG1@ c -@PURPOSE@ convert upper case ASCII to lower case +@RET@ FcChar8 +@FUNC@ FcToLower +@TYPE1@ FcChar8 @ARG1@ c +@PURPOSE@ convert upper case ASCII to lower case @DESC@ This macro converts upper case ASCII c to the equivalent lower case letter. @@ -@RET@ FcChar8 * -@FUNC@ FcStrCopy -@TYPE1@ const FcChar8 * @ARG1@ s -@PURPOSE@ duplicate a string +@RET@ FcChar8 * +@FUNC@ FcStrCopy +@TYPE1@ const FcChar8 * @ARG1@ s +@PURPOSE@ duplicate a string @DESC@ Allocates memory, copies s and returns the resulting buffer. Yes, this is strdup, but that function isn't available on every platform. @@ -@RET@ FcChar8 * -@FUNC@ FcStrDowncase -@TYPE1@ const FcChar8 * @ARG1@ s -@PURPOSE@ create a lower case translation of a string +@RET@ FcChar8 * +@FUNC@ FcStrDowncase +@TYPE1@ const FcChar8 * @ARG1@ s +@PURPOSE@ create a lower case translation of a string @DESC@ Allocates memory, copies s, converting upper case letters to lower case and returns the allocated buffer. @@ -@RET@ FcChar8 * -@FUNC@ FcStrCopyFilename -@TYPE1@ const FcChar8 * @ARG1@ s -@PURPOSE@ create a complete path from a filename +@RET@ FcChar8 * +@FUNC@ FcStrCopyFilename +@TYPE1@ const FcChar8 * @ARG1@ s +@PURPOSE@ create a complete path from a filename @DESC@ FcStrCopyFilename constructs an absolute pathname from s. It converts any leading '~' characters in @@ -158,32 +158,32 @@ Returns NULL if '~' is the leading character and HOME is unset or disabled (see FcConfigEnableHome). @@ -@RET@ int -@FUNC@ FcStrCmp -@TYPE1@ const FcChar8 * @ARG1@ s1 -@TYPE2@ const FcChar8 * @ARG2@ s2 -@PURPOSE@ compare UTF-8 strings +@RET@ int +@FUNC@ FcStrCmp +@TYPE1@ const FcChar8 * @ARG1@ s1 +@TYPE2@ const FcChar8 * @ARG2@ s2 +@PURPOSE@ compare UTF-8 strings @DESC@ Returns the usual <0, 0, >0 result of comparing -s1 and s2. +s1 and s2. @@ -@RET@ int -@FUNC@ FcStrCmpIgnoreCase -@TYPE1@ const FcChar8 * @ARG1@ s1 -@TYPE2@ const FcChar8 * @ARG2@ s2 -@PURPOSE@ compare UTF-8 strings ignoring case +@RET@ int +@FUNC@ FcStrCmpIgnoreCase +@TYPE1@ const FcChar8 * @ARG1@ s1 +@TYPE2@ const FcChar8 * @ARG2@ s2 +@PURPOSE@ compare UTF-8 strings ignoring case @DESC@ Returns the usual <0, 0, >0 result of comparing s1 and s2. This test is case-insensitive for all proper UTF-8 encoded strings. @@ -@RET@ FcChar8 * -@FUNC@ FcStrStr -@TYPE1@ const FcChar8 * @ARG1@ s1 -@TYPE2@ const FcChar8 * @ARG2@ s2 -@PURPOSE@ locate UTF-8 substring +@RET@ FcChar8 * +@FUNC@ FcStrStr +@TYPE1@ const FcChar8 * @ARG1@ s1 +@TYPE2@ const FcChar8 * @ARG2@ s2 +@PURPOSE@ locate UTF-8 substring @DESC@ Returns the location of s2 in s1. Returns NULL if s2 @@ -191,43 +191,43 @@ is not present in s1. This test will operate properly with UTF8 encoded strings. @@ -@RET@ FcChar8 * -@FUNC@ FcStrStrIgnoreCase -@TYPE1@ const FcChar8 * @ARG1@ s1 -@TYPE2@ const FcChar8 * @ARG2@ s2 -@PURPOSE@ locate UTF-8 substring ignoring case +@RET@ FcChar8 * +@FUNC@ FcStrStrIgnoreCase +@TYPE1@ const FcChar8 * @ARG1@ s1 +@TYPE2@ const FcChar8 * @ARG2@ s2 +@PURPOSE@ locate UTF-8 substring ignoring case @DESC@ -Returns the location of s2 in +Returns the location of s2 in s1, ignoring case. Returns NULL if s2 is not present in s1. This test is case-insensitive for all proper UTF-8 encoded strings. @@ -@RET@ FcChar8 * -@FUNC@ FcStrPlus -@TYPE1@ const FcChar8 * @ARG1@ s1 -@TYPE2@ const FcChar8 * @ARG2@ s2 -@PURPOSE@ concatenate two strings +@RET@ FcChar8 * +@FUNC@ FcStrPlus +@TYPE1@ const FcChar8 * @ARG1@ s1 +@TYPE2@ const FcChar8 * @ARG2@ s2 +@PURPOSE@ concatenate two strings @DESC@ This function allocates new storage and places the concatenation of s1 and s2 there, returning the new string. @@ -@RET@ void -@FUNC@ FcStrFree -@TYPE1@ FcChar8 * @ARG1@ s -@PURPOSE@ free a string +@RET@ void +@FUNC@ FcStrFree +@TYPE1@ FcChar8 * @ARG1@ s +@PURPOSE@ free a string @DESC@ This is just a wrapper around free(3) which helps track memory usage of strings within the fontconfig library. @@ -@RET@ FcChar8 * -@FUNC@ FcStrBuildFilename -@TYPE1@ const FcChar8 * @ARG1@ path -@TYPE2@ ... -@PURPOSE@ Concatenate strings as a file path +@RET@ FcChar8 * +@FUNC@ FcStrBuildFilename +@TYPE1@ const FcChar8 * @ARG1@ path +@TYPE2@ ... +@PURPOSE@ Concatenate strings as a file path @DESC@ Creates a filename from the given elements of strings as file paths and concatenate them with the appropriate file separator. @@ -235,20 +235,20 @@ Arguments must be null-terminated. This returns a newly-allocated memory which should be freed when no longer needed. @@ -@RET@ FcChar8 * -@FUNC@ FcStrDirname -@TYPE1@ const FcChar8 * @ARG1@ file -@PURPOSE@ directory part of filename +@RET@ FcChar8 * +@FUNC@ FcStrDirname +@TYPE1@ const FcChar8 * @ARG1@ file +@PURPOSE@ directory part of filename @DESC@ Returns the directory containing file. This is returned in newly allocated storage which should be freed when no longer needed. @@ -@RET@ FcChar8 * -@FUNC@ FcStrBasename -@TYPE1@ const FcChar8 * @ARG1@ file -@PURPOSE@ last component of filename +@RET@ FcChar8 * +@FUNC@ FcStrBasename +@TYPE1@ const FcChar8 * @ARG1@ file +@PURPOSE@ last component of filename @DESC@ Returns the filename of file stripped of any leading directory names. This is returned in newly allocated storage which should diff --git a/doc/fcstrset.fncs b/doc/fcstrset.fncs index 67aa61a..66a5136 100644 --- a/doc/fcstrset.fncs +++ b/doc/fcstrset.fncs @@ -23,102 +23,102 @@ */ -@RET@ FcStrSet * -@FUNC@ FcStrSetCreate -@TYPE1@ void -@PURPOSE@ create a string set +@RET@ FcStrSet * +@FUNC@ FcStrSetCreate +@TYPE1@ void +@PURPOSE@ create a string set @DESC@ Create an empty set. @@ -@RET@ FcBool -@FUNC@ FcStrSetMember -@TYPE1@ FcStrSet * @ARG1@ set -@TYPE2@ const FcChar8 * @ARG2@ s -@PURPOSE@ check set for membership +@RET@ FcBool +@FUNC@ FcStrSetMember +@TYPE1@ FcStrSet * @ARG1@ set +@TYPE2@ const FcChar8 * @ARG2@ s +@PURPOSE@ check set for membership @DESC@ Returns whether s is a member of set. @@ -@RET@ FcBool -@FUNC@ FcStrSetEqual -@TYPE1@ FcStrSet * @ARG1@ set_a -@TYPE2@ FcStrSet * @ARG2@ set_b -@PURPOSE@ check sets for equality +@RET@ FcBool +@FUNC@ FcStrSetEqual +@TYPE1@ FcStrSet * @ARG1@ set_a +@TYPE2@ FcStrSet * @ARG2@ set_b +@PURPOSE@ check sets for equality @DESC@ Returns whether set_a contains precisely the same strings as set_b. Ordering of strings within the two sets is not considered. @@ -@RET@ FcBool -@FUNC@ FcStrSetAdd -@TYPE1@ FcStrSet * @ARG1@ set -@TYPE2@ const FcChar8 * @ARG2@ s -@PURPOSE@ add to a string set +@RET@ FcBool +@FUNC@ FcStrSetAdd +@TYPE1@ FcStrSet * @ARG1@ set +@TYPE2@ const FcChar8 * @ARG2@ s +@PURPOSE@ add to a string set @DESC@ Adds a copy of s to set. @@ -@RET@ FcBool -@FUNC@ FcStrSetAddFilename -@TYPE1@ FcStrSet * @ARG1@ set -@TYPE2@ const FcChar8 * @ARG2@ s -@PURPOSE@ add a filename to a string set +@RET@ FcBool +@FUNC@ FcStrSetAddFilename +@TYPE1@ FcStrSet * @ARG1@ set +@TYPE2@ const FcChar8 * @ARG2@ s +@PURPOSE@ add a filename to a string set @DESC@ Adds a copy s to set, The copy is created with FcStrCopyFilename so that leading '~' values are replaced with the value of the HOME environment variable. @@ -@RET@ FcBool -@FUNC@ FcStrSetDel -@TYPE1@ FcStrSet * @ARG1@ set -@TYPE2@ const FcChar8 * @ARG2@ s -@PURPOSE@ delete from a string set +@RET@ FcBool +@FUNC@ FcStrSetDel +@TYPE1@ FcStrSet * @ARG1@ set +@TYPE2@ const FcChar8 * @ARG2@ s +@PURPOSE@ delete from a string set @DESC@ Removes s from set, returning FcTrue if s was a member else FcFalse. @@ -@RET@ void -@FUNC@ FcStrSetDestroy -@TYPE1@ FcStrSet * @ARG1@ set -@PURPOSE@ destroy a string set +@RET@ void +@FUNC@ FcStrSetDestroy +@TYPE1@ FcStrSet * @ARG1@ set +@PURPOSE@ destroy a string set @DESC@ Destroys set. @@ -@RET@ FcStrList * -@FUNC@ FcStrListCreate -@TYPE1@ FcStrSet * @ARG1@ set -@PURPOSE@ create a string iterator +@RET@ FcStrList * +@FUNC@ FcStrListCreate +@TYPE1@ FcStrSet * @ARG1@ set +@PURPOSE@ create a string iterator @DESC@ Creates an iterator to list the strings in set. @@ -@RET@ void -@FUNC@ FcStrListFirst -@TYPE1@ FcStrList * @ARG1@ list -@PURPOSE@ get first string in iteration +@RET@ void +@FUNC@ FcStrListFirst +@TYPE1@ FcStrList * @ARG1@ list +@PURPOSE@ get first string in iteration @DESC@ Returns the first string in list. -@SINCE@ 2.11.0 +@SINCE@ 2.11.0 @@ -@RET@ FcChar8 * -@FUNC@ FcStrListNext -@TYPE1@ FcStrList * @ARG1@ list -@PURPOSE@ get next string in iteration +@RET@ FcChar8 * +@FUNC@ FcStrListNext +@TYPE1@ FcStrList * @ARG1@ list +@PURPOSE@ get next string in iteration @DESC@ Returns the next string in list. @@ -@RET@ void -@FUNC@ FcStrListDone -@TYPE1@ FcStrList * @ARG1@ list -@PURPOSE@ destroy a string iterator +@RET@ void +@FUNC@ FcStrListDone +@TYPE1@ FcStrList * @ARG1@ list +@PURPOSE@ destroy a string iterator @DESC@ Destroys the enumerator list. @@ diff --git a/doc/fcvalue.fncs b/doc/fcvalue.fncs index 83a5b3a..a903988 100644 --- a/doc/fcvalue.fncs +++ b/doc/fcvalue.fncs @@ -21,39 +21,39 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ void -@FUNC@ FcValueDestroy -@TYPE1@ FcValue% @ARG1@ v -@PURPOSE@ Free a value +@RET@ void +@FUNC@ FcValueDestroy +@TYPE1@ FcValue% @ARG1@ v +@PURPOSE@ Free a value @DESC@ Frees any memory referenced by v. Values of type FcTypeString, FcTypeMatrix and FcTypeCharSet reference memory, the other types do not. @@ -@RET@ FcValue -@FUNC@ FcValueSave -@TYPE1@ FcValue% @ARG1@ v -@PURPOSE@ Copy a value +@RET@ FcValue +@FUNC@ FcValueSave +@TYPE1@ FcValue% @ARG1@ v +@PURPOSE@ Copy a value @DESC@ Returns a copy of v duplicating any object referenced by it so that v may be safely destroyed without harming the new value. @@ -@RET@ void -@FUNC@ FcValuePrint -@TYPE1@ FcValue% @ARG1@ v -@PURPOSE@ Print a value to stdout +@RET@ void +@FUNC@ FcValuePrint +@TYPE1@ FcValue% @ARG1@ v +@PURPOSE@ Print a value to stdout @DESC@ Prints a human-readable representation of v to stdout. The format should not be considered part of the library specification as it may change in the future. @@ -@RET@ FcBool -@FUNC@ FcValueEqual -@TYPE1@ FcValue% @ARG1@ v_a -@TYPE2@ FcValue% @ARG2@ v_b -@PURPOSE@ Test two values for equality +@RET@ FcBool +@FUNC@ FcValueEqual +@TYPE1@ FcValue% @ARG1@ v_a +@TYPE2@ FcValue% @ARG2@ v_b +@PURPOSE@ Test two values for equality @DESC@ Compares two values. Integers and Doubles are compared as numbers; otherwise the two values have to be the same type to be considered equal. Strings are diff --git a/doc/fcweight.fncs b/doc/fcweight.fncs index 5bb9429..a3668d9 100644 --- a/doc/fcweight.fncs +++ b/doc/fcweight.fncs @@ -19,10 +19,10 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -@RET@ double -@FUNC@ FcWeightFromOpenTypeDouble -@TYPE1@ double @ARG1@ ot_weight -@PURPOSE@ Convert from OpenType weight values to fontconfig ones +@RET@ double +@FUNC@ FcWeightFromOpenTypeDouble +@TYPE1@ double @ARG1@ ot_weight +@PURPOSE@ Convert from OpenType weight values to fontconfig ones @DESC@ FcWeightFromOpenTypeDouble returns an double value to use with FC_WEIGHT, from an double in the 1..1000 range, resembling @@ -31,39 +31,39 @@ are also similar to CSS font-weight numbers. If input is negative, zero, or greater than 1000, returns -1. This function linearly interpolates between various FC_WEIGHT_* constants. As such, the returned value does not necessarily match any of the predefined constants. -@SINCE@ 2.12.92 +@SINCE@ 2.12.92 @@ -@RET@ double -@FUNC@ FcWeightToOpenTypeDouble -@TYPE1@ double @ARG1@ ot_weight -@PURPOSE@ Convert from fontconfig weight values to OpenType ones +@RET@ double +@FUNC@ FcWeightToOpenTypeDouble +@TYPE1@ double @ARG1@ ot_weight +@PURPOSE@ Convert from fontconfig weight values to OpenType ones @DESC@ FcWeightToOpenTypeDouble is the inverse of FcWeightFromOpenType. If the input is less than FC_WEIGHT_THIN or greater than FC_WEIGHT_EXTRABLACK, returns -1. Otherwise returns a number in the range 1 to 1000. -@SINCE@ 2.12.92 +@SINCE@ 2.12.92 @@ -@RET@ int -@FUNC@ FcWeightFromOpenType -@TYPE1@ int @ARG1@ ot_weight -@PURPOSE@ Convert from OpenType weight values to fontconfig ones +@RET@ int +@FUNC@ FcWeightFromOpenType +@TYPE1@ int @ARG1@ ot_weight +@PURPOSE@ Convert from OpenType weight values to fontconfig ones @DESC@ FcWeightFromOpenType is like FcWeightFromOpenTypeDouble but with integer arguments. Use the other function instead. -@SINCE@ 2.11.91 +@SINCE@ 2.11.91 @@ -@RET@ int -@FUNC@ FcWeightToOpenType -@TYPE1@ int @ARG1@ ot_weight -@PURPOSE@ Convert from fontconfig weight values to OpenType ones +@RET@ int +@FUNC@ FcWeightToOpenType +@TYPE1@ int @ARG1@ ot_weight +@PURPOSE@ Convert from fontconfig weight values to OpenType ones @DESC@ FcWeightToOpenType is like FcWeightToOpenTypeDouble but with integer arguments. Use the other function instead. -@SINCE@ 2.11.91 +@SINCE@ 2.11.91 @@ diff --git a/doc/fontconfig-devel.sgml b/doc/fontconfig-devel.sgml index a1ec613..921cb6c 100644 --- a/doc/fontconfig-devel.sgml +++ b/doc/fontconfig-devel.sgml @@ -25,9 +25,9 @@ ]>
- Fontconfig Developers Reference, Version &version; - - - Keith - Packard - - HP Cambridge Research Lab - - - KRP - Fontconfig - &version; - - + Fontconfig Developers Reference, Version &version; + + + Keith + Packard + + HP Cambridge Research Lab + + + KRP + Fontconfig + &version; + + Copyright © 2002 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 the above copyright notice appear in all copies and that both that @@ -72,7 +72,7 @@ advertising or publicity pertaining to distribution of the software without 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. - + THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR @@ -80,9 +80,9 @@ 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 PERFORMANCE OF THIS SOFTWARE. - - - + + + DESCRIPTION Fontconfig is a library designed to provide system-wide font configuration, @@ -103,7 +103,7 @@ data found within. From an external perspective, configuration of the library consists of generating a valid XML tree and feeding that to FcConfigParse. The only other mechanism provided to applications for changing the running configuration is to add fonts and directories to the -list of application-provided font files. +list of application-provided font files. The intent is to make font configurations relatively static, and shared by as many applications as possible. It is hoped that this will lead to more @@ -284,9 +284,9 @@ types. The 'type' tag indicates which member is valid. double d; const FcMatrix *m; const FcCharSet *c; - void *f; - const FcLangSet *l; - const FcRange *r; + void *f; + const FcLangSet *l; + const FcRange *r; } u; } FcValue; @@ -302,9 +302,9 @@ types. The 'type' tag indicates which member is valid. FcTypeBool b b FcTypeMatrix m FcMatrix * FcTypeCharSet c FcCharSet * - FcTypeFTFace f void * (FT_Face) - FcTypeLangSet l FcLangSet * - FcTypeRange r FcRange * + FcTypeFTFace f void * (FT_Face) + FcTypeLangSet l FcLangSet * + FcTypeRange r FcRange * @@ -497,7 +497,7 @@ functions. FcValue FcValue is a structure containing a type tag and a union of all possible -datatypes. The tag is an enum of type +datatypes. The tag is an enum of type FcType and is intended to provide a measure of run-time typechecking, although that depends on careful programming. diff --git a/doc/fontconfig-user.sgml b/doc/fontconfig-user.sgml index aa61469..16e98aa 100644 --- a/doc/fontconfig-user.sgml +++ b/doc/fontconfig-user.sgml @@ -4,7 +4,7 @@ ]>