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

Add space between type and formal in devel man pages (bug 8935) 

Most parameters are pointers and have '*' in the type; for those
which do not, use '%' to mark where a space needs to be inserted.
This commit is contained in:
Keith Packard 2006-12-02 15:06:13 -08:00
parent b1aa20098f
commit 61895ed16c
13 changed files with 62 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/edit-sgml.c
View File

@ -294,6 +294,11 @@ ReplaceRead (FILE *f)
ungetc (c, f);
while (isspace (StringLast (r->text)))
StringDel (r->text);
if (StringLast(r->text) == '%')
{
StringDel (r->text);
StringAdd (r->text, ' ');
}
return r;
}

4
doc/fcblanks.fncs
View File

@ -40,7 +40,7 @@ Destroys an FcBlanks object, freeing any associated memory.
@RET@ FcBool
@FUNC@ FcBlanksAdd
@TYPE1@ FcBlanks * @ARG1@ b
@TYPE2@ FcChar32 @ARG2@ ucs4
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Add a character to an FcBlanks
@DESC@
Adds a single character to an FcBlanks object, returning FcFalse
@ -50,7 +50,7 @@ if this process ran out of memory.
@RET@ FcBool
@FUNC@ FcBlanksIsMember
@TYPE1@ FcBlanks * @ARG1@ b
@TYPE2@ FcChar32 @ARG2@ ucs4
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Query membership in an FcBlanks
@DESC@
Returns whether the specified FcBlanks object contains the indicated Unicode

8
doc/fccharset.fncs
View File

@ -43,7 +43,7 @@ memory referenced is freed.
@RET@ FcBool
@FUNC@ FcCharSetAddChar
@TYPE1@ FcCharSet * @ARG1@ fcs
@TYPE2@ FcChar32 @ARG2@ ucs4
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Add a character to a charset
@DESC@
<function>FcCharSetAddChar</function> adds a single unicode char to the set,
@ -101,7 +101,7 @@ Returns a set including only those chars found in <parameter>a</parameter> but n
@RET@ FcBool
@FUNC@ FcCharSetHasChar
@TYPE1@ const FcCharSet * @ARG1@ fcs
@TYPE2@ FcChar32 @ARG2@ ucs4
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Check a charset for a char
@DESC@
Returns whether <parameter>fcs</parameter> contains the char <parameter>ucs4</parameter>.
@ -145,7 +145,7 @@ Returns whether <parameter>a</parameter> is a subset of <parameter>b</parameter>
@RET@ FcChar32
@FUNC@ FcCharSetFirstPage
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE] @ARG2@ map
@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE]% @ARG2@ map
@TYPE3@ FcChar32 * @ARG3@ next
@PURPOSE@ Start enumerating charset contents
@DESC@
@ -157,7 +157,7 @@ font.
@RET@ FcChar32
@FUNC@ FcCharSetNextPage
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE] @ARG2@ map
@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE]% @ARG2@ map
@TYPE3@ FcChar32 * @ARG3@ next
@PURPOSE@ Continue enumerating charset contents
@DESC@

12
doc/fcconfig.fncs
View File

@ -114,7 +114,7 @@ Returns the name of the file used to store per-user font information.
@RET@ FcFontSet *
@FUNC@ FcConfigGetFonts
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcSetName @ARG2@ set
@TYPE2@ FcSetName% @ARG2@ set
@PURPOSE@ Get config font set
@DESC@
Returns one of the two sets of fonts from the configuration as specified
@ -143,7 +143,7 @@ a call to FcFontList when this interval has passed since the last check.
@RET@ FcBool
@FUNC@ FcConfigSetRescanInverval
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ int @ARG2@ rescanInterval
@TYPE2@ int% @ARG2@ rescanInterval
@PURPOSE@ Set config rescan interval
@DESC@
Sets the rescan interval; returns FcFalse if an error occurred.
@ -181,7 +181,7 @@ Clears the set of application-specific fonts.
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcPattern * @ARG3@ p_pat
@TYPE4@ FcMatchKind @ARG4@ kind
@TYPE4@ FcMatchKind% @ARG4@ kind
@PURPOSE@ Execute substitutions
@DESC@
Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
@ -194,7 +194,7 @@ p_pat is used for &lt;test&gt; elements with target=pattern.
@FUNC@ FcConfigSubstitute
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcMatchKind @ARG3@ kind
@TYPE3@ FcMatchKind% @ARG3@ kind
@PURPOSE@ Execute substitutions
@DESC@
Calls FcConfigSubstituteWithPat setting p_pat to NULL.
@ -216,7 +216,7 @@ been called for <parameter>p</parameter>; otherwise the results will not be corr
@FUNC@ FcFontSort
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcBool @ARG3@ trim
@TYPE3@ FcBool% @ARG3@ trim
@TYPE4@ FcCharSet ** @ARG4@ csp
@TYPE5@ FcResult * @ARG5@ result
@PURPOSE@ Return list of matching fonts
@ -282,7 +282,7 @@ FC_CONFIG_DIR environment variable.
@FUNC@ FcConfigParseAndLoad
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ file
@TYPE2@ FcBool @ARG3@ complain
@TYPE2@ FcBool% @ARG3@ complain
@PURPOSE@ load a configuration file
@DESC@
Walks the configuration in 'file' and constructs the internal representation

4
doc/fcconstant.fncs
View File

@ -24,7 +24,7 @@
@RET@ FcBool
@FUNC@ FcNameRegisterConstants
@TYPE1@ const FcConstant * @ARG1@ consts
@TYPE2@ int @ARG2@ nconsts
@TYPE2@ int% @ARG2@ nconsts
@PURPOSE@ Register symbolic constants
@DESC@
Register <parameter>nconsts</parameter> new symbolic constants.
@ -33,7 +33,7 @@ Register <parameter>nconsts</parameter> new symbolic constants.
@RET@ FcBool
@FUNC@ FcNameUnregisterConstants
@TYPE1@ const FcConstant * @ARG1@ consts
@TYPE2@ int @ARG2@ nconsts
@TYPE2@ int% @ARG2@ nconsts
@PURPOSE@ Unregister symbolic constants
@DESC@
Unregister <parameter>nconsts</parameter> symbolic constants.

4
doc/fcfile.fncs
View File

@ -29,7 +29,7 @@
@TYPE3@ FcFileCache * @ARG3@ cache
@TYPE4@ FcBlanks * @ARG4@ blanks
@TYPE5@ const char * @ARG5@ file
@TYPE6@ FcBool @ARG6@ force
@TYPE6@ FcBool% @ARG6@ force
@PURPOSE@ scan a font file
@DESC@
Scans a single file and adds all fonts found to <parameter>set</parameter>.
@ -46,7 +46,7 @@ associated information is found in <parameter>cache</parameter>. If
@TYPE3@ FcFileCache * @ARG3@ cache
@TYPE4@ FcBlanks * @ARG4@ blanks
@TYPE5@ const char * @ARG5@ dir
@TYPE6@ FcBool @ARG6@ force
@TYPE6@ FcBool% @ARG6@ force
@PURPOSE@ scan a font directory
@DESC@
Scans an entire directory and adds all fonts found to

12
doc/fcfreetype.fncs
View File

@ -27,8 +27,8 @@
#include &lt;fcfreetype.h&gt;
@RET@ FT_UInt
@FUNC@ FcFreeTypeCharIndex
@TYPE1@ FT_Face @ARG1@ face
@TYPE2@ FcChar32 @ARG2@ ucs4
@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
@ -43,7 +43,7 @@ higher level functions.
#include &lt;fcfreetype.h&gt;
@RET@ FcCharSet *
@FUNC@ FcFreeTypeCharSet
@TYPE1@ FT_Face @ARG1@ face
@TYPE1@ FT_Face% @ARG1@ face
@TYPE2@ FcBlanks * @ARG2@ blanks
@PURPOSE@ compute unicode coverage
@DESC@
@ -59,7 +59,7 @@ not in 'blanks' are not placed in the returned FcCharSet.
@RET@ FcPattern *
@FUNC@ FcFreeTypeQuery
@TYPE1@ const char * @ARG1@ file
@TYPE2@ int @ARG2@ id
@TYPE2@ int% @ARG2@ id
@TYPE3@ FcBlanks * @ARG3@ blanks
@TYPE4@ int * @ARG4@ count
@PURPOSE@ compute pattern from font file (and index)
@ -73,9 +73,9 @@ of fonts in 'file' is returned in 'count'.
#include &lt;fcfreetype.h&gt;
@RET@ FcPattern *
@FUNC@ FcFreeTypeQueryFace
@TYPE1@ const FT_Face @ARG1@ face
@TYPE1@ const FT_Face% @ARG1@ face
@TYPE2@ const char * @ARG2@ file
@TYPE3@ int @ARG3@ id
@TYPE3@ int% @ARG3@ id
@TYPE4@ FcBlanks * @ARG4@ blanks
@PURPOSE@ compute pattern from FT_Face
@DESC@

12
doc/fcmatrix.fncs
View File

@ -69,9 +69,9 @@ the result in <parameter>result</parameter>.
@PURPOSE@ Rotate a matrix
@TYPE1@ FcMatrix *
@ARG1@ matrix
@TYPE2@ double
@TYPE2@ double%
@ARG2@ cos
@TYPE3@ double
@TYPE3@ double%
@ARG3@ sin
@DESC@
<function>FcMatrixRotate</function> rotates <parameter>matrix</parameter>
@ -88,9 +88,9 @@ matrix:
@PURPOSE@ Scale a matrix
@TYPE1@ FcMatrix *
@ARG1@ matrix
@TYPE2@ double
@TYPE2@ double%
@ARG2@ sx
@TYPE3@ double
@TYPE3@ double%
@ARG3@ dy
@DESC@
<function>FcMatrixScale</function> multiplies <parameter>matrix</parameter>
@ -107,9 +107,9 @@ the matrix:
@PURPOSE@ Shear a matrix
@TYPE1@ FcMatrix *
@ARG1@ matrix
@TYPE2@ double
@TYPE2@ double%
@ARG2@ sh
@TYPE3@ double
@TYPE3@ double%
@ARG3@ sv
@DESC@
<function>FcMatrixShare</function> shears <parameter>matrix</parameter>

2
doc/fcobjectset.fncs
View File

@ -54,7 +54,7 @@ Destroys an object set.
@RET+@ FcObjectSet *
@FUNC+@ FcObjectSetVaBuild
@TYPE1+@ const char * @ARG1+@ first
@TYPE2+@ va_list @ARG2+@ va
@TYPE2+@ va_list% @ARG2+@ va
@PURPOSE@ Build object set from args
@DESC@
These build an object set from a null-terminated list of property names.

4
doc/fcobjecttype.fncs
View File

@ -24,7 +24,7 @@
@RET@ FcBool
@FUNC@ FcNameRegisterObjectTypes
@TYPE1@ const FcObjectType * @ARG1@ types
@TYPE2@ int @ARG2@ ntype
@TYPE2@ int% @ARG2@ ntype
@PURPOSE@ Register object types
@DESC@
Register <parameter>ntype</parameter> new object types.
@ -33,7 +33,7 @@ Register <parameter>ntype</parameter> new object types.
@RET@ FcBool
@FUNC@ FcNameUnregisterObjectTypes
@TYPE1@ const FcObjectType * @ARG1@ types
@TYPE2@ int @ARG2@ ntype
@TYPE2@ int% @ARG2@ ntype
@PURPOSE@ Unregister object types
@DESC@
Unregister <parameter>ntype</parameter> object types.

32
doc/fcpattern.fncs
View File

@ -70,8 +70,8 @@ equal.
@FUNC@ FcPatternAdd
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ FcValue @ARG3@ value
@TYPE4@ FcBool @ARG4@ append
@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
@ -85,8 +85,8 @@ retains no reference to any application-supplied data structure.
@FUNC@ FcPatternAddWeak
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ FcValue @ARG3@ value
@TYPE4@ FcBool @ARG4@ append
@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
@ -98,14 +98,14 @@ values added to the list have binding <parameter>weak</parameter> instead of <pa
@FUNC@ FcPatternAddInteger
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int @ARG3@ i
@TYPE3@ int% @ARG3@ i
@PROTOTYPE+@
@RET+@ FcBool
@FUNC+@ FcPatternAddDouble
@TYPE1+@ FcPattern * @ARG1+@ p
@TYPE2+@ const char * @ARG2+@ object
@TYPE3+@ double @ARG3+@ d
@TYPE3+@ double% @ARG3+@ d
@PROTOTYPE++@
@RET++@ FcBool
@ -133,7 +133,7 @@ values added to the list have binding <parameter>weak</parameter> instead of <pa
@FUNC+++++@ FcPatternAddBool
@TYPE1+++++@ FcPattern * @ARG1+++++@ p
@TYPE2+++++@ const char * @ARG2+++++@ object
@TYPE3+++++@ FcBool @ARG3+++++@ b
@TYPE3+++++@ FcBool% @ARG3+++++@ b
@PURPOSE@ Add a typed value to a pattern
@DESC@
These are all convenience functions that insert objects of the specified
@ -146,7 +146,7 @@ any existing list of values.
@FUNC@ FcPatternGet
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int @ARG3@ id
@TYPE3@ int% @ARG3@ id
@TYPE4@ FcValue * @ARG4@ v
@PURPOSE@ Return a value from a pattern
@DESC@
@ -162,7 +162,7 @@ within the pattern directly. Applications must not free this value.
@FUNC@ FcPatternGetInteger
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int @ARG3@ n
@TYPE3@ int% @ARG3@ n
@TYPE4@ int * @ARG4@ i
@PROTOTYPE+@
@ -170,7 +170,7 @@ within the pattern directly. Applications must not free this value.
@FUNC+@ FcPatternGetDouble
@TYPE1+@ FcPattern * @ARG1+@ p
@TYPE2+@ const char * @ARG2+@ object
@TYPE3+@ int @ARG3+@ n
@TYPE3+@ int% @ARG3+@ n
@TYPE4+@ double * @ARG4+@ d
@PROTOTYPE++@
@ -178,7 +178,7 @@ within the pattern directly. Applications must not free this value.
@FUNC++@ FcPatternGetString
@TYPE1++@ FcPattern * @ARG1++@ p
@TYPE2++@ const char * @ARG2++@ object
@TYPE3++@ int @ARG3++@ n
@TYPE3++@ int% @ARG3++@ n
@TYPE4++@ char **const @ARG4++@ s
@PROTOTYPE+++@
@ -186,7 +186,7 @@ within the pattern directly. Applications must not free this value.
@FUNC+++@ FcPatternGetMatrix
@TYPE1+++@ FcPattern * @ARG1+++@ p
@TYPE2+++@ const char * @ARG2+++@ object
@TYPE3+++@ int @ARG3+++@ n
@TYPE3+++@ int% @ARG3+++@ n
@TYPE4+++@ FcMatrix ** @ARG4+++@ s
@PROTOTYPE++++@
@ -194,7 +194,7 @@ within the pattern directly. Applications must not free this value.
@FUNC++++@ FcPatternGetCharSet
@TYPE1++++@ FcPattern * @ARG1++++@ p
@TYPE2++++@ const char * @ARG2++++@ object
@TYPE3++++@ int @ARG3++++@ n
@TYPE3++++@ int% @ARG3++++@ n
@TYPE4++++@ FcCharSet ** @ARG4++++@ c
@PROTOTYPE+++++@
@ -202,7 +202,7 @@ within the pattern directly. Applications must not free this value.
@FUNC+++++@ FcPatternGetBool
@TYPE1+++++@ FcPattern * @ARG1+++++@ p
@TYPE2+++++@ const char * @ARG2+++++@ object
@TYPE3+++++@ int @ARG3+++++@ n
@TYPE3+++++@ int% @ARG3+++++@ n
@TYPE4+++++@ FcBool * @ARG4+++++@ b
@PURPOSE@ Return a typed value from a pattern
@DESC@
@ -222,7 +222,7 @@ in preference to FcPatternGet to provide compile-time typechecking.
@RET+@ FcPattern *
@FUNC+@ FcPatternVaBuild
@TYPE1+@ FcPattern * @ARG1+@ orig
@TYPE2+@ va_list @ARG2+@ va
@TYPE2+@ va_list% @ARG2+@ va
@PURPOSE@ Create patterns from arguments
@DESC@
Builds a pattern using a list of objects, types and values. Each
@ -267,7 +267,7 @@ whether the property existed or not.
@FUNC@ FcPatternRemove
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int @ARG3@ id
@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

16
doc/fcstring.fncs
View File

@ -27,7 +27,7 @@
@FUNC@ FcUtf8ToUcs4
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ FcChar32 * @ARG2@ dst
@TYPE3@ int @ARG3@ len
@TYPE3@ int% @ARG3@ len
@PURPOSE@ convert UTF-8 to UCS4
@DESC@
Converts the next Unicode char from <parameter>src</parameter> into
@ -38,8 +38,8 @@ char. <parameter>src</parameter> nust be at least
@RET@ int
@FUNC@ FcUcs4ToUtf8
@TYPE1@ FcChar32 @ARG1@ src
@TYPE2@ FcChar8 @ARG2@ dst[FC_UTF8_MAX_LEN]
@TYPE1@ FcChar32% @ARG1@ src
@TYPE2@ FcChar8% @ARG2@ dst[FC_UTF8_MAX_LEN]
@PURPOSE@ convert UCS4 to UTF-8
@DESC@
Converts the Unicode char from <parameter>src</parameter> into
@ -50,7 +50,7 @@ the char.
@RET@ FcBool
@FUNC@ FcUtf8Len
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ int @ARG2@ len
@TYPE2@ int% @ARG2@ len
@TYPE3@ int * @ARG3@ nchar
@TYPE4@ int * @ARG4@ wchar
@PURPOSE@ count UTF-8 encoded chars
@ -66,9 +66,9 @@ well-formed UTF8 string.
@RET@ int
@FUNC@ FcUtf16ToUcs4
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ FcEndian @ARG2@ endian
@TYPE2@ FcEndian% @ARG2@ endian
@TYPE3@ FcChar32 * @ARG3@ dst
@TYPE4@ int @ARG4@ len
@TYPE4@ int% @ARG4@ len
@PURPOSE@ convert UTF-16 to UCS4
@DESC@
Converts the next Unicode char from <parameter>src</parameter> into
@ -81,8 +81,8 @@ units according to <parameter>endian</parameter>.
@RET@ FcBool
@FUNC@ FcUtf16Len
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ FcEndian @ARG2@ endian
@TYPE3@ int @ARG3@ len
@TYPE2@ FcEndian% @ARG2@ endian
@TYPE3@ int% @ARG3@ len
@TYPE4@ int * @ARG4@ nchar
@TYPE5@ int * @ARG5@ wchar
@PURPOSE@ count UTF-16 encoded chars

4
doc/fcvalue.fncs
View File

@ -23,7 +23,7 @@
*/
@RET@ void
@FUNC@ FcValueDestroy
@TYPE1@ FcValue @ARG1@ v
@TYPE1@ FcValue% @ARG1@ v
@PURPOSE@ Free a value
@DESC@
Frees any memory referenced by <parameter>v</parameter>. Values of type FcTypeString,
@ -32,7 +32,7 @@ FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
@RET@ FcValue
@FUNC@ FcValueSave
@TYPE1@ FcValue @ARG1@ v
@TYPE1@ FcValue% @ARG1@ v
@PURPOSE@ Copy a value
@DESC@
Returns a copy of <parameter>v</parameter> duplicating any object referenced by it so that <parameter>v</parameter>