Commit 8b46a518 authored by Behdad Esfahbod's avatar Behdad Esfahbod

Update documentation for removal of blanks

Patch from Jerry Casiano.
parent a8bbbfb6
......@@ -26,7 +26,8 @@
@TYPE1@ void
@PURPOSE@ Create an FcBlanks
@DESC@
Creates an empty FcBlanks object.
FcBlanks is deprecated.
This function always returns NULL.
@@
@RET@ void
......@@ -34,7 +35,8 @@ Creates an empty FcBlanks object.
@TYPE1@ FcBlanks * @ARG1@ b
@PURPOSE@ Destroy and FcBlanks
@DESC@
Destroys an FcBlanks object, freeing any associated memory.
FcBlanks is deprecated.
This function does nothing.
@@
@RET@ FcBool
......@@ -43,8 +45,8 @@ Destroys an FcBlanks object, freeing any associated memory.
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Add a character to an FcBlanks
@DESC@
Adds a single character to an FcBlanks object, returning FcFalse
if this process ran out of memory.
FcBlanks is deprecated.
This function always returns FALSE.
@@
@RET@ FcBool
......@@ -53,6 +55,6 @@ if this process ran out of memory.
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Query membership in an FcBlanks
@DESC@
Returns whether the specified FcBlanks object contains the indicated Unicode
value.
FcBlanks is deprecated.
This function always returns FALSE.
@@
......@@ -181,11 +181,8 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get config blanks
@DESC@
Returns the FcBlanks object associated with the given configuration, if no
blanks were present in the configuration, this function will return 0.
The returned FcBlanks object if not NULL, is valid as long as the owning
FcConfig is alive.
If <parameter>config</parameter> is NULL, the current configuration is used.
FcBlanks is deprecated.
This function always returns NULL.
@@
@RET@ int
......
......@@ -47,10 +47,9 @@ higher level functions.
@TYPE2@ FcBlanks * @ARG2@ blanks
@PURPOSE@ compute Unicode coverage
@DESC@
Scans a FreeType face and returns the set of encoded Unicode chars. This scans
several encoding tables to build as complete a list as possible.
If 'blanks' is not 0, the glyphs in the font are examined and any blank glyphs
not in 'blanks' are not placed in the returned FcCharSet.
Scans a FreeType face and returns the set of encoded Unicode chars.
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
accepted only for compatibility with older code.
@@
@SYNOPSIS@
......@@ -64,10 +63,8 @@ not in 'blanks' are not placed in the returned FcCharSet.
@PURPOSE@ compute Unicode coverage and spacing type
@DESC@
Scans a FreeType face and returns the set of encoded Unicode chars.
This scans
several encoding tables to build as complete a list as possible.
If 'blanks' is not 0, the glyphs in the font are examined and any blank glyphs
not in 'blanks' are not placed in the returned FcCharSet.
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
accepted only for compatibility with older code.
<parameter>spacing</parameter> receives the computed spacing type of the
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
......@@ -88,6 +85,8 @@ widths.
@DESC@
Constructs a pattern representing the 'id'th font in 'file'. The number
of fonts in 'file' is returned in 'count'.
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
accepted only for compatibility with older code.
@@
@SYNOPSIS@
......@@ -103,4 +102,6 @@ of fonts in 'file' is returned in 'count'.
@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).
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
accepted only for compatibility with older code.
@@
......@@ -380,6 +380,11 @@ holds a list of Unicode chars which are expected to be blank; unexpectedly
blank chars are assumed to be invalid and are elided from the charset
associated with the font.
</para>
<para>
FcBlanks is deprecated and should not be used in newly written code.
It is still accepted by some functions for compatibility with
older code but will be removed in the future.
</para>
</sect2>
<sect2><title>FcFileCache</title>
<para>
......@@ -558,6 +563,11 @@ empty and not in this list will be assumed to be broken and not placed in
the FcCharSet associated with the font. This provides a significantly more
accurate CharSet for applications.
</para>
<para>
FcBlanks is deprecated and should not be used in newly written code.
It is still accepted by some functions for compatibility with
older code but will be removed in the future.
</para>
&fcblanks;
</sect2>
<sect2><title>FcAtomic</title>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment