walkero
/
fontconfig
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Use <parameter> tags. Add copyrights

This commit is contained in:
Keith Packard 2003-03-07 08:51:14 +00:00
parent bfc2dc3ac4
commit 2df0c66230
5 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/fcconfig.fncs
View File

@ -44,7 +44,7 @@ in an indeterminate state.
@TYPE1@ FcConfig * @ARG1@ config @TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Set configuration as default @PURPOSE@ Set configuration as default
@DESC@ @DESC@
Sets the current default configuration to 'config'. Implicitly calls Sets the current default configuration to <parameter>config</parameter>. Implicitly calls
FcConfigBuildFonts if necessary, returning FcFalse if that call fails. FcConfigBuildFonts if necessary, returning FcFalse if that call fails.
@@ @@
@ -61,7 +61,7 @@ Returns the current default configuration.
@TYPE1@ FcConfig * @ARG1@ config @TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Check timestamps on config files @PURPOSE@ Check timestamps on config files
@DESC@ @DESC@
Checks all of the files related to 'config' and returns whether the Checks all of the files related to <parameter>config</parameter> and returns whether the
in-memory version is in sync with the disk version. in-memory version is in sync with the disk version.
@@ @@
@ -81,7 +81,7 @@ Returns FcFalse if this operation runs out of memory.
@PURPOSE@ Get config directories @PURPOSE@ Get config directories
@DESC@ @DESC@
Returns the list of font directories specified in the configuration files Returns the list of font directories specified in the configuration files
for 'config'. Does not include any subdirectories. for <parameter>config</parameter>. Does not include any subdirectories.
@@ @@
@RET@ FcStrList * @RET@ FcStrList *
@ -89,7 +89,7 @@ for 'config'. Does not include any subdirectories.
@TYPE1@ FcConfig * @ARG1@ config @TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get font directories @PURPOSE@ Get font directories
@DESC@ @DESC@
Returns the list of font directories in 'config'. This includes the Returns the list of font directories in <parameter>config</parameter>. This includes the
configured font directories along with any directories below those in the configured font directories along with any directories below those in the
filesystem. filesystem.
@@ @@
@ -99,7 +99,7 @@ filesystem.
@TYPE1@ FcConfig * @ARG1@ config @TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get config files @PURPOSE@ Get config files
@DESC@ @DESC@
Returns the list of known configuration files used to generate 'config'. Returns the list of known configuration files used to generate <parameter>config</parameter>.
Note that this will not include any configuration done with FcConfigParse. Note that this will not include any configuration done with FcConfigParse.
@@ @@
@ -118,7 +118,7 @@ Returns the name of the file used to store per-user font information.
@PURPOSE@ Get config font set @PURPOSE@ Get config font set
@DESC@ @DESC@
Returns one of the two sets of fonts from the configuration as specified Returns one of the two sets of fonts from the configuration as specified
by 'set'. by <parameter>set</parameter>.
@@ @@
@RET@ FcBlanks * @RET@ FcBlanks *
@ -136,7 +136,7 @@ blanks were present in the configuration, this function will return 0.
@PURPOSE@ Get config rescan interval @PURPOSE@ Get config rescan interval
@DESC@ @DESC@
Returns the interval between automatic checks of the configuration (in Returns the interval between automatic checks of the configuration (in
seconds) specified in 'config'. The configuration is checked during seconds) specified in <parameter>config</parameter>. The configuration is checked during
a call to FcFontList when this interval has passed since the last check. a call to FcFontList when this interval has passed since the last check.
@@ @@
@ -184,9 +184,9 @@ Clears the set of application-specific fonts.
@TYPE4@ FcMatchKind @ARG4@ kind @TYPE4@ FcMatchKind @ARG4@ kind
@PURPOSE@ Execute substitutions @PURPOSE@ Execute substitutions
@DESC@ @DESC@
Performs the sequence of pattern modification operations, if 'kind' is Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
FcMatchPattern, then those tagged as pattern operations are applied, else FcMatchPattern, then those tagged as pattern operations are applied, else
if 'kind' is FcMatchFont, those tagged as font operations are applied and if <parameter>kind</parameter> is FcMatchFont, those tagged as font operations are applied and
p_pat is used for &lt;test&gt; elements with target=pattern. p_pat is used for &lt;test&gt; elements with target=pattern.
@@ @@
@ -207,9 +207,9 @@ Calls FcConfigSubstituteWithPat setting p_pat to NULL.
@TYPE3@ FcResult * @ARG3@ result @TYPE3@ FcResult * @ARG3@ result
@PURPOSE@ Return best font @PURPOSE@ Return best font
@DESC@ @DESC@
Returns the font in 'config' most close matching 'p'. This function Returns the font in <parameter>config</parameter> most close matching <parameter>p</parameter>. This function
should be called only after FcConfigSubstitute and FcDefaultSubstitute have should be called only after FcConfigSubstitute and FcDefaultSubstitute have
been called for 'p'; otherwise the results will not be correct. been called for <parameter>p</parameter>; otherwise the results will not be correct.
@@ @@
@RET@ FcFontSet * @RET@ FcFontSet *
@ -221,16 +221,16 @@ been called for 'p'; otherwise the results will not be correct.
@TYPE5@ FcResult * @ARG5@ result @TYPE5@ FcResult * @ARG5@ result
@PURPOSE@ Return list of matching fonts @PURPOSE@ Return list of matching fonts
@DESC@ @DESC@
Returns the list of fonts sorted by closeness to 'p'. If 'trim' is FcTrue, Returns the list of fonts sorted by closeness to <parameter>p</parameter>. If <parameter>trim</parameter> is FcTrue,
elements in the list which don't include Unicode coverage not provided by 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 earlier elements in the list are elided. The union of Unicode coverage of
all of the fonts is returned in 'csp', if 'csp' is not NULL. This function all of the fonts is returned in <parameter>csp</parameter>, if <parameter>csp</parameter> is not NULL. This function
should be called only after FcConfigSubstitute and FcDefaultSubstitute have should be called only after FcConfigSubstitute and FcDefaultSubstitute have
been called for 'p'; otherwise the results will not be correct. been called for <parameter>p</parameter>; otherwise the results will not be correct.
</para><para> </para><para>
The returned FcFontSet references FcPattern structures which may be shared The returned FcFontSet references FcPattern structures which may be shared
by the return value from multiple FcFontSort calls, applications must not by the return value from multiple FcFontSort calls, applications must not
modify these patterns. Instead, they should be passed, along with 'p' to modify these patterns. Instead, they should be passed, along with <parameter>p</parameter> to
FcFontRenderPrepare which combines them into a complete pattern. FcFontRenderPrepare which combines them into a complete pattern.
</para><para> </para><para>
The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy. The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
@ -243,10 +243,10 @@ The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
@TYPE3@ FcPattern * @ARG3@ font @TYPE3@ FcPattern * @ARG3@ font
@PURPOSE@ Prepare pattern for loading font file @PURPOSE@ Prepare pattern for loading font file
@DESC@ @DESC@
Creates a new pattern consisting of elements of 'font' not appearing Creates a new pattern consisting of elements of <parameter>font</parameter> not appearing
in 'pat', elements of 'pat' not appearing in 'font' and the best matching in <parameter>pat</parameter>, elements of <parameter>pat</parameter> not appearing in <parameter>font</parameter> and the best matching
value from 'pat' for elements appearing in both. The result is passed to value from <parameter>pat</parameter> for elements appearing in both. The result is passed to
FcConfigSubstitute with 'kind' FcMatchFont and then returned. FcConfigSubstitute with <parameter>kind</parameter> FcMatchFont and then returned.
@@ @@
@RET@ FcFontSet * @RET@ FcFontSet *
@ -256,8 +256,8 @@ FcConfigSubstitute with 'kind' FcMatchFont and then returned.
@TYPE3@ FcObjectSet * @ARG3@ os @TYPE3@ FcObjectSet * @ARG3@ os
@PURPOSE@ List fonts @PURPOSE@ List fonts
@DESC@ @DESC@
Selects fonts matching 'p', creates patterns from those fonts containing Selects fonts matching <parameter>p</parameter>, creates patterns from those fonts containing
only the objects in 'os' and returns the set of unique such patterns. only the objects in <parameter>os</parameter> and returns the set of unique such patterns.
@@ @@
@RET@ char * @RET@ char *
@ -269,9 +269,9 @@ Given the specified external entity name, return the associated filename.
This provides applications a way to convert various configuration file This provides applications a way to convert various configuration file
references into filename form. references into filename form.
</para><para> </para><para>
A null or empty 'name' indicates that the default configuration file should A null or empty <parameter>name</parameter> indicates that the default configuration file should
be used; which file this references can be overridden with the be used; which file this references can be overridden with the
FC_CONFIG_FILE environment variable. Next, if the name starts with '~', it FC_CONFIG_FILE environment variable. Next, if the name starts with <parameter>~</parameter>, it
refers to a file in the current users home directory. Otherwise if the name refers to a file in the current users home directory. Otherwise if the name
doesn't start with '/', it refers to a file in the default configuration doesn't start with '/', it refers to a file in the default configuration
directory; the built-in default directory can be overridden with the directory; the built-in default directory can be overridden with the

10
doc/fcconstant.fncs
View File

@ -27,7 +27,7 @@
@TYPE2@ int @ARG2@ nconsts @TYPE2@ int @ARG2@ nconsts
@PURPOSE@ Register symbolic constants @PURPOSE@ Register symbolic constants
@DESC@ @DESC@
Register 'nconsts' new symbolic constants. Register <parameter>nconsts</parameter> new symbolic constants.
@@ @@
@RET@ FcBool @RET@ FcBool
@ -36,7 +36,7 @@ Register 'nconsts' new symbolic constants.
@TYPE2@ int @ARG2@ nconsts @TYPE2@ int @ARG2@ nconsts
@PURPOSE@ Unregister symbolic constants @PURPOSE@ Unregister symbolic constants
@DESC@ @DESC@
Unregister 'nconsts' symbolic constants. Unregister <parameter>nconsts</parameter> symbolic constants.
@@ @@
@RET@ const FcConstant * @RET@ const FcConstant *
@ -44,7 +44,7 @@ Unregister 'nconsts' symbolic constants.
@TYPE1@ FcChar8 * @ARG1@ string @TYPE1@ FcChar8 * @ARG1@ string
@PURPOSE@ Lookup symbolic constant @PURPOSE@ Lookup symbolic constant
@DESC@ @DESC@
Return the FcConstant structure related to symbolic constant 'string'. Return the FcConstant structure related to symbolic constant <parameter>string</parameter>.
@@ @@
@RET@ FcBool @RET@ FcBool
@ -53,6 +53,6 @@ Return the FcConstant structure related to symbolic constant 'string'.
@TYPE2@ int * @ARG2@ result @TYPE2@ int * @ARG2@ result
@PURPOSE@ Get the value for a symbolic constant @PURPOSE@ Get the value for a symbolic constant
@DESC@ @DESC@
Returns whether a symbolic constant with name 'string' is registered, Returns whether a symbolic constant with name <parameter>string</parameter> is registered,
placing the value of the constant in 'result' if present. placing the value of the constant in <parameter>result</parameter> if present.
@@ @@

6
doc/fcobjecttype.fncs
View File

@ -27,7 +27,7 @@
@TYPE2@ int @ARG2@ ntype @TYPE2@ int @ARG2@ ntype
@PURPOSE@ Register object types @PURPOSE@ Register object types
@DESC@ @DESC@
Register 'ntype' new object types. Register <parameter>ntype</parameter> new object types.
@@ @@
@RET@ FcBool @RET@ FcBool
@ -36,7 +36,7 @@ Register 'ntype' new object types.
@TYPE2@ int @ARG2@ ntype @TYPE2@ int @ARG2@ ntype
@PURPOSE@ Unregister object types @PURPOSE@ Unregister object types
@DESC@ @DESC@
Unregister 'ntype' object types. Unregister <parameter>ntype</parameter> object types.
@@ @@
@RET@ const FcObjectType * @RET@ const FcObjectType *
@ -44,5 +44,5 @@ Unregister 'ntype' object types.
@TYPE1@ const char * @ARG1@ object @TYPE1@ const char * @ARG1@ object
@PURPOSE@ Lookup an object type @PURPOSE@ Lookup an object type
@DESC@ @DESC@
Return the object type for the pattern element named 'object'. Return the object type for the pattern element named <parameter>object</parameter>.
@@ @@

14
doc/fcpattern.fncs
View File

