ReFuel/freetype
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

s/..../'....'/ for SFNT table tags in documentation.

Browse Source
This commit is contained in:
Werner Lemberg 2019-02-21 09:19:09 +01:00
parent 8de11f3def
commit a346abc093
15 changed files with 123 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
devel/ftoption.h
View File

@ -299,13 +299,13 @@ FT_BEGIN_HEADER
* By default, FreeType 2 is compiled with the 'psnames' module. This
* module is in charge of converting a glyph name string into a Unicode
* value, or return a Macintosh standard glyph name for the use with the
* TrueType `post` table.
* TrueType 'post' table.
*
* Undefine this macro if you do not want 'psnames' compiled in your
* build of FreeType. This has the following effects:
*
* - The TrueType driver will provide its own set of glyph names, if you
* build it to support postscript names in the TrueType `post` table,
* build it to support postscript names in the TrueType 'post' table,
* but will not synthesize a missing Unicode charmap.
*
* - The Type~1 driver will not be able to synthesize a Unicode charmap
@ -342,7 +342,7 @@ FT_BEGIN_HEADER
* (mac dfont, mac resource, macbinary containing a mac resource) on
* non-Mac platforms.
*
* Note that the `FOND` resource isn't checked.
* Note that the 'FOND' resource isn't checked.
*/
#define FT_CONFIG_OPTION_MAC_FONTS
@ -527,7 +527,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* Define `TT_CONFIG_OPTION_COLOR_LAYERS` if you want to support coloured
* outlines (from the `COLR`/`CPAL` tables) in all formats using the 'sfnt'
* outlines (from the 'COLR'/'CPAL' tables) in all formats using the 'sfnt'
* module (namely TrueType~& OpenType).
*/
#define TT_CONFIG_OPTION_COLOR_LAYERS
@ -684,8 +684,8 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* Define `TT_CONFIG_OPTION_GX_VAR_SUPPORT` if you want to include support
* for Apple's distortable font technology (`fvar`, `gvar`, `cvar`, and
* `avar` tables). Tagged 'Font Variations', this is now part of OpenType
* for Apple's distortable font technology ('fvar', 'gvar', 'cvar', and
* 'avar' tables). Tagged 'Font Variations', this is now part of OpenType
* also. This has many similarities to Type~1 Multiple Masters support.
*/
#define TT_CONFIG_OPTION_GX_VAR_SUPPORT
@ -694,7 +694,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* Define `TT_CONFIG_OPTION_BDF` if you want to include support for an
* embedded `BDF ` table within SFNT-based bitmap formats.
* embedded 'BDF~' table within SFNT-based bitmap formats.
*/
#define TT_CONFIG_OPTION_BDF

10
include/freetype/config/ftheader.h
View File

@ -624,8 +624,8 @@
*
* @description:
* A macro used in `#include` statements to name the file containing the
* optional FreeType~2 API which validates OpenType tables (`BASE`,
* `GDEF`, `GPOS`, `GSUB`, `JSTF`).
* optional FreeType~2 API which validates OpenType tables ('BASE',
* 'GDEF', 'GPOS', 'GSUB', 'JSTF').
*
*/
#define FT_OPENTYPE_VALIDATE_H <freetype/ftotval.h>
@ -638,8 +638,8 @@
*
* @description:
* A macro used in `#include` statements to name the file containing the
* optional FreeType~2 API which validates TrueTypeGX/AAT tables (`feat`,
* `mort`, `morx`, `bsln`, `just`, `kern`, `opbd`, `trak`, `prop`).
* optional FreeType~2 API which validates TrueTypeGX/AAT tables ('feat',
* 'mort', 'morx', 'bsln', 'just', 'kern', 'opbd', 'trak', 'prop').
*
*/
#define FT_GX_VALIDATE_H <freetype/ftgxval.h>
@ -765,7 +765,7 @@
*
* @description:
* A macro used in `#include` statements to name the file containing the
* FreeType~2 API which handles the OpenType `CPAL` table.
* FreeType~2 API which handles the OpenType 'CPAL' table.
*/
#define FT_COLOR_H <freetype/ftcolor.h>

14
include/freetype/config/ftoption.h
View File

@ -299,13 +299,13 @@ FT_BEGIN_HEADER
* By default, FreeType 2 is compiled with the 'psnames' module. This
* module is in charge of converting a glyph name string into a Unicode
* value, or return a Macintosh standard glyph name for the use with the
* TrueType `post` table.
* TrueType 'post' table.
*
* Undefine this macro if you do not want 'psnames' compiled in your
* build of FreeType. This has the following effects:
*
* - The TrueType driver will provide its own set of glyph names, if you
* build it to support postscript names in the TrueType `post` table,
* build it to support postscript names in the TrueType 'post' table,
* but will not synthesize a missing Unicode charmap.
*
* - The Type~1 driver will not be able to synthesize a Unicode charmap
@ -342,7 +342,7 @@ FT_BEGIN_HEADER
* (mac dfont, mac resource, macbinary containing a mac resource) on
* non-Mac platforms.
*
* Note that the `FOND` resource isn't checked.
* Note that the 'FOND' resource isn't checked.
*/
#define FT_CONFIG_OPTION_MAC_FONTS
@ -527,7 +527,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* Define `TT_CONFIG_OPTION_COLOR_LAYERS` if you want to support coloured
* outlines (from the `COLR`/`CPAL` tables) in all formats using the 'sfnt'
* outlines (from the 'COLR'/'CPAL' tables) in all formats using the 'sfnt'
* module (namely TrueType~& OpenType).
*/
#define TT_CONFIG_OPTION_COLOR_LAYERS
@ -684,8 +684,8 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* Define `TT_CONFIG_OPTION_GX_VAR_SUPPORT` if you want to include support
* for Apple's distortable font technology (`fvar`, `gvar`, `cvar`, and
* `avar` tables). Tagged 'Font Variations', this is now part of OpenType
* for Apple's distortable font technology ('fvar', 'gvar', 'cvar', and
* 'avar' tables). Tagged 'Font Variations', this is now part of OpenType
* also. This has many similarities to Type~1 Multiple Masters support.
*/
#define TT_CONFIG_OPTION_GX_VAR_SUPPORT
@ -694,7 +694,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* Define `TT_CONFIG_OPTION_BDF` if you want to include support for an
* embedded `BDF ` table within SFNT-based bitmap formats.
* embedded 'BDF~' table within SFNT-based bitmap formats.
*/
#define TT_CONFIG_OPTION_BDF

28
include/freetype/freetype.h
View File

@ -308,7 +308,7 @@ FT_BEGIN_HEADER
* `horiAdvance` or `vertAdvance`; you have to manually adjust these
* values to account for the added width and height.
*
* FreeType doesn't use the `VORG` table data for CFF fonts because it
* FreeType doesn't use the 'VORG' table data for CFF fonts because it
* doesn't have an interface to quickly retrieve the glyph height. The
* y~coordinate of the vertical origin can be simply computed as
* `vertBearingY + height` after loading a glyph.
@ -1032,7 +1032,7 @@ FT_BEGIN_HEADER
*
* For an OpenType variation font, the values of the following fields can
* change after a call to @FT_Set_Var_Design_Coordinates (and friends) if
* the font contains an `MVAR` table: `ascender`, `descender`, `height`,
* the font contains an 'MVAR' table: `ascender`, `descender`, `height`,
* `underline_position`, and `underline_thickness`.
*
* Especially for TrueType fonts see also the documentation for
@ -1137,7 +1137,7 @@ FT_BEGIN_HEADER
* The face contains kerning information. If set, the kerning distance
* can be retrieved using the function @FT_Get_Kerning. Otherwise the
* function always return the vector (0,0). Note that FreeType doesn't
* handle kerning data from the SFNT `GPOS` table (as present in many
* handle kerning data from the SFNT 'GPOS' table (as present in many
* OpenType fonts).
*
* FT_FACE_FLAG_FAST_GLYPHS ::
@ -1163,7 +1163,7 @@ FT_BEGIN_HEADER
*
* FT_FACE_FLAG_HINTER ::
* The font driver has a hinting machine of its own. For example, with
* TrueType fonts, it makes sense to use data from the SFNT `gasp`
* TrueType fonts, it makes sense to use data from the SFNT 'gasp'
* table only if the native TrueType hinting engine (with the bytecode
* interpreter) is available and active.
*
@ -1482,7 +1482,7 @@ FT_BEGIN_HEADER
* @note:
* The style information as provided by FreeType is very basic. More
* details are beyond the scope and should be done on a higher level (for
* example, by analyzing various fields of the `OS/2` table in SFNT based
* example, by analyzing various fields of the 'OS/2' table in SFNT based
* fonts).
*/
#define FT_STYLE_FLAG_ITALIC ( 1 << 0 )
@ -2969,7 +2969,7 @@ FT_BEGIN_HEADER
* bitmaps, using the @FT_PIXEL_MODE_GRAY format.
*
* [Since 2.10] If the glyph index contains an entry in the face's
* `COLR` table with a `CPAL` palette table (as defined in the OpenType
* 'COLR' table with a 'CPAL' palette table (as defined in the OpenType
* specification), make @FT_Render_Glyph provide a default blending of
* the color glyph layers associated with the glyph index, using the
* same bitmap format as embedded color bitmap images. This is mainly
@ -2980,7 +2980,7 @@ FT_BEGIN_HEADER
*
* FT_LOAD_COMPUTE_METRICS ::
* [Since 2.6.1] Compute glyph metrics from the glyph data, without the
* use of bundled metrics tables (for example, the `hdmx` table in
* use of bundled metrics tables (for example, the 'hdmx' table in
* TrueType fonts). This flag is mainly used by font validating or
* font editing applications, which need to ignore, verify, or edit
* those tables.
@ -3460,7 +3460,7 @@ FT_BEGIN_HEADER
* out of the scope of this API function -- they can be implemented
* through format-specific interfaces.
*
* Kerning for OpenType fonts implemented in a `GPOS` table is not
* Kerning for OpenType fonts implemented in a 'GPOS' table is not
* supported; use @FT_HAS_KERNING to find out whether a font has data
* that can be extracted with `FT_Get_Kerning`.
*/
@ -3590,7 +3590,7 @@ FT_BEGIN_HEADER
*
* [Since 2.9] Special PostScript names for named instances are only
* returned if the named instance is set with @FT_Set_Named_Instance (and
* the font has corresponding entries in its `fvar` table). If
* the font has corresponding entries in its 'fvar' table). If
* @FT_IS_VARIATION returns true, the algorithmically derived PostScript
* name is provided, not looking up special entries for named instances.
*/
@ -3941,7 +3941,7 @@ FT_BEGIN_HEADER
* FT_SUBGLYPH_FLAG_XXX
*
* @description:
* A list of constants describing subglyphs. Please refer to the `glyf`
* A list of constants describing subglyphs. Please refer to the 'glyf'
* table description in the OpenType specification for the meaning of the
* various flags (which get synthesized for non-OpenType subglyphs).
*
@ -4030,11 +4030,11 @@ FT_BEGIN_HEADER
* Glyph Layer Management
*
* @abstract:
* Retrieving and manipulating OpenType's `COLR` table data.
* Retrieving and manipulating OpenType's 'COLR' table data.
*
* @description:
* The functions described here allow access of colored glyph layer data
* in OpenType's `COLR` tables.
* in OpenType's 'COLR' tables.
*/
@ -4055,7 +4055,7 @@ FT_BEGIN_HEADER
* The current layer. Will be set by @FT_Get_Color_Glyph_Layer.
*
* p ::
* An opaque pointer into `COLR` table data. The caller must set this
* An opaque pointer into 'COLR' table data. The caller must set this
* to `NULL` before the first call of @FT_Get_Color_Glyph_Layer.
*/
typedef struct FT_LayerIterator_
@ -4073,7 +4073,7 @@ FT_BEGIN_HEADER
* FT_Get_Color_Glyph_Layer
*
* @description:
* This is an interface to the `COLR` table in OpenType fonts to
* This is an interface to the 'COLR' table in OpenType fonts to
* iteratively retrieve the colored glyph layers associated with the
* current glyph slot.
*

28
include/freetype/ftcolor.h
View File

@ -41,11 +41,11 @@ FT_BEGIN_HEADER
* Glyph Color Management
*
* @abstract:
* Retrieving and manipulating OpenType's `CPAL` table data.
* Retrieving and manipulating OpenType's 'CPAL' table data.
*
* @description:
* The functions described here allow access and manipulation of color
* palette entries in OpenType's `CPAL` tables.
* palette entries in OpenType's 'CPAL' tables.
*/
@ -55,7 +55,7 @@ FT_BEGIN_HEADER
* FT_Color
*
* @description:
* This structure models a BGRA color value of a `CPAL` palette entry.
* This structure models a BGRA color value of a 'CPAL' palette entry.
*
* The used color space is sRGB; the colors are not pre-multiplied, and
* alpha values must be explicitly set.
@ -118,7 +118,7 @@ FT_BEGIN_HEADER
* FT_Palette_Data
*
* @description:
* This structure holds the data of the `CPAL` table.
* This structure holds the data of the 'CPAL' table.
*
* @fields:
* num_palettes ::
@ -126,13 +126,13 @@ FT_BEGIN_HEADER
*
* palette_name_ids ::
* A read-only array of palette name IDs with `num_palettes` elements,
* corresponding to entries like 'dark' or 'light' in the font's `name`
* corresponding to entries like 'dark' or 'light' in the font's 'name'
* table.
*
* An empty name ID in the `CPAL` table gets represented as value
* An empty name ID in the 'CPAL' table gets represented as value
* 0xFFFF.
*
* `NULL` if the font's `CPAL` table doesn't contain appropriate data.
* `NULL` if the font's 'CPAL' table doesn't contain appropriate data.
*
* palette_flags ::
* A read-only array of palette flags with `num_palettes` elements.
@ -140,7 +140,7 @@ FT_BEGIN_HEADER
* @FT_PALETTE_FOR_LIGHT_BACKGROUND and
* @FT_PALETTE_FOR_DARK_BACKGROUND.
*
* `NULL` if the font's `CPAL` table doesn't contain appropriate data.
* `NULL` if the font's 'CPAL' table doesn't contain appropriate data.
*
* num_palette_entries ::
* The number of entries in a single palette. All palettes have the
@ -150,14 +150,14 @@ FT_BEGIN_HEADER
* A read-only array of palette entry name IDs with
* `num_palette_entries`. In each palette, entries with the same index
* have the same function. For example, index~0 might correspond to
* string 'outline' in the font's `name` table to indicate that this
* string 'outline' in the font's 'name' table to indicate that this
* palette entry is used for outlines, index~1 might correspond to
* 'fill' to indicate the filling color palette entry, etc.
*
* An empty entry name ID in the `CPAL` table gets represented as value
* An empty entry name ID in the 'CPAL' table gets represented as value
* 0xFFFF.
*
* `NULL` if the font's `CPAL` table doesn't contain appropriate data.
* `NULL` if the font's 'CPAL' table doesn't contain appropriate data.
*
* @note:
* Use function @FT_Get_Sfnt_Name to map name IDs and entry name IDs to
@ -226,7 +226,7 @@ FT_BEGIN_HEADER
*
* A corollary of (2) is that calling the function, then modifying some
* values, then calling the function again with the same arguments resets
* all color entries to the original `CPAL` values; all user modifications
* all color entries to the original 'CPAL' values; all user modifications
* are lost.
*
* @input:
@ -273,7 +273,7 @@ FT_BEGIN_HEADER
* FT_Palette_Set_Foreground_Color
*
* @description:
* `COLR` uses palette index 0xFFFF to indicate a 'text foreground
* 'COLR' uses palette index 0xFFFF to indicate a 'text foreground
* color'. This function sets this value.
*
* @input:
@ -291,7 +291,7 @@ FT_BEGIN_HEADER
* white opaque (BGRA value 0xFFFFFFFF) if
* @FT_PALETTE_FOR_DARK_BACKGROUND is present for the current palette,
* and black opaque (BGRA value 0x000000FF) otherwise, including the case
* that no palette types are available in the `CPAL` table.
* that no palette types are available in the 'CPAL' table.
*
* This function always returns an error if the config macro
* `TT_CONFIG_OPTION_COLOR_LAYERS` is not defined in `ftoption.h`.

4
include/freetype/ftdriver.h
View File

@ -233,7 +233,7 @@ FT_BEGIN_HEADER
* achieve some level of glyph symmetry. To enable reasonable
* performance (e.g., not having to run hinting on all glyphs just to get
* the widths) there was a bit in the head table indicating if the side
* bearing was hinted, and additional tables, `hdmx` and `LTSH`, to cache
* bearing was hinted, and additional tables, 'hdmx' and 'LTSH', to cache
* hinting widths across multiple sizes and device aspect ratios.
*
* _Font Smoothing_
@ -1070,7 +1070,7 @@ FT_BEGIN_HEADER
* coverages, this property sets the (auto-fitter) script to be used for
* the default (OpenType) script data of a font's GSUB table. Features
* for the default script are intended for all scripts not explicitly
* handled in GSUB; an example is a `dlig` feature, containing the
* handled in GSUB; an example is a 'dlig' feature, containing the
* combination of the characters 'T', 'E', and 'L' to form a 'TEL'
* ligature.
*

10
include/freetype/ftgasp.h
View File

@ -2,7 +2,7 @@
*
* ftgasp.h
*
* Access of TrueType's `gasp` table (specification).
* Access of TrueType's 'gasp' table (specification).
*
* Copyright 2007-2019 by
* David Turner, Robert Wilhelm, and Werner Lemberg.
@ -41,11 +41,11 @@ FT_BEGIN_HEADER
* Gasp Table
*
* @abstract:
* Retrieving TrueType `gasp` table entries.
* Retrieving TrueType 'gasp' table entries.
*
* @description:
* The function @FT_Get_Gasp can be used to query a TrueType or OpenType
* font for specific entries in its `gasp` table, if any. This is mainly
* font for specific entries in its 'gasp' table, if any. This is mainly
* useful when implementing native TrueType hinting with the bytecode
* interpreter to duplicate the Windows text rendering results.
*/
@ -106,7 +106,7 @@ FT_BEGIN_HEADER
*
* @description:
* For a TrueType or OpenType font file, return the rasterizer behaviour
* flags from the font's `gasp` table corresponding to a given character
* flags from the font's 'gasp' table corresponding to a given character
* pixel size.
*
* @input:
@ -118,7 +118,7 @@ FT_BEGIN_HEADER
*
* @return:
* Bit flags (see @FT_GASP_XXX), or @FT_GASP_NO_TABLE if there is no
* `gasp` table in the face.
* 'gasp' table in the face.
*
* @note:
* If you want to use the MM functionality of OpenType variation fonts

28
include/freetype/ftgxval.h
View File

@ -123,34 +123,34 @@ FT_BEGIN_HEADER
*
* @values:
* FT_VALIDATE_feat ::
* Validate `feat` table.
* Validate 'feat' table.
*
* FT_VALIDATE_mort ::
* Validate `mort` table.
* Validate 'mort' table.
*
* FT_VALIDATE_morx ::
* Validate `morx` table.
* Validate 'morx' table.
*
* FT_VALIDATE_bsln ::
* Validate `bsln` table.
* Validate 'bsln' table.
*
* FT_VALIDATE_just ::
* Validate `just` table.
* Validate 'just' table.
*
* FT_VALIDATE_kern ::
* Validate `kern` table.
* Validate 'kern' table.
*
* FT_VALIDATE_opbd ::
* Validate `opbd` table.
* Validate 'opbd' table.
*
* FT_VALIDATE_trak ::
* Validate `trak` table.
* Validate 'trak' table.
*
* FT_VALIDATE_prop ::
* Validate `prop` table.
* Validate 'prop' table.
*
* FT_VALIDATE_lcar ::
* Validate `lcar` table.
* Validate 'lcar' table.
*
* FT_VALIDATE_GX ::
* Validate all TrueTypeGX tables (feat, mort, morx, bsln, just, kern,
@ -265,13 +265,13 @@ FT_BEGIN_HEADER
*
* @values:
* FT_VALIDATE_MS ::
* Handle the `kern` table as a classic Microsoft kern table.
* Handle the 'kern' table as a classic Microsoft kern table.
*
* FT_VALIDATE_APPLE ::
* Handle the `kern` table as a classic Apple kern table.
* Handle the 'kern' table as a classic Apple kern table.
*
* FT_VALIDATE_CKERN ::
* Handle the `kern` as either classic Apple or Microsoft kern table.
* Handle the 'kern' as either classic Apple or Microsoft kern table.
*/
#define FT_VALIDATE_MS ( FT_VALIDATE_GX_START << 0 )
#define FT_VALIDATE_APPLE ( FT_VALIDATE_GX_START << 1 )
@ -290,7 +290,7 @@ FT_BEGIN_HEADER
* library that actually does the text layout can access those tables
* without error checking (which can be quite time consuming).
*
* The `kern` table validator in @FT_TrueTypeGX_Validate deals with both
* The 'kern' table validator in @FT_TrueTypeGX_Validate deals with both
* the new 32-bit format and the classic 16-bit format, while
* FT_ClassicKern_Validate only supports the classic 16-bit format.
*

2
include/freetype/ftincrem.h
View File

@ -148,7 +148,7 @@ FT_BEGIN_HEADER
*
* Note that the format of the glyph's data bytes depends on the font
* file format. For TrueType, it must correspond to the raw bytes within
* the `glyf` table. For PostScript formats, it must correspond to the
* the 'glyf' table. For PostScript formats, it must correspond to the
* **unencrypted** charstring bytes, without any `lenIV` header. It is
* undefined for any other format.
*

8
include/freetype/ftmm.h
View File

@ -144,7 +144,7 @@ FT_BEGIN_HEADER
* Adobe MM fonts if possible.
*
* strid ::
* The axis name entry in the font's `name` table. This is another
* The axis name entry in the font's 'name' table. This is another
* (and often better) version of the 'name' field for TrueType GX or
* OpenType variation fonts. Not meaningful for Adobe MM fonts.
*
@ -184,10 +184,10 @@ FT_BEGIN_HEADER
* entry for each axis.
*
* strid ::
* The entry in `name` table identifying this instance.
* The entry in 'name' table identifying this instance.
*
* psid ::
* The entry in `name` table identifying a PostScript name for this
* The entry in 'name' table identifying a PostScript name for this
* instance. Value 0xFFFF indicates a missing entry.
*/
typedef struct FT_Var_Named_Style_
@ -222,7 +222,7 @@ FT_BEGIN_HEADER
*
* num_namedstyles ::
* The number of named styles; a 'named style' is a tuple of design
* coordinates that has a string ID (in the `name` table) associated
* coordinates that has a string ID (in the 'name' table) associated
* with it. The font can tell the user that, for example,
* [Weight=1.5,Width=1.1] is 'Bold'. Another name for 'named style' is
* 'named instance'.

4
include/freetype/ftparams.h
View File

@ -58,7 +58,7 @@ FT_BEGIN_HEADER
*
* @description:
* A tag for @FT_Parameter to make @FT_Open_Face ignore typographic
* family names in the `name` table (introduced in OpenType version 1.4).
* family names in the 'name' table (introduced in OpenType version 1.4).
* Use this for backward compatibility with legacy systems that have a
* four-faces-per-family restriction.
*
@ -82,7 +82,7 @@ FT_BEGIN_HEADER
*
* @description:
* A tag for @FT_Parameter to make @FT_Open_Face ignore typographic
* subfamily names in the `name` table (introduced in OpenType version
* subfamily names in the 'name' table (introduced in OpenType version
* 1.4). Use this for backward compatibility with legacy systems that
* have a four-faces-per-family restriction.
*

24
include/freetype/ftsnames.h
View File

@ -2,7 +2,7 @@
*
* ftsnames.h
*
* Simple interface to access SFNT `name` tables (which are used
* Simple interface to access SFNT 'name' tables (which are used
* to hold font names, copyright info, notices, etc.) (specification).
*
* This is _not_ used to retrieve glyph names!
@ -50,7 +50,7 @@ FT_BEGIN_HEADER
*
* @description:
* The TrueType and OpenType specifications allow the inclusion of a
* special names table (`name`) in font files. This table contains
* special names table ('name') in font files. This table contains
* textual (and internationalized) information regarding the font, like
* family name, copyright, version, etc.
*
@ -67,7 +67,7 @@ FT_BEGIN_HEADER
* FT_SfntName
*
* @description:
* A structure used to model an SFNT `name` table entry.
* A structure used to model an SFNT 'name' table entry.
*
* @fields:
* platform_id ::
@ -124,14 +124,14 @@ FT_BEGIN_HEADER
* FT_Get_Sfnt_Name_Count
*
* @description:
* Retrieve the number of name strings in the SFNT `name` table.
* Retrieve the number of name strings in the SFNT 'name' table.
*
* @input:
* face ::
* A handle to the source face.
*
* @return:
* The number of strings in the `name` table.
* The number of strings in the 'name' table.
*
* @note:
* This function always returns an error if the config macro
@ -147,7 +147,7 @@ FT_BEGIN_HEADER
* FT_Get_Sfnt_Name
*
* @description:
* Retrieve a string of the SFNT `name` table for a given index.
* Retrieve a string of the SFNT 'name' table for a given index.
*
* @input:
* face ::
@ -169,10 +169,10 @@ FT_BEGIN_HEADER
* yourself; FreeType takes care of it if you call @FT_Done_Face.
*
* Use @FT_Get_Sfnt_Name_Count to get the total number of available
* `name` table entries, then do a loop until you get the right platform,
* 'name' table entries, then do a loop until you get the right platform,
* encoding, and name ID.
*
* `name` table format~1 entries can use language tags also, see
* 'name' table format~1 entries can use language tags also, see
* @FT_Get_Sfnt_LangTag.
*
* This function always returns an error if the config macro
@ -190,7 +190,7 @@ FT_BEGIN_HEADER
* FT_SfntLangTag
*
* @description:
* A structure to model a language tag entry from an SFNT `name` table.
* A structure to model a language tag entry from an SFNT 'name' table.
*
* @fields:
* string ::
@ -222,7 +222,7 @@ FT_BEGIN_HEADER
*
* @description:
* Retrieve the language tag associated with a language ID of an SFNT
* `name` table entry.
* 'name' table entry.
*
* @input:
* face ::
@ -234,7 +234,7 @@ FT_BEGIN_HEADER
*
* @output:
* alangTag ::
* The language tag associated with the `name` table entry's language
* The language tag associated with the 'name' table entry's language
* ID.
*
* @return:
@ -245,7 +245,7 @@ FT_BEGIN_HEADER
* null-terminated. Note that you don't have to deallocate `string` by
* yourself; FreeType takes care of it if you call @FT_Done_Face.
*
* Only `name` table format~1 supports language tags. For format~0
* Only 'name' table format~1 supports language tags. For format~0
* tables, this function always returns FT_Err_Invalid_Table. For
* invalid format~1 language ID values, FT_Err_Invalid_Argument is
* returned.

4
include/freetype/internal/tttypes.h
View File

@ -58,7 +58,7 @@ FT_BEGIN_HEADER
*
* @fields:
* tag ::
* Must be 'ttc ' to indicate a TrueType collection.
* Must be 'ttc~' to indicate a TrueType collection.
*
* version ::
* The version number.
@ -1395,7 +1395,7 @@ FT_BEGIN_HEADER
*
* cvt ::
* The face's original control value table. Coordinates are expressed
* in unscaled font units. Comes from the 'cvt ' table. Ignored for
* in unscaled font units. Comes from the 'cvt~' table. Ignored for
* Type 2 fonts.
*
* interpreter ::

12
include/freetype/ttnameid.h
View File

@ -36,7 +36,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* Possible values for the 'platform' identifier code in the name records
* of an SFNT `name` table.
* of an SFNT 'name' table.
*
*/
@ -291,7 +291,7 @@ FT_BEGIN_HEADER
*
* @description:
* Possible values of the language identifier field in the name records
* of the SFNT `name` table if the 'platform' identifier code is
* of the SFNT 'name' table if the 'platform' identifier code is
* @TT_PLATFORM_MACINTOSH. These values are also used as return values
* for function @FT_Get_CMap_Language_ID.
*
@ -431,7 +431,7 @@ FT_BEGIN_HEADER
*
* @description:
* Possible values of the language identifier field in the name records
* of the SFNT `name` table if the 'platform' identifier code is
* of the SFNT 'name' table if the 'platform' identifier code is
* @TT_PLATFORM_MICROSOFT. These values are also used as return values
* for function @FT_Get_CMap_Language_ID.
*
@ -441,7 +441,7 @@ FT_BEGIN_HEADER
*
* however, we only provide macros for language identifiers present in
* the OpenType specification: Microsoft has abandoned the concept of
* LCIDs (language code identifiers), and format~1 of the `name` table
* LCIDs (language code identifiers), and format~1 of the 'name' table
* provides a better mechanism for languages not covered here.
*
* More legacy values not listed in the reference can be found in the
@ -787,7 +787,7 @@ FT_BEGIN_HEADER
*
* @description:
* Possible values of the 'name' identifier field in the name records of
* an SFNT `name` table. These values are platform independent.
* an SFNT 'name' table. These values are platform independent.
*/
#define TT_NAME_ID_COPYRIGHT 0
@ -841,7 +841,7 @@ FT_BEGIN_HEADER
*
* @description:
* Possible bit mask values for the `ulUnicodeRangeX` fields in an SFNT
* `OS/2` table.
* 'OS/2' table.
*/
/* ulUnicodeRange1 */

56
include/freetype/tttables.h
View File

@ -117,8 +117,8 @@ FT_BEGIN_HEADER
* TT_HoriHeader
*
* @description:
* A structure to model a TrueType horizontal header, the `hhea` table,
* as well as the corresponding horizontal metrics table, `hmtx`.
* A structure to model a TrueType horizontal header, the 'hhea' table,
* as well as the corresponding horizontal metrics table, 'hmtx'.
*
* @fields:
* Version ::
@ -132,7 +132,7 @@ FT_BEGIN_HEADER
* font designer, and often reflects only a portion of the glyphs found
* in the font (maybe ASCII).
*
* You should use the `sTypoAscender` field of the `OS/2` table instead
* You should use the `sTypoAscender` field of the 'OS/2' table instead
* if you want the correct one.
*
* Descender ::
@ -143,7 +143,7 @@ FT_BEGIN_HEADER
* font designer, and often reflects only a portion of the glyphs found
* in the font (maybe ASCII).
*
* You should use the `sTypoDescender` field of the `OS/2` table
* You should use the `sTypoDescender` field of the 'OS/2' table
* instead if you want the correct one.
*
* Line_Gap ::
@ -183,19 +183,19 @@ FT_BEGIN_HEADER
* Always~0.
*
* number_Of_HMetrics ::
* Number of HMetrics entries in the `hmtx` table -- this value can be
* Number of HMetrics entries in the 'hmtx' table -- this value can be
* smaller than the total number of glyphs in the font.
*
* long_metrics ::
* A pointer into the `hmtx` table.
* A pointer into the 'hmtx' table.
*
* short_metrics ::
* A pointer into the `hmtx` table.
* A pointer into the 'hmtx' table.
*
* @note:
* For an OpenType variation font, the values of the following fields can
* change after a call to @FT_Set_Var_Design_Coordinates (and friends) if
* the font contains an `MVAR` table: `caret_Slope_Rise`,
* the font contains an 'MVAR' table: `caret_Slope_Rise`,
* `caret_Slope_Run`, and `caret_Offset`.
*/
typedef struct TT_HoriHeader_
@ -221,7 +221,7 @@ FT_BEGIN_HEADER
/* The following fields are not defined by the OpenType specification */
/* but they are used to connect the metrics header to the relevant */
/* `hmtx` table. */
/* 'hmtx' table. */
void* long_metrics;
void* short_metrics;
@ -235,8 +235,8 @@ FT_BEGIN_HEADER
* TT_VertHeader
*
* @description:
* A structure used to model a TrueType vertical header, the `vhea`
* table, as well as the corresponding vertical metrics table, `vmtx`.
* A structure used to model a TrueType vertical header, the 'vhea'
* table, as well as the corresponding vertical metrics table, 'vmtx'.
*
* @fields:
* Version ::
@ -250,7 +250,7 @@ FT_BEGIN_HEADER
* font designer, and often reflects only a portion of the glyphs found
* in the font (maybe ASCII).
*
* You should use the `sTypoAscender` field of the `OS/2` table instead
* You should use the `sTypoAscender` field of the 'OS/2' table instead
* if you want the correct one.
*
* Descender ::
@ -261,7 +261,7 @@ FT_BEGIN_HEADER
* font designer, and often reflects only a portion of the glyphs found
* in the font (maybe ASCII).
*
* You should use the `sTypoDescender` field of the `OS/2` table
* You should use the `sTypoDescender` field of the 'OS/2' table
* instead if you want the correct one.
*
* Line_Gap ::
@ -301,19 +301,19 @@ FT_BEGIN_HEADER
* Always~0.
*
* number_Of_VMetrics ::
* Number of VMetrics entries in the `vmtx` table -- this value can be
* Number of VMetrics entries in the 'vmtx' table -- this value can be
* smaller than the total number of glyphs in the font.
*
* long_metrics ::
* A pointer into the `vmtx` table.
* A pointer into the 'vmtx' table.
*
* short_metrics ::
* A pointer into the `vmtx` table.
* A pointer into the 'vmtx' table.
*
* @note:
* For an OpenType variation font, the values of the following fields can
* change after a call to @FT_Set_Var_Design_Coordinates (and friends) if
* the font contains an `MVAR` table: `Ascender`, `Descender`,
* the font contains an 'MVAR' table: `Ascender`, `Descender`,
* `Line_Gap`, `caret_Slope_Rise`, `caret_Slope_Run`, and `caret_Offset`.
*/
typedef struct TT_VertHeader_
@ -339,7 +339,7 @@ FT_BEGIN_HEADER
/* The following fields are not defined by the OpenType specification */
/* but they are used to connect the metrics header to the relevant */
/* `vmtx` table. */
/* 'vmtx' table. */
void* long_metrics;
void* short_metrics;
@ -353,16 +353,16 @@ FT_BEGIN_HEADER
* TT_OS2
*
* @description:
* A structure to model a TrueType `OS/2` table. All fields comply to
* A structure to model a TrueType 'OS/2' table. All fields comply to
* the OpenType specification.
*
* Note that we now support old Mac fonts that do not include an `OS/2`
* Note that we now support old Mac fonts that do not include an 'OS/2'
* table. In this case, the `version` field is always set to 0xFFFF.
*
* @note:
* For an OpenType variation font, the values of the following fields can
* change after a call to @FT_Set_Var_Design_Coordinates (and friends) if
* the font contains an `MVAR` table: `sCapHeight`, `sTypoAscender`,
* the font contains an 'MVAR' table: `sCapHeight`, `sTypoAscender`,
* `sTypoDescender`, `sTypoLineGap`, `sxHeight`, `usWinAscent`,
* `usWinDescent`, `yStrikeoutPosition`, `yStrikeoutSize`,
* `ySubscriptXOffset`, `ySubScriptXSize`, `ySubscriptYOffset`,
@ -437,7 +437,7 @@ FT_BEGIN_HEADER
* TT_Postscript
*
* @description:
* A structure to model a TrueType `post` table. All fields comply to
* A structure to model a TrueType 'post' table. All fields comply to
* the OpenType specification. This structure does not reference a
* font's PostScript glyph names; use @FT_Get_Glyph_Name to retrieve
* them.
@ -445,7 +445,7 @@ FT_BEGIN_HEADER
* @note:
* For an OpenType variation font, the values of the following fields can
* change after a call to @FT_Set_Var_Design_Coordinates (and friends) if
* the font contains an `MVAR` table: `underlinePosition` and
* the font contains an 'MVAR' table: `underlinePosition` and
* `underlineThickness`.
*/
typedef struct TT_Postscript_
@ -460,7 +460,7 @@ FT_BEGIN_HEADER
FT_ULong minMemType1;
FT_ULong maxMemType1;
/* Glyph names follow in the `post` table, but we don't */
/* Glyph names follow in the 'post' table, but we don't */
/* load them by default. */
} TT_Postscript;
@ -472,7 +472,7 @@ FT_BEGIN_HEADER
* TT_PCLT
*
* @description:
* A structure to model a TrueType `PCLT` table. All fields comply to
* A structure to model a TrueType 'PCLT' table. All fields comply to
* the OpenType specification.
*/
typedef struct TT_PCLT_
@ -502,7 +502,7 @@ FT_BEGIN_HEADER
* TT_MaxProfile
*
* @description:
* The maximum profile (`maxp`) table contains many max values, which can
* The maximum profile ('maxp') table contains many max values, which can
* be used to pre-allocate arrays for speeding up glyph loading and
* hinting.
*
@ -673,7 +673,7 @@ FT_BEGIN_HEADER
* list.
*
* @example:
* Here an example how to access the `vhea` table.
* Here an example how to access the 'vhea' table.
*
* ```
* TT_VertHeader* vert_header;
@ -832,7 +832,7 @@ FT_BEGIN_HEADER
* FT_Get_CMap_Format
*
* @description:
* Return the format of an SFNT `cmap` table.
* Return the format of an SFNT 'cmap' table.
*
* @input:
* charmap ::