@ -43,7 +43,7 @@ Destroys a pattern, in the process destroying all related values.
@TYPE2@ const FcPattern * @ARG2@ pb @TYPE2@ const FcPattern * @ARG2@ pb
@PURPOSE@ Compare patterns @PURPOSE@ Compare patterns
@DESC@ @DESC@
Returns whether 'pa' and 'pb' are exactly alike. Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> are exactly alike.
@@ @@
@RET@ FcBool @RET@ FcBool
@ -53,8 +53,8 @@ Returns whether 'pa' and 'pb' are exactly alike.
@TYPE3@ const FcObjectSet * @ARG3@ os @TYPE3@ const FcObjectSet * @ARG3@ os
@PURPOSE@ Compare portions of patterns @PURPOSE@ Compare portions of patterns
@DESC@ @DESC@
Returns whether 'pa' and 'pb' have exactly the same values for all of the Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> have exactly the same values for all of the
objects in 'os'. objects in <parameter>os</parameter>.
@@ @@
@RET@ FcChar32 @RET@ FcChar32
@ -75,7 +75,7 @@ equal.
@PURPOSE@ Add a value to a pattern @PURPOSE@ Add a value to a pattern
@DESC@ @DESC@
Adds a single value to the list of values associated with the property named 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 `object<parameter>. If `append</parameter> is FcTrue, the value is added at the end of any
existing list, otherwise it is inserted at the begining. `value' is saved existing list, otherwise it is inserted at the begining. `value' is saved
(with FcValueSave) when inserted into the pattern so that the library (with FcValueSave) when inserted into the pattern so that the library
retains no reference to any application-supplied data structure. retains no reference to any application-supplied data structure.
@ -90,7 +90,7 @@ retains no reference to any application-supplied data structure.
@PURPOSE@ Add a value to a pattern with weak binding @PURPOSE@ Add a value to a pattern with weak binding
@DESC@ @DESC@
FcPatternAddWeak is essentially the same as FcPatternAdd except that any FcPatternAddWeak is essentially the same as FcPatternAdd except that any
values added to the list have binding 'weak' instead of 'strong'. values added to the list have binding <parameter>weak</parameter> instead of <parameter>strong</parameter>.
@@ @@
@TITLE@ FcPatternAdd-Type @TITLE@ FcPatternAdd-Type
@ -150,7 +150,7 @@ any existing list of values.
@TYPE4@ FcValue * @ARG4@ v @TYPE4@ FcValue * @ARG4@ v
@PURPOSE@ Return a value from a pattern @PURPOSE@ Return a value from a pattern
@DESC@ @DESC@
Returns in `v' the `id'th value associated with the property `object'. Returns in `v<parameter> the `id</parameter>th value associated with the property `object'.
The value returned is not a copy, but rather refers to the data stored The value returned is not a copy, but rather refers to the data stored
within the pattern directly. Applications must not free this value. within the pattern directly. Applications must not free this value.
@@ @@
@ -296,7 +296,7 @@ specified point size (default 12), dpi (default 75) and scale (default 1).
@TYPE1@ const char * @ARG1@ name @TYPE1@ const char * @ARG1@ name
@PURPOSE@ Parse a pattern string @PURPOSE@ Parse a pattern string
@DESC@ @DESC@
Converts 'name' from the standard text format described above into a pattern. Converts <parameter>name</parameter> from the standard text format described above into a pattern.
@@ @@
@RET@ FcChar8 * @RET@ FcChar8 *

4
doc/fcvalue.fncs
View File

@ -26,7 +26,7 @@
@TYPE1@ FcValue @ARG1@ v @TYPE1@ FcValue @ARG1@ v
@PURPOSE@ Free a value @PURPOSE@ Free a value
@DESC@ @DESC@
Frees any memory referenced by `v'. Values of type FcTypeString, Frees any memory referenced by <parameter>v</parameter>. Values of type FcTypeString,
FcTypeMatrix and FcTypeCharSet reference memory, the other types do not. FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
@@ @@
@ -35,6 +35,6 @@ FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
@TYPE1@ FcValue @ARG1@ v @TYPE1@ FcValue @ARG1@ v
@PURPOSE@ Copy a value @PURPOSE@ Copy a value
@DESC@ @DESC@
Returns a copy of `v' duplicating any object referenced by it so that `v' Returns a copy of <parameter>v</parameter> duplicating any object referenced by it so that <parameter>v</parameter>
may be safely destroyed without harming the new value. may be safely destroyed without harming the new value.
@@ @@