[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[freetype2] GSoC-2018-nikhil 628ca69 4/4: * include/*.*: `Markify' heade
|
From: |
Nikhil Ramakrishnan |
|
Subject: |
[freetype2] GSoC-2018-nikhil 628ca69 4/4: * include/*.*: `Markify' header files. |
|
Date: |
Thu, 26 Jul 2018 08:27:38 -0400 (EDT) |
branch: GSoC-2018-nikhil
commit 628ca693b6c34c0cd8197977f0085cfc7b3855d1
Author: Nikhil Ramakrishnan <address@hidden>
Commit: nikramakrishnan <address@hidden>
* include/*.*: `Markify' header files.
Change header file comments to markodwn syntax.
Applied `markify' from https://github.com/nikramakrishnan/freetype-docs
commit 993cc36ef28600bfb6c5c5612ace4cd2b9138fe8.
---
include/freetype/config/ftheader.h | 10 +-
include/freetype/freetype.h | 548 +++++++++++++-------------
include/freetype/ftadvanc.h | 8 +-
include/freetype/ftbdf.h | 8 +-
include/freetype/ftbitmap.h | 32 +-
include/freetype/ftbzip2.h | 8 +-
include/freetype/ftcache.h | 72 ++--
include/freetype/ftcolor.h | 56 +--
include/freetype/ftdriver.h | 298 +++++++-------
include/freetype/fterrdef.h | 18 +-
include/freetype/fterrors.h | 40 +-
include/freetype/ftfntfmt.h | 6 +-
include/freetype/ftgasp.h | 22 +-
include/freetype/ftglyph.h | 50 +--
include/freetype/ftgxval.h | 36 +-
include/freetype/ftgzip.h | 16 +-
include/freetype/ftimage.h | 114 +++---
include/freetype/ftincrem.h | 14 +-
include/freetype/ftlcdfil.h | 16 +-
include/freetype/ftlzw.h | 8 +-
include/freetype/ftmac.h | 8 +-
include/freetype/ftmm.h | 62 +--
include/freetype/ftmodapi.h | 52 +--
include/freetype/ftoutln.h | 44 +--
include/freetype/ftparams.h | 6 +-
include/freetype/ftpfr.h | 12 +-
include/freetype/ftrender.h | 2 +-
include/freetype/ftsizes.h | 12 +-
include/freetype/ftsnames.h | 56 +--
include/freetype/ftstroke.h | 52 +--
include/freetype/ftsystem.h | 12 +-
include/freetype/fttrigon.h | 6 +-
include/freetype/fttypes.h | 22 +-
include/freetype/ftwinfnt.h | 16 +-
include/freetype/internal/cffotypes.h | 2 +-
include/freetype/internal/ftcalc.h | 10 +-
include/freetype/internal/ftdebug.h | 2 +-
include/freetype/internal/ftdrv.h | 12 +-
include/freetype/internal/ftmemory.h | 2 +-
include/freetype/internal/ftobjs.h | 6 +-
include/freetype/internal/ftrfork.h | 26 +-
include/freetype/internal/ftserv.h | 8 +-
include/freetype/internal/psaux.h | 2 +-
include/freetype/internal/pshints.h | 52 +--
include/freetype/internal/services/svttcmap.h | 2 +-
include/freetype/internal/sfnt.h | 46 +--
include/freetype/internal/tttypes.h | 148 +++----
include/freetype/t1tables.h | 18 +-
include/freetype/ttnameid.h | 34 +-
include/freetype/tttables.h | 122 +++---
50 files changed, 1117 insertions(+), 1117 deletions(-)
diff --git a/include/freetype/config/ftheader.h
b/include/freetype/config/ftheader.h
index bb96837..9f0f5e1 100644
--- a/include/freetype/config/ftheader.h
+++ b/include/freetype/config/ftheader.h
@@ -77,16 +77,16 @@
* FreeType~2 header files. They can be used directly in #include
* statements as in:
*
- * {
+ * ```
* #include FT_FREETYPE_H
* #include FT_MULTIPLE_MASTERS_H
* #include FT_GLYPH_H
- * }
+ * ```
*
* There are several reasons why we are now using macros to name
* public header files. The first one is that such macros are not
* limited to the infamous 8.3~naming rule required by DOS (and
- * `FT_MULTIPLE_MASTERS_H' is a lot more meaningful than `ftmm.h').
+ * `FT_MULTIPLE_MASTERS_H` is a lot more meaningful than `ftmm.h`).
*
* The second reason is that it allows for more flexibility in the
* way FreeType~2 is installed on a given system.
@@ -436,7 +436,7 @@
*
* @description:
* A macro used in #include statements to name the file containing the
- * definitions of TrueType four-byte `tags' which identify blocks in
+ * definitions of TrueType four-byte 'tags' which identify blocks in
* SFNT-based font formats (i.e., TrueType and OpenType).
*
*/
@@ -612,7 +612,7 @@
*
* @description:
* A macro used in #include statements to name the file containing the
- * optional FreeType~2 API which accesses embedded `name' strings in
+ * optional FreeType~2 API which accesses embedded 'name' strings in
* SFNT-based font formats (i.e., TrueType and OpenType).
*
*/
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index 92a4b44..4925ec3 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -55,17 +55,17 @@ FT_BEGIN_HEADER
* FreeType uses a very special inclusion scheme to load header
* files, for example
*
- * {
+ * ```
* #include <ft2build.h>
*
* #include FT_FREETYPE_H
* #include FT_OUTLINE_H
- * }
+ * ```
*
* A compiler and its preprocessor only needs an include path to find
- * the file `ft2build.h'; the exact locations and names of the other
+ * the file `ft2build.h`; the exact locations and names of the other
* FreeType header files are hidden by @header_file_macros, loaded by
- * `ft2build.h'. The API documentation always gives the header macro
+ * `ft2build.h`. The API documentation always gives the header macro
* name needed for a particular function.
*
*/
@@ -85,8 +85,8 @@ FT_BEGIN_HEADER
* @description:
* FreeType assumes that structures allocated by the user and passed
* as arguments are zeroed out except for the actual data. In other
- * words, it is recommended to use `calloc' (or variants of it)
- * instead of `malloc' for allocation.
+ * words, it is recommended to use 'calloc' (or variants of it)
+ * instead of 'malloc' for allocation.
*
*/
@@ -306,13 +306,13 @@ FT_BEGIN_HEADER
* dimensions of the hinted glyph (in case hinting is applicable).
*
* Stroking a glyph with an outside border does not increase
- * `horiAdvance' or `vertAdvance'; you have to manually adjust these
+ * `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
+ * 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.
+ * `vertBearingY + height` after loading a glyph.
*/
typedef struct FT_Glyph_Metrics_
{
@@ -338,7 +338,7 @@ FT_BEGIN_HEADER
* @description:
* This structure models the metrics of a bitmap strike (i.e., a set
* of glyphs for a given point size and resolution) in a bitmap font.
- * It is used for the `available_sizes' field of @FT_Face.
+ * It is used for the `available_sizes` field of @FT_Face.
*
* @fields:
* height ::
@@ -364,12 +364,12 @@ FT_BEGIN_HEADER
* @note:
* Windows FNT:
* The nominal size given in a FNT font is not reliable. If the
- * driver finds it incorrect, it sets `size' to some calculated
- * values, and `x_ppem' and `y_ppem' to the pixel width and height
+ * driver finds it incorrect, it sets 'size' to some calculated
+ * values, and `x_ppem` and `y_ppem` to the pixel width and height
* given in the font, respectively.
*
* TrueType embedded bitmaps:
- * `size', `width', and `height' values are not contained in the
+ * 'size', 'width', and 'height' values are not contained in the
* bitmap strike itself. They are computed from the global font
* parameters.
*/
@@ -400,16 +400,16 @@ FT_BEGIN_HEADER
* FT_Library
*
* @description:
- * A handle to a FreeType library instance. Each `library' is
- * completely independent from the others; it is the `root' of a set
+ * A handle to a FreeType library instance. Each 'library' is
+ * completely independent from the others; it is the 'root' of a set
* of objects like fonts, faces, sizes, etc.
*
* It also embeds a memory manager (see @FT_Memory), as well as a
* scan-line converter object (see @FT_Raster).
*
* In multi-threaded applications it is easiest to use one
- * `FT_Library' object per thread. In case this is too cumbersome,
- * a single `FT_Library' object across threads is possible also
+ * `FT_Library` object per thread. In case this is too cumbersome,
+ * a single `FT_Library` object across threads is possible also
* (since FreeType version 2.5.6), as long as a mutex lock is used
* around @FT_New_Face and @FT_Done_Face.
*
@@ -493,12 +493,12 @@ FT_BEGIN_HEADER
*
* Use @FT_Done_Face to destroy it (along with its slot and sizes).
*
- * An `FT_Face' object can only be safely used from one thread at a
- * time. Similarly, creation and destruction of `FT_Face' with the
+ * An `FT_Face` object can only be safely used from one thread at a
+ * time. Similarly, creation and destruction of `FT_Face` with the
* same @FT_Library object can only be done from one thread at a
* time. On the other hand, functions like @FT_Load_Glyph and its
* siblings are thread-safe and do not need the lock to be held as
- * long as the same `FT_Face' object is not used from multiple
+ * long as the same `FT_Face` object is not used from multiple
* threads at the same time.
*
* @also:
@@ -545,7 +545,7 @@ FT_BEGIN_HEADER
* FT_GlyphSlot
*
* @description:
- * A handle to a given `glyph slot'. A slot is a container that can
+ * A handle to a given 'glyph slot'. A slot is a container that can
* hold any of the glyphs contained in its parent face.
*
* In other words, each time you call @FT_Load_Glyph or
@@ -565,26 +565,26 @@ FT_BEGIN_HEADER
* FT_CharMap
*
* @description:
- * A handle to a character map (usually abbreviated to `charmap'). A
+ * A handle to a character map (usually abbreviated to 'charmap'). A
* charmap is used to translate character codes in a given encoding
* into glyph indexes for its parent's face. Some font formats may
* provide several charmaps per font.
*
* Each face object owns zero or more charmaps, but only one of them
- * can be `active', providing the data used by @FT_Get_Char_Index or
+ * can be 'active', providing the data used by @FT_Get_Char_Index or
* @FT_Load_Char.
*
* The list of available charmaps in a face is available through the
- * `face->num_charmaps' and `face->charmaps' fields of @FT_FaceRec.
+ * `face->num_charmaps` and `face->charmaps` fields of @FT_FaceRec.
*
- * The currently active charmap is available as `face->charmap'.
+ * The currently active charmap is available as `face->charmap`.
* You should call @FT_Set_Charmap to change it.
*
* @note:
* When a new face is created (either through @FT_New_Face or
* @FT_Open_Face), the library looks for a Unicode charmap within
* the list and automatically activates it. If there is no Unicode
- * charmap, FreeType doesn't set an `active' charmap.
+ * charmap, FreeType doesn't set an 'active' charmap.
*
* @also:
* See @FT_CharMapRec for the publicly accessible fields of a given
@@ -600,16 +600,16 @@ FT_BEGIN_HEADER
*
* @description:
* This macro converts four-letter tags into an unsigned long. It is
- * used to define `encoding' identifiers (see @FT_Encoding).
+ * used to define 'encoding' identifiers (see @FT_Encoding).
*
* @note:
* Since many 16-bit compilers don't like 32-bit enumerations, you
* should redefine this macro in case of problems to something like
* this:
*
- * {
+ * ```
* #define FT_ENC_TAG( value, a, b, c, d ) value
- * }
+ * ```
*
* to get a simple enumeration without assigning special numbers.
*/
@@ -657,16 +657,16 @@ FT_BEGIN_HEADER
* FT_ENCODING_MS_SYMBOL ::
* Microsoft Symbol encoding, used to encode mathematical symbols
* and wingdings. For more information, see
- * `https://www.microsoft.com/typography/otspec/recom.htm',
- * `http://www.kostis.net/charsets/symbol.htm', and
- * `http://www.kostis.net/charsets/wingding.htm'.
+ * 'https://www.microsoft.com/typography/otspec/recom.htm',
+ * 'http://www.kostis.net/charsets/symbol.htm', and
+ * 'http://www.kostis.net/charsets/wingding.htm'.
*
* This encoding uses character codes from the PUA (Private Unicode
* Area) in the range U+F020-U+F0FF.
*
* FT_ENCODING_SJIS ::
* Shift JIS encoding for Japanese. More info at
- * `https://en.wikipedia.org/wiki/Shift_JIS'. See note on
+ * 'https://en.wikipedia.org/wiki/Shift_JIS'. See note on
* multi-byte encodings below.
*
* FT_ENCODING_PRC ::
@@ -682,7 +682,7 @@ FT_BEGIN_HEADER
* Corresponds to the Korean encoding system known as Extended
* Wansung (MS Windows code page 949).
* For more information see
- *
`https://www.unicode.org/Public/MAPPINGS/VENDORS/MICSFT/WindowsBestFit/bestfit949.txt'.
+ *
'https://www.unicode.org/Public/MAPPINGS/VENDORS/MICSFT/WindowsBestFit/bestfit949.txt'.
*
* FT_ENCODING_JOHAB ::
* The Korean standard character set (KS~C 5601-1992), which
@@ -741,21 +741,21 @@ FT_BEGIN_HEADER
* is neither Unicode nor ISO-8859-1 (otherwise it is set to
* FT_ENCODING_UNICODE). Use @FT_Get_BDF_Charset_ID to find out
* which encoding is really present. If, for example, the
- * `cs_registry' field is `KOI8' and the `cs_encoding' field is `R',
+ * `cs_registry` field is 'KOI8' and the `cs_encoding` field is 'R',
* the font is encoded in KOI8-R.
*
* FT_ENCODING_NONE is always set (with a single exception) by the
* winfonts driver. Use @FT_Get_WinFNT_Header and examine the
- * `charset' field of the @FT_WinFNT_HeaderRec structure to find out
+ * 'charset' field of the @FT_WinFNT_HeaderRec structure to find out
* which encoding is really present. For example,
* @FT_WinFNT_ID_CP1251 (204) means Windows code page 1251 (for
* Russian).
*
- * FT_ENCODING_NONE is set if `platform_id' is @TT_PLATFORM_MACINTOSH
- * and `encoding_id' is not `TT_MAC_ID_ROMAN' (otherwise it is set to
+ * FT_ENCODING_NONE is set if `platform_id` is @TT_PLATFORM_MACINTOSH
+ * and `encoding_id` is not `TT_MAC_ID_ROMAN` (otherwise it is set to
* FT_ENCODING_APPLE_ROMAN).
*
- * If `platform_id' is @TT_PLATFORM_MACINTOSH, use the function
+ * If `platform_id` is @TT_PLATFORM_MACINTOSH, use the function
* @FT_Get_CMap_Language_ID to query the Mac language ID that may
* be needed to be able to distinguish Apple encoding variants. See
*
@@ -763,10 +763,10 @@ FT_BEGIN_HEADER
*
* to get an idea how to do that. Basically, if the language ID
* is~0, don't use it, otherwise subtract 1 from the language ID.
- * Then examine `encoding_id'. If, for example, `encoding_id' is
- * `TT_MAC_ID_ROMAN' and the language ID (minus~1) is
- * `TT_MAC_LANGID_GREEK', it is the Greek encoding, not Roman.
- * `TT_MAC_ID_ARABIC' with `TT_MAC_LANGID_FARSI' means the Farsi
+ * Then examine `encoding_id`. If, for example, `encoding_id` is
+ * `TT_MAC_ID_ROMAN` and the language ID (minus~1) is
+ * `TT_MAC_LANGID_GREEK`, it is the Greek encoding, not Roman.
+ * `TT_MAC_ID_ARABIC` with `TT_MAC_LANGID_FARSI` means the Farsi
* variant the Arabic encoding.
*/
typedef enum FT_Encoding_
@@ -872,7 +872,7 @@ FT_BEGIN_HEADER
* FT_Face_Internal
*
* @description:
- * An opaque handle to an `FT_Face_InternalRec' structure that models
+ * An opaque handle to an `FT_Face_InternalRec` structure that models
* the private data of a given @FT_Face object.
*
* This structure might change between releases of FreeType~2 and is
@@ -910,11 +910,11 @@ FT_BEGIN_HEADER
* indicates font access without a named
* instance). For non-variation fonts, bits
* 16-30 are ignored. If we have the third
- * named instance of face~4, say, `face_index'
+ * named instance of face~4, say, `face_index`
* is set to 0x00030004.
*
* Bit 31 is always zero (this is,
- * `face_index' is always a positive value).
+ * `face_index` is always a positive value).
*
* [Since 2.9] Changing the design coordinates
* with @FT_Set_Var_Design_Coordinates or
@@ -936,7 +936,7 @@ FT_BEGIN_HEADER
* of named instances available for the
* current face if we have a GX or OpenType
* variation (sub)font. Bit 31 is always zero
- * (this is, `style_flags' is always a
+ * (this is, `style_flags` is always a
* positive value). Note that a variation
* font has always at least one named
* instance, namely the default instance.
@@ -944,7 +944,7 @@ FT_BEGIN_HEADER
* num_glyphs ::
* The number of glyphs in the face. If the
* face is scalable and has sbits (see
- * `num_fixed_sizes'), it is set to the number
+ * `num_fixed_sizes`), it is set to the number
* of outline glyphs.
*
* For CID-keyed fonts (not in an SFNT
@@ -953,8 +953,8 @@ FT_BEGIN_HEADER
*
* family_name ::
* The face's family name. This is an ASCII string, usually in
- * English, that describes the typeface's family (like `Times New
- * Roman', `Bodoni', `Garamond', etc). This is a least common
+ * English, that describes the typeface's family (like 'Times New
+ * Roman', 'Bodoni', 'Garamond', etc). This is a least common
* denominator used to list fonts. Some formats (TrueType & OpenType)
* provide localized and Unicode versions of this string.
* Applications should use the format-specific interface to access
@@ -967,10 +967,10 @@ FT_BEGIN_HEADER
*
* style_name ::
* The face's style name. This is an ASCII string, usually in
- * English, that describes the typeface's style (like `Italic',
- * `Bold', `Condensed', etc). Not all font formats provide a style
+ * English, that describes the typeface's style (like 'Italic',
+ * 'Bold', 'Condensed', etc). Not all font formats provide a style
* name, so this field is optional, and can be set to NULL. As for
- * `family_name', some formats provide localized and Unicode versions
+ * `family_name`, some formats provide localized and Unicode versions
* of this string. Applications should use the format-specific
* interface to access them.
*
@@ -978,7 +978,7 @@ FT_BEGIN_HEADER
* The number of bitmap strikes in the face.
* Even if the face is scalable, there might
* still be bitmap strikes, which are called
- * `sbits' in that case.
+ * 'sbits' in that case.
*
* available_sizes ::
* An array of @FT_Bitmap_Size for all bitmap
@@ -1002,10 +1002,10 @@ FT_BEGIN_HEADER
* bbox ::
* The font bounding box. Coordinates are
* expressed in font units (see
- * `units_per_EM'). The box is large enough
+ * `units_per_EM`). The box is large enough
* to contain any glyph from the font. Thus,
- * `bbox.yMax' can be seen as the `maximum
- * ascender', and `bbox.yMin' as the `minimum
+ * `bbox.yMax` can be seen as the 'maximum
+ * ascender', and `bbox.yMin` as the 'minimum
* descender'. Only relevant for scalable
* formats.
*
@@ -1023,14 +1023,14 @@ FT_BEGIN_HEADER
* The typographic ascender of the face,
* expressed in font units. For font formats
* not having this information, it is set to
- * `bbox.yMax'. Only relevant for scalable
+ * `bbox.yMax`. Only relevant for scalable
* formats.
*
* descender ::
* The typographic descender of the face,
* expressed in font units. For font formats
* not having this information, it is set to
- * `bbox.yMin'. Note that this field is
+ * `bbox.yMin`. Note that this field is
* negative for values below the baseline.
* Only relevant for scalable formats.
*
@@ -1042,7 +1042,7 @@ FT_BEGIN_HEADER
* formats.
*
* If you want the global glyph height, use
- * `ascender - descender'.
+ * 'ascender - descender'.
*
* max_advance_width ::
* The maximum advance width, in font units,
@@ -1055,7 +1055,7 @@ FT_BEGIN_HEADER
* The maximum advance height, in font units,
* for all glyphs in this face. This is only
* relevant for vertical layouts, and is set
- * to `height' for fonts that do not provide
+ * to 'height' for fonts that do not provide
* vertical metrics. Only relevant for
* scalable formats.
*
@@ -1085,9 +1085,9 @@ 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', `underline_position', and
- * `underline_thickness'.
+ * friends) if the font contains an 'MVAR' table: 'ascender',
+ * 'descender', 'height', `underline_position`, and
+ * `underline_thickness`.
*
* Especially for TrueType fonts see also the documentation for
* @FT_Size_Metrics.
@@ -1157,7 +1157,7 @@ FT_BEGIN_HEADER
* FT_FACE_FLAG_XXX
*
* @description:
- * A list of bit flags used in the `face_flags' field of the
+ * A list of bit flags used in the `face_flags` field of the
* @FT_FaceRec structure. They inform client applications of
* properties of the corresponding face.
*
@@ -1169,7 +1169,7 @@ FT_BEGIN_HEADER
*
* FT_FACE_FLAG_FIXED_SIZES ::
* The face contains bitmap strikes. See also the
- * `num_fixed_sizes' and `available_sizes' fields of @FT_FaceRec.
+ * `num_fixed_sizes` and `available_sizes` fields of @FT_FaceRec.
*
* FT_FACE_FLAG_FIXED_WIDTH ::
* The face contains fixed-width characters (like Courier, Lucida,
@@ -1191,7 +1191,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'
+ * that FreeType doesn't handle kerning data from the SFNT 'GPOS'
* table (as present in many OpenType fonts).
*
* FT_FACE_FLAG_FAST_GLYPHS ::
@@ -1218,7 +1218,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' table only if the native TrueType hinting engine (with
+ * 'gasp' table only if the native TrueType hinting engine (with
* the bytecode interpreter) is available and active.
*
* FT_FACE_FLAG_CID_KEYED ::
@@ -1227,19 +1227,19 @@ FT_BEGIN_HEADER
* fonts this has the consequence that not all index values are a
* valid argument to @FT_Load_Glyph. Only the CID values for which
* corresponding glyphs in the subsetted font exist make
- * `FT_Load_Glyph' return successfully; in all other cases you get
- * an `FT_Err_Invalid_Argument' error.
+ * `FT_Load_Glyph` return successfully; in all other cases you get
+ * an `FT_Err_Invalid_Argument` error.
*
* Note that CID-keyed fonts that are in an SFNT wrapper (this is,
* all OpenType/CFF fonts) don't have this flag set since the
* glyphs are accessed in the normal way (using contiguous
- * indices); the `CID-ness' isn't visible to the application.
+ * indices); the 'CID-ness' isn't visible to the application.
*
* FT_FACE_FLAG_TRICKY ::
- * The face is `tricky', this is, it always needs the font format's
+ * The face is 'tricky', this is, it always needs the font format's
* native hinting engine to get a reasonable result. A typical
- * example is the old Chinese font `mingli.ttf' (but not
- * `mingliu.ttc') that uses TrueType bytecode instructions to move
+ * example is the old Chinese font `mingli.ttf` (but not
+ * `mingliu.ttc`) that uses TrueType bytecode instructions to move
* and scale all of its subglyphs.
*
* It is not possible to auto-hint such fonts using
@@ -1249,7 +1249,7 @@ FT_BEGIN_HEADER
* probably never want this except for demonstration purposes.
*
* Currently, there are about a dozen TrueType fonts in the list of
- * tricky fonts; they are hard-coded in file `ttobjs.c'.
+ * tricky fonts; they are hard-coded in file `ttobjs.c`.
*
* FT_FACE_FLAG_COLOR ::
* [Since 2.5.1] The face has color glyph tables. See
@@ -1366,7 +1366,7 @@ FT_BEGIN_HEADER
*
* @description:
* A macro that returns true whenever a face object contains a font face
- * that contains fixed-width (or `monospace', `fixed-pitch', etc.)
+ * that contains fixed-width (or 'monospace', 'fixed-pitch', etc.)
* glyphs.
*
*/
@@ -1381,7 +1381,7 @@ FT_BEGIN_HEADER
*
* @description:
* A macro that returns true whenever a face object contains some
- * embedded bitmaps. See the `available_sizes' field of the
+ * embedded bitmaps. See the `available_sizes` field of the
* @FT_FaceRec structure.
*
*/
@@ -1494,7 +1494,7 @@ FT_BEGIN_HEADER
* FT_IS_TRICKY
*
* @description:
- * A macro that returns true whenever a face represents a `tricky' font.
+ * A macro that returns true whenever a face represents a 'tricky' font.
* See the discussion of @FT_FACE_FLAG_TRICKY for more details.
*
*/
@@ -1526,7 +1526,7 @@ FT_BEGIN_HEADER
*
* @description:
* A list of bit flags to indicate the style of a given face. These
- * are used in the `style_flags' field of @FT_FaceRec.
+ * are used in the `style_flags` field of @FT_FaceRec.
*
* @values:
* FT_STYLE_FLAG_ITALIC ::
@@ -1538,7 +1538,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
+ * (for example, by analyzing various fields of the 'OS/2' table in
* SFNT based fonts).
*/
#define FT_STYLE_FLAG_ITALIC ( 1 << 0 )
@@ -1551,7 +1551,7 @@ FT_BEGIN_HEADER
* FT_Size_Internal
*
* @description:
- * An opaque handle to an `FT_Size_InternalRec' structure, used to
+ * An opaque handle to an `FT_Size_InternalRec` structure, used to
* model private data of a given @FT_Size object.
*/
typedef struct FT_Size_InternalRec_* FT_Size_Internal;
@@ -1568,13 +1568,13 @@ FT_BEGIN_HEADER
* @fields:
* x_ppem ::
* The width of the scaled EM square in pixels, hence
- * the term `ppem' (pixels per EM). It is also
- * referred to as `nominal width'.
+ * the term 'ppem' (pixels per EM). It is also
+ * referred to as 'nominal width'.
*
* y_ppem ::
* The height of the scaled EM square in pixels,
- * hence the term `ppem' (pixels per EM). It is also
- * referred to as `nominal height'.
+ * hence the term 'ppem' (pixels per EM). It is also
+ * referred to as 'nominal height'.
*
* x_scale ::
* A 16.16 fractional scaling value to convert
@@ -1618,10 +1618,10 @@ FT_BEGIN_HEADER
* the corresponding @FT_FaceRec values manually, with code similar
* to the following.
*
- * {
+ * ```
* scaled_ascender = FT_MulFix( face->ascender,
* size_metrics->y_scale );
- * }
+ * ```
*
* Note that due to glyph hinting and the selected rendering mode
* these values are usually not exact; consequently, they must be
@@ -1631,10 +1631,10 @@ FT_BEGIN_HEADER
* glyphs. As this would be a definite performance hit, it is up to
* client applications to perform such computations.
*
- * The `FT_Size_Metrics' structure is valid for bitmap fonts also.
+ * The `FT_Size_Metrics` structure is valid for bitmap fonts also.
*
*
- * *TrueType* *fonts* *with* *native* *bytecode* *hinting*
+ * **TrueType fonts with native bytecode hinting**
*
* All applications that handle TrueType fonts with native hinting
* must be aware that TTFs expect different rounding of vertical font
@@ -1642,14 +1642,14 @@ FT_BEGIN_HEADER
* it wants to rely on a TTF's vertical data (for example, to
* properly align box characters vertically).
*
- * Only the application knows _in_ _advance_ that it is going to use
+ * Only the application knows _in advance_ that it is going to use
* native hinting for TTFs! FreeType, on the other hand, selects the
* hinting mode not at the time of creating an @FT_Size object but
* much later, namely while calling @FT_Load_Glyph.
*
* Here is some pseudo code that illustrates a possible solution.
*
- * {
+ * ```
* font_format = FT_Get_Font_Format( face );
*
* if ( !strcmp( font_format, "TrueType" ) &&
@@ -1668,7 +1668,7 @@ FT_BEGIN_HEADER
*
* height = size_metrics->height;
* max_advance = size_metrics->max_advance;
- * }
+ * ```
*/
typedef struct FT_Size_Metrics_
{
@@ -1743,7 +1743,7 @@ FT_BEGIN_HEADER
* FT_Slot_Internal
*
* @description:
- * An opaque handle to an `FT_Slot_InternalRec' structure, used to
+ * An opaque handle to an `FT_Slot_InternalRec` structure, used to
* model private data of a given @FT_GlyphSlot object.
*/
typedef struct FT_Slot_InternalRec_* FT_Slot_Internal;
@@ -1772,7 +1772,7 @@ FT_BEGIN_HEADER
* glyph slots per face object can be a good
* thing. As this is rare, the glyph slots are
* listed through a direct, single-linked list
- * using its `next' field.
+ * using its 'next' field.
*
* glyph_index ::
* The glyph index passed as an argument to @FT_Load_Glyph while
@@ -1816,8 +1816,8 @@ FT_BEGIN_HEADER
* (hinted) advance width for the glyph, in 26.6
* fractional pixel format. As specified with
* @FT_LOAD_VERTICAL_LAYOUT, it uses either the
- * `horiAdvance' or the `vertAdvance' value of
- * `metrics' field.
+ * `horiAdvance` or the `vertAdvance` value of
+ * 'metrics' field.
*
* format ::
* This field indicates the format of the image
@@ -1841,13 +1841,13 @@ FT_BEGIN_HEADER
* The bitmap's top bearing expressed in integer
* pixels. This is the distance from the
* baseline to the top-most glyph scanline,
- * upwards y~coordinates being *positive*.
+ * upwards y~coordinates being **positive**.
*
* outline ::
* The outline descriptor for the current glyph
* image if its format is
* @FT_GLYPH_FORMAT_OUTLINE. Once a glyph is
- * loaded, `outline' can be transformed,
+ * loaded, 'outline' can be transformed,
* distorted, emboldened, etc. However, it must
* not be freed.
*
@@ -1859,7 +1859,7 @@ FT_BEGIN_HEADER
*
* subglyphs ::
* An array of subglyph descriptors for
- * composite glyphs. There are `num_subglyphs'
+ * composite glyphs. There are `num_subglyphs`
* elements in there. Currently internal to
* FreeType.
*
@@ -1901,18 +1901,18 @@ FT_BEGIN_HEADER
*
* The renderer is in charge of transforming the native image through
* the slot's face transformation fields, then converting it into a
- * bitmap that is returned in `slot->bitmap'.
+ * bitmap that is returned in `slot->bitmap`.
*
- * Note that `slot->bitmap_left' and `slot->bitmap_top' are also used
+ * Note that `slot->bitmap_left` and `slot->bitmap_top` are also used
* to specify the position of the bitmap relative to the current pen
* position (e.g., coordinates (0,0) on the baseline). Of course,
- * `slot->format' is also changed to @FT_GLYPH_FORMAT_BITMAP.
+ * `slot->format` is also changed to @FT_GLYPH_FORMAT_BITMAP.
*
* Here is a small pseudo code fragment that shows how to use
- * `lsb_delta' and `rsb_delta' to do fractional positioning of
+ * `lsb_delta` and `rsb_delta` to do fractional positioning of
* glyphs:
*
- * {
+ * ```
* FT_GlyphSlot slot = face->glyph;
* FT_Pos origin_x = 0;
*
@@ -1930,13 +1930,13 @@ FT_BEGIN_HEADER
* origin_x += slot->advance.x;
* origin_x += slot->rsb_delta - slot->lsb_delta;
* endfor
- * }
+ * ```
*
* Here is another small pseudo code fragment that shows how to use
- * `lsb_delta' and `rsb_delta' to improve integer positioning of
+ * `lsb_delta` and `rsb_delta` to improve integer positioning of
* glyphs:
*
- * {
+ * ```
* FT_GlyphSlot slot = face->glyph;
* FT_Pos origin_x = 0;
* FT_Pos prev_rsb_delta = 0;
@@ -1959,9 +1959,9 @@ FT_BEGIN_HEADER
*
* origin_x += slot->advance.x;
* endfor
- * }
+ * ```
*
- * If you use strong auto-hinting, you *must* apply these delta
+ * If you use strong auto-hinting, you **must** apply these delta
* values! Otherwise you will experience far too large inter-glyph
* spacing at small rendering sizes in most cases. Note that it
* doesn't harm to use the above code for other hinting modes also,
@@ -2042,7 +2042,7 @@ FT_BEGIN_HEADER
* @FT_New_Library and @FT_Done_Library.
*
* If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is
- * set, this function reads the `FREETYPE_PROPERTIES' environment
+ * set, this function reads the `FREETYPE_PROPERTIES` environment
* variable to control driver properties. See section @properties
* for more.
*/
@@ -2076,7 +2076,7 @@ FT_BEGIN_HEADER
* FT_OPEN_XXX
*
* @description:
- * A list of bit field constants used within the `flags' field of the
+ * A list of bit field constants used within the 'flags' field of the
* @FT_Open_Args structure.
*
* @values:
@@ -2084,20 +2084,20 @@ FT_BEGIN_HEADER
* This is a memory-based stream.
*
* FT_OPEN_STREAM ::
- * Copy the stream from the `stream' field.
+ * Copy the stream from the 'stream' field.
*
* FT_OPEN_PATHNAME ::
* Create a new input stream from a C~path
* name.
*
* FT_OPEN_DRIVER ::
- * Use the `driver' field.
+ * Use the 'driver' field.
*
* FT_OPEN_PARAMS ::
- * Use the `num_params' and `params' fields.
+ * Use the `num_params` and 'params' fields.
*
* @note:
- * The `FT_OPEN_MEMORY', `FT_OPEN_STREAM', and `FT_OPEN_PATHNAME'
+ * The `FT_OPEN_MEMORY`, `FT_OPEN_STREAM`, and `FT_OPEN_PATHNAME`
* flags are mutually exclusive.
*/
#define FT_OPEN_MEMORY 0x1
@@ -2186,29 +2186,29 @@ FT_BEGIN_HEADER
* opening a new face.
*
* @note:
- * The stream type is determined by the contents of `flags' that
+ * The stream type is determined by the contents of 'flags' that
* are tested in the following order by @FT_Open_Face:
*
* If the @FT_OPEN_MEMORY bit is set, assume that this is a
- * memory file of `memory_size' bytes, located at `memory_address'.
+ * memory file of `memory_size` bytes, located at `memory_address`.
* The data are not copied, and the client is responsible for
* releasing and destroying them _after_ the corresponding call to
* @FT_Done_Face.
*
* Otherwise, if the @FT_OPEN_STREAM bit is set, assume that a
- * custom input stream `stream' is used.
+ * custom input stream 'stream' is used.
*
* Otherwise, if the @FT_OPEN_PATHNAME bit is set, assume that this
- * is a normal file and use `pathname' to open it.
+ * is a normal file and use 'pathname' to open it.
*
* If the @FT_OPEN_DRIVER bit is set, @FT_Open_Face only tries to
- * open the file with the driver whose handler is in `driver'.
+ * open the file with the driver whose handler is in 'driver'.
*
* If the @FT_OPEN_PARAMS bit is set, the parameters given by
- * `num_params' and `params' is used. They are ignored otherwise.
+ * `num_params` and 'params' is used. They are ignored otherwise.
*
- * Ideally, both the `pathname' and `params' fields should be tagged
- * as `const'; this is missing for API backward compatibility. In
+ * Ideally, both the 'pathname' and 'params' fields should be tagged
+ * as 'const'; this is missing for API backward compatibility. In
* other words, applications should treat them as read-only.
*/
typedef struct FT_Open_Args_
@@ -2247,7 +2247,7 @@ FT_BEGIN_HEADER
*
* @output:
* aface ::
- * A handle to a new face object. If `face_index' is
+ * A handle to a new face object. If `face_index` is
* greater than or equal to zero, it must be non-NULL.
*
* @return:
@@ -2290,7 +2290,7 @@ FT_BEGIN_HEADER
*
* @output:
* aface ::
- * A handle to a new face object. If `face_index' is
+ * A handle to a new face object. If `face_index` is
* greater than or equal to zero, it must be non-NULL.
*
* @return:
@@ -2322,7 +2322,7 @@ FT_BEGIN_HEADER
*
* @input:
* args ::
- * A pointer to an `FT_Open_Args' structure that must
+ * A pointer to an `FT_Open_Args` structure that must
* be filled by the caller.
*
* face_index ::
@@ -2337,33 +2337,33 @@ FT_BEGIN_HEADER
* with value~1; value~0 makes FreeType ignore named
* instances). For non-variation fonts, bits 16-30 are
* ignored. Assuming that you want to access the third
- * named instance in face~4, `face_index' should be set
+ * named instance in face~4, `face_index` should be set
* to 0x00030004. If you want to access face~4 without
- * variation handling, simply set `face_index' to
+ * variation handling, simply set `face_index` to
* value~4.
*
- * `FT_Open_Face' and its siblings can be used to
+ * `FT_Open_Face` and its siblings can be used to
* quickly check whether the font format of a given
* font resource is supported by FreeType. In general,
- * if the `face_index' argument is negative, the
+ * if the `face_index` argument is negative, the
* function's return value is~0 if the font format is
* recognized, or non-zero otherwise. The function
* allocates a more or less empty face handle in
- * `*aface' (if `aface' isn't NULL); the only two
+ * '*aface' (if 'aface' isn't NULL); the only two
* useful fields in this special case are
- * `face->num_faces' and `face->style_flags'. For any
- * negative value of `face_index', `face->num_faces'
+ * `face->num_faces` and `face->style_flags`. For any
+ * negative value of `face_index`, `face->num_faces`
* gives the number of faces within the font file. For
- * the negative value `-(N+1)' (with `N' a non-negative
- * 16-bit value), bits 16-30 in `face->style_flags'
- * give the number of named instances in face `N' if we
+ * the negative value '-(N+1)' (with 'N' a non-negative
+ * 16-bit value), bits 16-30 in `face->style_flags`
+ * give the number of named instances in face 'N' if we
* have a variation font (or zero otherwise). After
* examination, the returned @FT_Face structure should
* be deallocated with a call to @FT_Done_Face.
*
* @output:
* aface ::
- * A handle to a new face object. If `face_index' is
+ * A handle to a new face object. If `face_index` is
* greater than or equal to zero, it must be non-NULL.
*
* @return:
@@ -2372,14 +2372,14 @@ FT_BEGIN_HEADER
* @note:
* Unlike FreeType 1.x, this function automatically creates a glyph
* slot for the face object that can be accessed directly through
- * `face->glyph'.
+ * `face->glyph`.
*
* Each new face object created with this function also owns a
- * default @FT_Size object, accessible as `face->size'.
+ * default @FT_Size object, accessible as `face->size`.
*
* One @FT_Library instance can have multiple face objects, this is,
* @FT_Open_Face and its siblings can be called multiple times using
- * the same `library' argument.
+ * the same 'library' argument.
*
* See the discussion of reference counters in the description of
* @FT_Reference_Face.
@@ -2388,7 +2388,7 @@ FT_BEGIN_HEADER
* To loop over all faces, use code similar to the following snippet
* (omitting the error handling).
*
- * {
+ * ```
* ...
* FT_Face face;
* FT_Long i, num_faces;
@@ -2408,15 +2408,15 @@ FT_BEGIN_HEADER
* FT_Done_Face( face );
* ...
* }
- * }
+ * ```
*
- * To loop over all valid values for `face_index', use something
+ * To loop over all valid values for `face_index`, use something
* similar to the following snippet, again without error handling.
* The code accesses all faces immediately (thus only a single call
- * of `FT_Open_Face' within the do-loop), with and without named
+ * of `FT_Open_Face` within the do-loop), with and without named
* instances.
*
- * {
+ * ```
* ...
* FT_Face face;
*
@@ -2451,7 +2451,7 @@ FT_BEGIN_HEADER
* }
*
* } while ( face_idx < num_faces )
- * }
+ * ```
*/
FT_EXPORT( FT_Error )
FT_Open_Face( FT_Library library,
@@ -2490,7 +2490,7 @@ FT_BEGIN_HEADER
* FT_Attach_Stream
*
* @description:
- * `Attach' data to a face object. Normally, this is used to read
+ * 'Attach' data to a face object. Normally, this is used to read
* additional information for the face object. For example, you can
* attach an AFM file that comes with a Type~1 font to get the
* kerning values and other metrics.
@@ -2508,7 +2508,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * The meaning of the `attach' (i.e., what really happens when the
+ * The meaning of the 'attach' (i.e., what really happens when the
* new file is read) is not fixed by FreeType itself. It really
* depends on the font format (and thus the font driver).
*
@@ -2591,7 +2591,7 @@ FT_BEGIN_HEADER
* @input:
* strike_index ::
* The index of the bitmap strike in the
- * `available_sizes' field of @FT_FaceRec structure.
+ * `available_sizes` field of @FT_FaceRec structure.
*
* @return:
* FreeType error code. 0~means success.
@@ -2628,27 +2628,27 @@ FT_BEGIN_HEADER
*
* @values:
* FT_SIZE_REQUEST_TYPE_NOMINAL ::
- * The nominal size. The `units_per_EM' field of @FT_FaceRec is
+ * The nominal size. The `units_per_EM` field of @FT_FaceRec is
* used to determine both scaling values.
*
* This is the standard scaling found in most applications. In
* particular, use this size request type for TrueType fonts if
* they provide optical scaling or something similar. Note,
- * however, that `units_per_EM' is a rather abstract value which
+ * however, that `units_per_EM` is a rather abstract value which
* bears no relation to the actual size of the glyphs in a font.
*
* FT_SIZE_REQUEST_TYPE_REAL_DIM ::
- * The real dimension. The sum of the `ascender' and (minus of)
- * the `descender' fields of @FT_FaceRec is used to determine both
+ * The real dimension. The sum of the 'ascender' and (minus of)
+ * the 'descender' fields of @FT_FaceRec is used to determine both
* scaling values.
*
* FT_SIZE_REQUEST_TYPE_BBOX ::
- * The font bounding box. The width and height of the `bbox' field
+ * The font bounding box. The width and height of the 'bbox' field
* of @FT_FaceRec are used to determine the horizontal and vertical
* scaling value, respectively.
*
* FT_SIZE_REQUEST_TYPE_CELL ::
- * The `max_advance_width' field of @FT_FaceRec is used to
+ * The `max_advance_width` field of @FT_FaceRec is used to
* determine the horizontal scaling value; the vertical scaling
* value is determined the same way as
* @FT_SIZE_REQUEST_TYPE_REAL_DIM does. Finally, both scaling
@@ -2701,24 +2701,24 @@ FT_BEGIN_HEADER
*
* horiResolution ::
* The horizontal resolution (dpi, i.e., pixels per
- * inch). If set to zero, `width' is treated as a
- * 26.6 fractional *pixel* value, which gets
+ * inch). If set to zero, 'width' is treated as a
+ * 26.6 fractional **pixel** value, which gets
* internally rounded to an integer.
*
* vertResolution ::
* The vertical resolution (dpi, i.e., pixels per
- * inch). If set to zero, `height' is treated as a
- * 26.6 fractional *pixel* value, which gets
+ * inch). If set to zero, 'height' is treated as a
+ * 26.6 fractional **pixel** value, which gets
* internally rounded to an integer.
*
* @note:
- * If `width' is zero, the horizontal scaling value is set equal
+ * If 'width' is zero, the horizontal scaling value is set equal
* to the vertical scaling value, and vice versa.
*
- * If `type' is FT_SIZE_REQUEST_TYPE_SCALES, `width' and `height' are
+ * If 'type' is FT_SIZE_REQUEST_TYPE_SCALES, 'width' and 'height' are
* interpreted directly as 16.16 fractional scaling values, without
- * any further modification, and both `horiResolution' and
- * `vertResolution' are ignored.
+ * any further modification, and both `horiResolution` and
+ * `vertResolution` are ignored.
*/
typedef struct FT_Size_RequestRec_
{
@@ -2771,7 +2771,7 @@ FT_BEGIN_HEADER
* size is dependent entirely on how the size is defined in the
* source face. The font designer chooses the final size of each
* glyph relative to this size. For more information refer to
- * `https://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html'.
+ * 'https://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html'.
*
* Contrary to @FT_Set_Char_Size, this function doesn't have special
* code to normalize zero-valued widths, heights, or resolutions
@@ -2904,12 +2904,12 @@ FT_BEGIN_HEADER
* The loaded glyph may be transformed. See @FT_Set_Transform for
* the details.
*
- * For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument' is
+ * For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument` is
* returned for invalid CID values (this is, for CID values that
* don't have a corresponding glyph in the font). See the discussion
* of the @FT_FACE_FLAG_CID_KEYED flag for more details.
*
- * If you receive `FT_Err_Glyph_Too_Big', try getting the glyph
+ * If you receive `FT_Err_Glyph_Too_Big`, try getting the glyph
* outline at EM size, then scale it manually and fill it as a
* graphics operation.
*/
@@ -2955,7 +2955,7 @@ FT_BEGIN_HEADER
* since its glyph indices are not listed in any of the font's
* charmaps.
*
- * If no active cmap is set up (i.e., `face->charmap' is zero), the
+ * If no active cmap is set up (i.e., `face->charmap` is zero), the
* call to @FT_Get_Char_Index is omitted, and the function behaves
* identically to @FT_Load_Glyph.
*/
@@ -2986,7 +2986,7 @@ FT_BEGIN_HEADER
*
* 2. If no embedded bitmap is searched for or found, FreeType looks
* for a scalable outline. If one is found, it is loaded from
- * the font file, scaled to device pixels, then `hinted' to the
+ * the font file, scaled to device pixels, then 'hinted' to the
* pixel grid in order to optimize it. The outline data can be
* accessed from the glyph slot (see note below).
*
@@ -3000,14 +3000,14 @@ FT_BEGIN_HEADER
* This flag implies @FT_LOAD_NO_HINTING and @FT_LOAD_NO_BITMAP, and
* unsets @FT_LOAD_RENDER.
*
- * If the font is `tricky' (see @FT_FACE_FLAG_TRICKY for more), using
+ * If the font is 'tricky' (see @FT_FACE_FLAG_TRICKY for more), using
* FT_LOAD_NO_SCALE usually yields meaningless outlines because the
* subglyphs must be scaled and positioned with hinting instructions.
* This can be solved by loading the font without FT_LOAD_NO_SCALE and
- * setting the character size to `font->units_per_EM'.
+ * setting the character size to `font->units_per_EM`.
*
* FT_LOAD_NO_HINTING ::
- * Disable hinting. This generally generates `blurrier' bitmap glyphs
+ * Disable hinting. This generally generates 'blurrier' bitmap glyphs
* when the glyph are rendered in any of the anti-aliased modes. See
* also the note below.
*
@@ -3028,8 +3028,8 @@ FT_BEGIN_HEADER
*
* FT_LOAD_VERTICAL_LAYOUT ::
* Load the glyph for vertical text layout. In particular, the
- * `advance' value in the @FT_GlyphSlotRec structure is set to the
- * `vertAdvance' value of the `metrics' field.
+ * 'advance' value in the @FT_GlyphSlotRec structure is set to the
+ * `vertAdvance` value of the 'metrics' field.
*
* In case @FT_HAS_VERTICAL doesn't return true, you shouldn't use
* this flag currently. Reason is that in this case vertical metrics
@@ -3052,8 +3052,8 @@ FT_BEGIN_HEADER
*
* FT_LOAD_NO_RECURSE ::
* Don't load composite glyphs recursively. Instead, the font
- * driver should set the `num_subglyph' and `subglyphs' values of
- * the glyph slot accordingly, and set `glyph->format' to
+ * driver should set the `num_subglyph` and 'subglyphs' values of
+ * the glyph slot accordingly, and set `glyph->format` to
* @FT_GLYPH_FORMAT_COMPOSITE. The description of subglyphs can
* then be accessed with @FT_Get_SubGlyph_Info.
*
@@ -3072,7 +3072,7 @@ FT_BEGIN_HEADER
* monochrome-optimized hinting algorithm is used.
*
* FT_LOAD_LINEAR_DESIGN ::
- * Keep `linearHoriAdvance' and `linearVertAdvance' fields of
+ * Keep `linearHoriAdvance` and `linearVertAdvance` fields of
* @FT_GlyphSlotRec in font units. See @FT_GlyphSlotRec for
* details.
*
@@ -3090,7 +3090,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
+ * '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
@@ -3101,7 +3101,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
+ * the 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.
@@ -3178,7 +3178,7 @@ FT_BEGIN_HEADER
*
* @description:
* A list of values to select a specific hinting algorithm for the
- * hinter. You should OR one of these values to your `load_flags'
+ * hinter. You should OR one of these values to your `load_flags`
* when calling @FT_Load_Glyph.
*
* Note that a font's native hinters may ignore the hinting algorithm
@@ -3203,7 +3203,7 @@ FT_BEGIN_HEADER
* auto-hinter.
*
* Advance widths are rounded to integer values; however, using the
- * `lsb_delta' and `rsb_delta' fields of @FT_GlyphSlotRec, it is
+ * `lsb_delta` and `rsb_delta` fields of @FT_GlyphSlotRec, it is
* possible to get fractional advance widths for subpixel positioning
* (which is recommended to use).
*
@@ -3227,7 +3227,7 @@ FT_BEGIN_HEADER
*
* @note:
* You should use only _one_ of the FT_LOAD_TARGET_XXX values in your
- * `load_flags'. They can't be ORed.
+ * `load_flags`. They can't be ORed.
*
* If @FT_LOAD_RENDER is also set, the glyph is rendered in the
* corresponding mode (i.e., the mode that matches the used algorithm
@@ -3235,16 +3235,16 @@ FT_BEGIN_HEADER
* @FT_LOAD_MONOCHROME.
*
* You can use a hinting algorithm that doesn't correspond to the same
- * rendering mode. As an example, it is possible to use the `light'
+ * rendering mode. As an example, it is possible to use the 'light'
* hinting algorithm and have the results rendered in horizontal LCD
* pixel mode, with code like
*
- * {
+ * ```
* FT_Load_Glyph( face, glyph_index,
* load_flags | FT_LOAD_TARGET_LIGHT );
*
* FT_Render_Glyph( face->glyph, FT_RENDER_MODE_LCD );
- * }
+ * ```
*
* In general, you should stick with one rendering mode. For example,
* switching between @FT_LOAD_TARGET_NORMAL and @FT_LOAD_TARGET_MONO
@@ -3303,8 +3303,8 @@ FT_BEGIN_HEADER
* the transformation and is performed on the character size given in
* the last call to @FT_Set_Char_Size or @FT_Set_Pixel_Sizes.
*
- * Note that this also transforms the `face.glyph.advance' field, but
- * *not* the values in `face.glyph.metrics'.
+ * Note that this also transforms the `face.glyph.advance` field, but
+ * **not** the values in `face.glyph.metrics`.
*/
FT_EXPORT( void )
FT_Set_Transform( FT_Face face,
@@ -3321,7 +3321,7 @@ FT_BEGIN_HEADER
* Render modes supported by FreeType~2. Each mode corresponds to a
* specific type of scanline conversion performed on the outline.
*
- * For bitmap fonts and embedded bitmaps the `bitmap->pixel_mode'
+ * For bitmap fonts and embedded bitmaps the `bitmap->pixel_mode`
* field in the @FT_GlyphSlotRec structure gives the format of the
* returned bitmap.
*
@@ -3359,7 +3359,7 @@ FT_BEGIN_HEADER
*
* @note:
* Should you define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your
- * `ftoption.h', which enables patented ClearType-style rendering,
+ * `ftoption.h`, which enables patented ClearType-style rendering,
* the LCD-optimized glyph bitmaps should be filtered to reduce color
* fringes inherent to this technology. You can either set up LCD
* filtering with @FT_Library_SetLcdFilter or @FT_Face_Properties,
@@ -3424,7 +3424,7 @@ FT_BEGIN_HEADER
*
* @note:
* To get meaningful results, font scaling values must be set with
- * functions like @FT_Set_Char_Size before calling `FT_Render_Glyph'.
+ * functions like @FT_Set_Char_Size before calling `FT_Render_Glyph`.
*
* When FreeType outputs a bitmap of a glyph, it really outputs an
* alpha coverage map. If a pixel is completely covered by a
@@ -3455,8 +3455,8 @@ FT_BEGIN_HEADER
* burnt-out, pixely and blotchy on bright background, bright text
* too frail on dark backgrounds, and colored text on colored
* background (for example, red on green) seems to have dark halos or
- * `dirt' around it. The situation is especially ugly for diagonal
- * stems like in `w' glyph shapes where the quality of FreeType's
+ * 'dirt' around it. The situation is especially ugly for diagonal
+ * stems like in 'w' glyph shapes where the quality of FreeType's
* anti-aliasing depends on the correct display of grays. On
* high-DPI screens where smaller, fully black pixels reign supreme,
* this doesn't matter, but on our low-DPI screens with all the gray
@@ -3466,9 +3466,9 @@ FT_BEGIN_HEADER
*
* The blending function for placing text over a background is
*
- * {
+ * ```
* dst = alpha * src + (1 - alpha) * dst ,
- * }
+ * ```
*
* which is known as the OVER operator.
*
@@ -3494,7 +3494,7 @@ FT_BEGIN_HEADER
* https://bel.fi/alankila/lcd/ and
* https://bel.fi/alankila/lcd/alpcor.html for details.
*
- * *ATTENTION*: Linear blending is even more important when dealing
+ * **ATTENTION**: Linear blending is even more important when dealing
* with subpixel-rendered glyphs to prevent color-fringing! A
* subpixel-rendered glyph must first be filtered with a filter that
* gives equal weight to the three color primaries and does not
@@ -3594,9 +3594,9 @@ FT_BEGIN_HEADER
* kernings, are 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'.
+ * that can be extracted with `FT_Get_Kerning`.
*/
FT_EXPORT( FT_Error )
FT_Get_Kerning( FT_Face face,
@@ -3681,17 +3681,17 @@ FT_BEGIN_HEADER
* @note:
* An error is returned if the face doesn't provide glyph names or if
* the glyph index is invalid. In all cases of failure, the first
- * byte of `buffer' is set to~0 to indicate an empty name.
+ * byte of 'buffer' is set to~0 to indicate an empty name.
*
* The glyph name is truncated to fit within the buffer if it is too
* long. The returned string is always zero-terminated.
*
* Be aware that FreeType reorders glyph indices internally so that
- * glyph index~0 always corresponds to the `missing glyph' (called
- * `.notdef').
+ * glyph index~0 always corresponds to the 'missing glyph' (called
+ * '.notdef').
*
* This function always returns an error if the config macro
- * `FT_CONFIG_OPTION_NO_GLYPH_NAMES' is not defined in `ftoption.h'.
+ * `FT_CONFIG_OPTION_NO_GLYPH_NAMES` is not defined in `ftoption.h`.
*/
FT_EXPORT( FT_Error )
FT_Get_Glyph_Name( FT_Face face,
@@ -3721,15 +3721,15 @@ FT_BEGIN_HEADER
* it.
*
* For variation fonts, this string changes if you select a different
- * instance, and you have to call `FT_Get_PostScript_Name' again to
- * retrieve it. FreeType follows Adobe TechNote #5902, `Generating
+ * instance, and you have to call `FT_Get_PostScript_Name` again to
+ * retrieve it. FreeType follows Adobe TechNote #5902, 'Generating
* PostScript Names for Fonts Using OpenType Font Variations'.
*
*
https://download.macromedia.com/pub/developer/opentype/tech-notes/5902.AdobePSNameGeneration.html
*
* [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
+ * (and 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.
@@ -3745,7 +3745,7 @@ FT_BEGIN_HEADER
*
* @description:
* Select a given charmap by its encoding tag (as listed in
- * `freetype.h').
+ * `freetype.h`).
*
* @inout:
* face ::
@@ -3764,7 +3764,7 @@ FT_BEGIN_HEADER
*
* Because many fonts contain more than a single cmap for Unicode
* encoding, this function has some special code to select the one
- * that covers Unicode best (`best' in the sense that a UCS-4 cmap is
+ * that covers Unicode best ('best' in the sense that a UCS-4 cmap is
* preferred to a UCS-2 cmap). It is thus preferable to
* @FT_Set_Charmap in this case.
*/
@@ -3794,7 +3794,7 @@ FT_BEGIN_HEADER
*
* @note:
* This function returns an error if the charmap is not part of
- * the face (i.e., if it is not listed in the `face->charmaps'
+ * the face (i.e., if it is not listed in the `face->charmaps`
* table).
*
* It also fails if an OpenType type~14 charmap is selected (which
@@ -3819,7 +3819,7 @@ FT_BEGIN_HEADER
*
* @return:
* The index into the array of character maps within the face to which
- * `charmap' belongs. If an error occurs, -1 is returned.
+ * 'charmap' belongs. If an error occurs, -1 is returned.
*
*/
FT_EXPORT( FT_Int )
@@ -3843,18 +3843,18 @@ FT_BEGIN_HEADER
* The character code.
*
* @return:
- * The glyph index. 0~means `undefined character code'.
+ * The glyph index. 0~means 'undefined character code'.
*
* @note:
* If you use FreeType to manipulate the contents of font files
* directly, be aware that the glyph index returned by this function
* doesn't always correspond to the internal indices used within the
* file. This is done to ensure that value~0 always corresponds to
- * the `missing glyph'. If the first glyph is not named `.notdef',
- * then for Type~1 and Type~42 fonts, `.notdef' will be moved into
+ * the 'missing glyph'. If the first glyph is not named '.notdef',
+ * then for Type~1 and Type~42 fonts, '.notdef' will be moved into
* the glyph ID~0 position, and whatever was there will be moved to
- * the position `.notdef' had. For Type~1 fonts, if there is no
- * `.notdef' glyph at all, then one will be created at index~0 and
+ * the position '.notdef' had. For Type~1 fonts, if there is no
+ * '.notdef' glyph at all, then one will be created at index~0 and
* whatever was there will be moved to the last index -- Type~42
* fonts are considered invalid under this condition.
*/
@@ -3889,7 +3889,7 @@ FT_BEGIN_HEADER
* parse all character codes available in a given charmap. The code
* should look like this:
*
- * {
+ * ```
* FT_ULong charcode;
* FT_UInt gindex;
*
@@ -3901,16 +3901,16 @@ FT_BEGIN_HEADER
*
* charcode = FT_Get_Next_Char( face, charcode, &gindex );
* }
- * }
+ * ```
*
* Be aware that character codes can have values up to 0xFFFFFFFF;
* this might happen for non-Unicode or malformed cmaps. However,
- * even with regular Unicode encoding, so-called `last resort fonts'
+ * even with regular Unicode encoding, so-called 'last resort fonts'
* (using SFNT cmap format 13, see function @FT_Get_CMap_Format)
* normally have entries for all Unicode characters up to 0x1FFFFF,
* which can cause *a lot* of iterations.
*
- * Note that `*agindex' is set to~0 if the charmap is empty. The
+ * Note that '*agindex' is set to~0 if the charmap is empty. The
* result itself can be~0 in two cases: if the charmap is empty or
* if the value~0 is the first valid character code.
*/
@@ -3926,7 +3926,7 @@ FT_BEGIN_HEADER
*
* @description:
* Return the next character code in the current charmap of a given
- * face following the value `char_code', as well as the corresponding
+ * face following the value `char_code`, as well as the corresponding
* glyph index.
*
* @input:
@@ -3949,7 +3949,7 @@ FT_BEGIN_HEADER
* over all character codes available in a given charmap. See the
* note for that function for a simple code example.
*
- * Note that `*agindex' is set to~0 when there are no more codes in
+ * Note that '*agindex' is set to~0 when there are no more codes in
* the charmap.
*/
FT_EXPORT( FT_ULong )
@@ -3975,18 +3975,18 @@ FT_BEGIN_HEADER
* controlled.
*
* * @FT_PARAM_TAG_STEM_DARKENING (stem darkening, corresponding to the
- * property `no-stem-darkening' provided by the `autofit', `cff',
- * `type1', and `t1cid' modules; see @no-stem-darkening).
+ * property 'no-stem-darkening' provided by the 'autofit', 'cff',
+ * 'type1', and 't1cid' modules; see @no-stem-darkening).
*
* * @FT_PARAM_TAG_LCD_FILTER_WEIGHTS (LCD filter weights, corresponding
* to function @FT_Library_SetLcdFilterWeights).
*
* * @FT_PARAM_TAG_RANDOM_SEED (seed value for the CFF, Type~1, and CID
- * `random' operator, corresponding to the `random-seed' property
- * provided by the `cff', `type1', and `t1cid' modules; see
+ * 'random' operator, corresponding to the 'random-seed' property
+ * provided by the 'cff', 'type1', and 't1cid' modules; see
* @random-seed).
*
- * Pass NULL as `data' in @FT_Parameter for a given tag to reset the
+ * Pass NULL as 'data' in @FT_Parameter for a given tag to reset the
* option and use the library or module default again.
*
* @input:
@@ -3997,7 +3997,7 @@ FT_BEGIN_HEADER
* The number of properties that follow.
*
* properties ::
- * A handle to an @FT_Parameter array with `num_properties' elements.
+ * A handle to an @FT_Parameter array with `num_properties` elements.
*
* @return:
* FreeType error code. 0~means success.
@@ -4007,7 +4007,7 @@ FT_BEGIN_HEADER
* FT_CONFIG_OPTION_SUBPIXEL_RENDERING to make the LCD filter examples
* work.
*
- * {
+ * ```
* FT_Parameter property1;
* FT_Bool darken_stems = 1;
*
@@ -4033,11 +4033,11 @@ FT_BEGIN_HEADER
* property3.data = &random_seed;
*
* FT_Face_Properties( face, 3, properties );
- * }
+ * ```
*
* The next example resets a single property to its default value.
*
- * {
+ * ```
* FT_Parameter property;
*
*
@@ -4045,7 +4045,7 @@ FT_BEGIN_HEADER
* property.data = NULL;
*
* FT_Face_Properties( face, 1, &property );
- * }
+ * ```
*
* @since:
* 2.8
@@ -4073,7 +4073,7 @@ FT_BEGIN_HEADER
* The glyph name.
*
* @return:
- * The glyph index. 0~means `undefined character code'.
+ * The glyph index. 0~means 'undefined character code'.
*/
FT_EXPORT( FT_UInt )
FT_Get_Name_Index( FT_Face face,
@@ -4087,7 +4087,7 @@ FT_BEGIN_HEADER
*
* @description:
* A list of constants describing subglyphs. Please refer to the
- * `glyf' table description in the OpenType specification for the
+ * 'glyf' table description in the OpenType specification for the
* meaning of the various flags (which get synthesized for
* non-OpenType subglyphs).
*
@@ -4119,7 +4119,7 @@ FT_BEGIN_HEADER
*
* @description:
* Retrieve a description of a given subglyph. Only use it if
- * `glyph->format' is @FT_GLYPH_FORMAT_COMPOSITE; an error is
+ * `glyph->format` is @FT_GLYPH_FORMAT_COMPOSITE; an error is
* returned otherwise.
*
* @input:
@@ -4128,7 +4128,7 @@ FT_BEGIN_HEADER
*
* sub_index ::
* The index of the subglyph. Must be less than
- * `glyph->num_subglyphs'.
+ * `glyph->num_subglyphs`.
*
* @output:
* p_index ::
@@ -4150,8 +4150,8 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * The values of `*p_arg1', `*p_arg2', and `*p_transform' must be
- * interpreted depending on the flags returned in `*p_flags'. See the
+ * The values of `*p_arg1`, `*p_arg2`, and `*p_transform` must be
+ * interpreted depending on the flags returned in `*p_flags`. See the
* OpenType specification for details.
*
*/
@@ -4174,11 +4174,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.
*/
@@ -4199,7 +4199,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_
@@ -4217,7 +4217,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.
*
@@ -4230,7 +4230,7 @@ FT_BEGIN_HEADER
* layer.
*
* The returned elements are ordered in the z~direction from bottom to
- * top; the `n'th element should be rendered with the associated palette
+ * top; the 'n'th element should be rendered with the associated palette
* color and blended on top of the already rendered layers (elements 0,
* 1, ..., n-1).
*
@@ -4244,7 +4244,7 @@ FT_BEGIN_HEADER
* @inout:
* iterator ::
* An @FT_LayerIterator object. For the first call you should set
- * `iterator->p' to NULL. For all following calls, simply use the
+ * `iterator->p` to NULL. For all following calls, simply use the
* same object again.
*
* @output:
@@ -4274,7 +4274,7 @@ FT_BEGIN_HEADER
* automatically if the @FT_LOAD_COLOR flag is passed to it.
*
* @example:
- * {
+ * ```
* FT_Color* palette;
* FT_LayerIterator iterator;
*
@@ -4316,7 +4316,7 @@ FT_BEGIN_HEADER
* &layer_color_index,
* &iterator ) );
* }
- * }
+ * ```
*/
FT_EXPORT( FT_Bool )
FT_Get_Color_Glyph_Layer( FT_Face face,
@@ -4339,8 +4339,8 @@ FT_BEGIN_HEADER
* FT_FSTYPE_XXX
*
* @description:
- * A list of bit flags used in the `fsType' field of the OS/2 table
- * in a TrueType or OpenType font and the `FSType' entry in a
+ * A list of bit flags used in the `fsType` field of the OS/2 table
+ * in a TrueType or OpenType font and the 'FSType' entry in a
* PostScript font. These bit flags are returned by
* @FT_Get_FSType_Flags; they inform client applications of embedding
* and subsetting restrictions associated with a font.
@@ -4362,7 +4362,7 @@ FT_BEGIN_HEADER
* FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING ::
* The font may be embedded and temporarily loaded on the remote
* system. Documents containing Preview & Print fonts must be
- * opened `read-only'; no edits can be applied to the document.
+ * opened 'read-only'; no edits can be applied to the document.
*
* FT_FSTYPE_EDITABLE_EMBEDDING ::
* The font may be embedded but must only be installed temporarily
@@ -4382,7 +4382,7 @@ FT_BEGIN_HEADER
* The flags are ORed together, thus more than a single value can be
* returned.
*
- * While the `fsType' flags can indicate that a font may be embedded,
+ * While the `fsType` flags can indicate that a font may be embedded,
* a license with the font vendor may be separately required to use
* the font in this way.
*/
@@ -4400,17 +4400,17 @@ FT_BEGIN_HEADER
* FT_Get_FSType_Flags
*
* @description:
- * Return the `fsType' flags for a font.
+ * Return the `fsType` flags for a font.
*
* @input:
* face ::
* A handle to the source face object.
*
* @return:
- * The `fsType' flags, see @FT_FSTYPE_XXX.
+ * The `fsType` flags, see @FT_FSTYPE_XXX.
*
* @note:
- * Use this function rather than directly reading the `fs_type' field
+ * Use this function rather than directly reading the `fs_type` field
* in the @PS_FontInfoRec structure, which is only guaranteed to
* return the correct results for Type~1 fonts.
*
@@ -4442,9 +4442,9 @@ FT_BEGIN_HEADER
* instead of further extending the already huge number of
* characters.
*
- * Unicode maintains two different sets, namely `Standardized
- * Variation Sequences' and registered `Ideographic Variation
- * Sequences' (IVS), collected in the `Ideographic Variation
+ * Unicode maintains two different sets, namely 'Standardized
+ * Variation Sequences' and registered 'Ideographic Variation
+ * Sequences' (IVS), collected in the 'Ideographic Variation
* Database' (IVD).
*
* https://unicode.org/Public/UCD/latest/ucd/StandardizedVariants.txt
@@ -4461,14 +4461,14 @@ FT_BEGIN_HEADER
*
* A VS consists of the base character value followed by a single
* Variation Selector. For example, to get the first variation of
- * U+9089, you have to write the character sequence `U+9089 U+E0100'.
+ * U+9089, you have to write the character sequence `U+9089 U+E0100`.
*
* Adobe and MS decided to support both standardized and ideographic
* VS with a new cmap subtable (format~14). It is an odd subtable
* because it is not a mapping of input code points to glyphs, but
* contains lists of all variations supported by the font.
*
- * A variation may be either `default' or `non-default' for a given
+ * A variation may be either 'default' or 'non-default' for a given
* font. A default variation is the one you will get for that code
* point if you look it up in the standard Unicode cmap. A
* non-default variation is a different glyph.
@@ -4496,16 +4496,16 @@ FT_BEGIN_HEADER
* The Unicode code point of the variation selector.
*
* @return:
- * The glyph index. 0~means either `undefined character code', or
- * `undefined selector code', or `no variation selector cmap
- * subtable', or `current CharMap is not Unicode'.
+ * The glyph index. 0~means either 'undefined character code', or
+ * 'undefined selector code', or 'no variation selector cmap
+ * subtable', or 'current CharMap is not Unicode'.
*
* @note:
* If you use FreeType to manipulate the contents of font files
* directly, be aware that the glyph index returned by this function
* doesn't always correspond to the internal indices used within
* the file. This is done to ensure that value~0 always corresponds
- * to the `missing glyph'.
+ * to the 'missing glyph'.
*
* This function is only meaningful if
* a) the font has a variation selector cmap sub table,
@@ -4528,7 +4528,7 @@ FT_BEGIN_HEADER
*
* @description:
* Check whether this variation of this Unicode character is the one
- * to be found in the `cmap'.
+ * to be found in the 'cmap'.
*
* @input:
* face ::
@@ -4689,7 +4689,7 @@ FT_BEGIN_HEADER
* FT_MulDiv
*
* @description:
- * Compute `(a*b)/c' with maximum accuracy, using a 64-bit
+ * Compute '(a*b)/c' with maximum accuracy, using a 64-bit
* intermediate integer whenever necessary.
*
* This function isn't necessarily as fast as some processor-specific
@@ -4706,9 +4706,9 @@ FT_BEGIN_HEADER
* The divisor.
*
* @return:
- * The result of `(a*b)/c'. This function never traps when trying to
- * divide by zero; it simply returns `MaxInt' or `MinInt' depending
- * on the signs of `a' and `b'.
+ * The result of '(a*b)/c'. This function never traps when trying to
+ * divide by zero; it simply returns 'MaxInt' or 'MinInt' depending
+ * on the signs of 'a' and 'b'.
*/
FT_EXPORT( FT_Long )
FT_MulDiv( FT_Long a,
@@ -4722,7 +4722,7 @@ FT_BEGIN_HEADER
* FT_MulFix
*
* @description:
- * Compute `(a*b)/0x10000' with maximum accuracy. Its main use is to
+ * Compute '(a*b)/0x10000' with maximum accuracy. Its main use is to
* multiply a given value by a 16.16 fixed-point factor.
*
* @input:
@@ -4734,11 +4734,11 @@ FT_BEGIN_HEADER
* possible (see note below).
*
* @return:
- * The result of `(a*b)/0x10000'.
+ * The result of '(a*b)/0x10000'.
*
* @note:
* This function has been optimized for the case where the absolute
- * value of `a' is less than 2048, and `b' is a 16.16 scaling factor.
+ * value of 'a' is less than 2048, and 'b' is a 16.16 scaling factor.
* As this happens mainly when scaling from notional units to
* fractional pixels in FreeType, it resulted in noticeable speed
* improvements between versions 2.x and 1.x.
@@ -4758,7 +4758,7 @@ FT_BEGIN_HEADER
* FT_DivFix
*
* @description:
- * Compute `(a*0x10000)/b' with maximum accuracy. Its main use is to
+ * Compute '(a*0x10000)/b' with maximum accuracy. Its main use is to
* divide a given value by a 16.16 fixed-point factor.
*
* @input:
@@ -4769,7 +4769,7 @@ FT_BEGIN_HEADER
* The denominator. Use a 16.16 factor here.
*
* @return:
- * The result of `(a*0x10000)/b'.
+ * The result of '(a*0x10000)/b'.
*/
FT_EXPORT( FT_Long )
FT_DivFix( FT_Long a,
@@ -4789,7 +4789,7 @@ FT_BEGIN_HEADER
* The number to be rounded.
*
* @return:
- * `a' rounded to the nearest 16.16 fixed integer, halfway cases away
+ * 'a' rounded to the nearest 16.16 fixed integer, halfway cases away
* from zero.
*
* @note:
@@ -4812,7 +4812,7 @@ FT_BEGIN_HEADER
* The number for which the ceiling function is to be computed.
*
* @return:
- * `a' rounded towards plus infinity.
+ * 'a' rounded towards plus infinity.
*
* @note:
* The function uses wrap-around arithmetic.
@@ -4834,7 +4834,7 @@ FT_BEGIN_HEADER
* The number for which the floor function is to be computed.
*
* @return:
- * `a' rounded towards minus infinity.
+ * 'a' rounded towards minus infinity.
*/
FT_EXPORT( FT_Fixed )
FT_FloorFix( FT_Fixed a );
@@ -4857,7 +4857,7 @@ FT_BEGIN_HEADER
* A pointer to the source 2x2 matrix.
*
* @note:
- * The result is undefined if either `vector' or `matrix' is invalid.
+ * The result is undefined if either 'vector' or 'matrix' is invalid.
*/
FT_EXPORT( void )
FT_Vector_Transform( FT_Vector* vec,
@@ -4912,7 +4912,7 @@ FT_BEGIN_HEADER
*
* @note:
* The version number of FreeType if built as a dynamic link library
- * with the `libtool' package is _not_ controlled by these three
+ * with the 'libtool' package is _not_ controlled by these three
* macros.
*
*/
@@ -4947,7 +4947,7 @@ FT_BEGIN_HEADER
* The patch version number.
*
* @note:
- * The reason why this function takes a `library' argument is because
+ * The reason why this function takes a 'library' argument is because
* certain programs implement library initialization in a custom way
* that doesn't use @FT_Init_FreeType.
*
diff --git a/include/freetype/ftadvanc.h b/include/freetype/ftadvanc.h
index 9c3f545..d0ba9e8 100644
--- a/include/freetype/ftadvanc.h
+++ b/include/freetype/ftadvanc.h
@@ -62,7 +62,7 @@ FT_BEGIN_HEADER
* FT_ADVANCE_FLAG_FAST_ONLY
*
* @description:
- * A bit-flag to be OR-ed with the `flags' parameter of the
+ * A bit-flag to be OR-ed with the 'flags' parameter of the
* @FT_Get_Advance and @FT_Get_Advances functions.
*
* If set, it indicates that you want these functions to fail if the
@@ -103,7 +103,7 @@ FT_BEGIN_HEADER
* @output:
* padvance ::
* The advance value. If scaling is performed (based on
- * the value of `load_flags'), the advance value is in
+ * the value of `load_flags`), the advance value is in
* 16.16 format. Otherwise, it is in font units.
*
* If @FT_LOAD_VERTICAL_LAYOUT is set, this is the
@@ -155,10 +155,10 @@ FT_BEGIN_HEADER
* @output:
* padvance ::
* The advance values. This array, to be provided by the
- * caller, must contain at least `count' elements.
+ * caller, must contain at least 'count' elements.
*
* If scaling is performed (based on the value of
- * `load_flags'), the advance values are in 16.16 format.
+ * `load_flags`), the advance values are in 16.16 format.
* Otherwise, they are in font units.
*
* If @FT_LOAD_VERTICAL_LAYOUT is set, these are the
diff --git a/include/freetype/ftbdf.h b/include/freetype/ftbdf.h
index 69dbb4d..1780d53 100644
--- a/include/freetype/ftbdf.h
+++ b/include/freetype/ftbdf.h
@@ -187,15 +187,15 @@ FT_BEGIN_HEADER
* otherwise. It also returns an error if the property is not in the
* font.
*
- * A `property' is a either key-value pair within the STARTPROPERTIES
+ * A 'property' is a either key-value pair within the STARTPROPERTIES
* ... ENDPROPERTIES block of a BDF font or a key-value pair from the
- * `info->props' array within a `FontRec' structure of a PCF font.
+ * `info->props` array within a 'FontRec' structure of a PCF font.
*
- * Integer properties are always stored as `signed' within PCF fonts;
+ * Integer properties are always stored as 'signed' within PCF fonts;
* consequently, @BDF_PROPERTY_TYPE_CARDINAL is a possible return value
* for BDF fonts only.
*
- * In case of error, `aproperty->type' is always set to
+ * In case of error, `aproperty->type` is always set to
* @BDF_PROPERTY_TYPE_NONE.
*/
FT_EXPORT( FT_Error )
diff --git a/include/freetype/ftbitmap.h b/include/freetype/ftbitmap.h
index c9370af..1749c66 100644
--- a/include/freetype/ftbitmap.h
+++ b/include/freetype/ftbitmap.h
@@ -47,8 +47,8 @@ FT_BEGIN_HEADER
*
* @description:
* This section contains functions for handling @FT_Bitmap objects.
- * Note that none of the functions changes the bitmap's `flow' (as
- * indicated by the sign of the `pitch' field in `FT_Bitmap').
+ * Note that none of the functions changes the bitmap's 'flow' (as
+ * indicated by the sign of the 'pitch' field in `FT_Bitmap`).
*
*/
@@ -66,7 +66,7 @@ FT_BEGIN_HEADER
* A pointer to the bitmap structure.
*
* @note:
- * A deprecated name for the same function is `FT_Bitmap_New'.
+ * A deprecated name for the same function is `FT_Bitmap_New`.
*/
FT_EXPORT( void )
FT_Bitmap_Init( FT_Bitmap *abitmap );
@@ -111,8 +111,8 @@ FT_BEGIN_HEADER
* FT_Bitmap_Embolden
*
* @description:
- * Embolden a bitmap. The new bitmap will be about `xStrength'
- * pixels wider and `yStrength' pixels higher. The left and bottom
+ * Embolden a bitmap. The new bitmap will be about `xStrength`
+ * pixels wider and `yStrength` pixels higher. The left and bottom
* borders are kept unchanged.
*
* @input:
@@ -135,7 +135,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * The current implementation restricts `xStrength' to be less than
+ * The current implementation restricts `xStrength` to be less than
* or equal to~8 if bitmap is of pixel_mode @FT_PIXEL_MODE_MONO.
*
* If you want to embolden the bitmap owned by a @FT_GlyphSlotRec,
@@ -159,7 +159,7 @@ FT_BEGIN_HEADER
* @description:
* Convert a bitmap object with depth 1bpp, 2bpp, 4bpp, 8bpp or 32bpp
* to a bitmap object with depth 8bpp, making the number of used
- * bytes per line (a.k.a. the `pitch') a multiple of `alignment'.
+ * bytes per line (a.k.a. the 'pitch') a multiple of 'alignment'.
*
* @input:
* library ::
@@ -185,7 +185,7 @@ FT_BEGIN_HEADER
*
* Use @FT_Bitmap_Done to finally remove the bitmap object.
*
- * The `library' argument is taken to have access to FreeType's
+ * The 'library' argument is taken to have access to FreeType's
* memory handling functions.
*/
FT_EXPORT( FT_Error )
@@ -215,11 +215,11 @@ FT_BEGIN_HEADER
* 26.6 pixel format. This can be a fractional pixel value.
*
* color ::
- * The color used to draw `source' onto `target'.
+ * The color used to draw 'source' onto 'target'.
*
* @inout:
* target ::
- * A handle to an `FT_Bitmap' object. It should be either initialized
+ * A handle to an `FT_Bitmap` object. It should be either initialized
* as empty with a call to @FT_Bitmap_Init, or it should be of type
* @FT_PIXEL_MODE_BGRA.
*
@@ -234,12 +234,12 @@ FT_BEGIN_HEADER
* @note:
* This function doesn't perform clipping.
*
- * The bitmap in `target' gets allocated or reallocated as needed; the
- * vector `atarget_offset' is updated accordingly.
+ * The bitmap in 'target' gets allocated or reallocated as needed; the
+ * vector `atarget_offset` is updated accordingly.
*
* In case of allocation or reallocation, the bitmap's pitch is set to
- * `4~*~width'. Both `source' and `target' must have the same bitmap
- * flow (as indicated by the sign of the `pitch' field).
+ * '4~*~width'. Both 'source' and 'target' must have the same bitmap
+ * flow (as indicated by the sign of the 'pitch' field).
*
* @since:
* 2.10
@@ -259,7 +259,7 @@ FT_BEGIN_HEADER
* FT_GlyphSlot_Own_Bitmap
*
* @description:
- * Make sure that a glyph slot owns `slot->bitmap'.
+ * Make sure that a glyph slot owns `slot->bitmap`.
*
* @input:
* slot ::
@@ -295,7 +295,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * The `library' argument is taken to have access to FreeType's
+ * The 'library' argument is taken to have access to FreeType's
* memory handling functions.
*/
FT_EXPORT( FT_Error )
diff --git a/include/freetype/ftbzip2.h b/include/freetype/ftbzip2.h
index 07a7367..5ea9a53 100644
--- a/include/freetype/ftbzip2.h
+++ b/include/freetype/ftbzip2.h
@@ -55,7 +55,7 @@ FT_BEGIN_HEADER
*
* @description:
* Open a new stream to parse bzip2-compressed font files. This is
- * mainly used to support the compressed `*.pcf.bz2' fonts that come
+ * mainly used to support the compressed `*.pcf.bz2` fonts that come
* with XFree86.
*
* @input:
@@ -71,8 +71,8 @@ FT_BEGIN_HEADER
* @note:
* The source stream must be opened _before_ calling this function.
*
- * Calling the internal function `FT_Stream_Close' on the new stream will
- * *not* call `FT_Stream_Close' on the source stream. None of the stream
+ * Calling the internal function `FT_Stream_Close` on the new stream will
+ * **not** call `FT_Stream_Close` on the source stream. None of the stream
* objects will be released to the heap.
*
* The stream implementation is very basic and resets the decompression
@@ -84,7 +84,7 @@ FT_BEGIN_HEADER
* compressed file, the library will try to open a bzip2 compressed stream
* from it and re-open the face with it.
*
- * This function may return `FT_Err_Unimplemented_Feature' if your build
+ * This function may return `FT_Err_Unimplemented_Feature` if your build
* of FreeType was not compiled with bzip2 support.
*/
FT_EXPORT( FT_Error )
diff --git a/include/freetype/ftcache.h b/include/freetype/ftcache.h
index 5dedb52..5531365 100644
--- a/include/freetype/ftcache.h
+++ b/include/freetype/ftcache.h
@@ -44,7 +44,7 @@ FT_BEGIN_HEADER
* objects, as well as caching information like character maps and glyph
* images while limiting their maximum memory usage.
*
- * Note that all types and functions begin with the `FTC_' prefix.
+ * Note that all types and functions begin with the 'FTC_' prefix.
*
* The cache is highly portable and thus doesn't know anything about the
* fonts installed on your system, or how to access them. This implies
@@ -59,7 +59,7 @@ FT_BEGIN_HEADER
* to convert an @FTC_FaceID into a new @FT_Face object. The latter is
* then completely managed by the cache, including its termination
* through @FT_Done_Face. To monitor termination of face objects, the
- * finalizer callback in the `generic' field of the @FT_Face object can
+ * finalizer callback in the 'generic' field of the @FT_Face object can
* be used, which might also be used to store the @FTC_FaceID of the
* face.
*
@@ -69,7 +69,7 @@ FT_BEGIN_HEADER
* possible.
*
* Note that for the cache to work correctly, the face ID values must be
- * *persistent*, which means that the contents they point to should not
+ * **persistent**, which means that the contents they point to should not
* change at runtime, or that their value should not become invalid.
*
* If this is unavoidable (e.g., when a font is uninstalled at runtime),
@@ -200,7 +200,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * The third parameter `req_data' is the same as the one passed by the
+ * The third parameter `req_data` is the same as the one passed by the
* client when @FTC_Manager_New is called.
*
* The face requester should not perform funny things on the returned
@@ -239,9 +239,9 @@ FT_BEGIN_HEADER
*
* The manager intentionally limits the total number of opened
* @FT_Face and @FT_Size objects to control memory usage. See the
- * `max_faces' and `max_sizes' parameters of @FTC_Manager_New.
+ * `max_faces` and `max_sizes` parameters of @FTC_Manager_New.
*
- * The manager is also used to cache `nodes' of various types while
+ * The manager is also used to cache 'nodes' of various types while
* limiting their total memory usage.
*
* All limitations are enforced by keeping lists of managed objects
@@ -261,10 +261,10 @@ FT_BEGIN_HEADER
* reference-counted. A node with a count of~0 might be flushed
* out of a full cache whenever a lookup request is performed.
*
- * If you look up nodes, you have the ability to `acquire' them,
+ * If you look up nodes, you have the ability to 'acquire' them,
* i.e., to increment their reference count. This will prevent the
* node from being flushed out of the cache until you explicitly
- * `release' it (see @FTC_Node_Unref).
+ * 'release' it (see @FTC_Node_Unref).
*
* See also @FTC_SBitCache_Lookup and @FTC_ImageCache_Lookup.
*/
@@ -383,7 +383,7 @@ FT_BEGIN_HEADER
* should never try to discard it yourself.
*
* The @FT_Face object doesn't necessarily have a current size object
- * (i.e., face->size can be~0). If you need a specific `font size',
+ * (i.e., face->size can be~0). If you need a specific 'font size',
* use @FTC_Manager_LookupSize instead.
*
* Never change the face's transformation matrix (i.e., never call
@@ -394,7 +394,7 @@ FT_BEGIN_HEADER
* _within_ the lookup and force incremental flushes of the cache
* until enough memory is released for the lookup to succeed.
*
- * If a lookup fails with `FT_Err_Out_Of_Memory' the cache has
+ * If a lookup fails with `FT_Err_Out_Of_Memory` the cache has
* already been completely flushed, and still no memory was available
* for the operation.
*/
@@ -425,16 +425,16 @@ FT_BEGIN_HEADER
* The character height.
*
* pixel ::
- * A Boolean. If 1, the `width' and `height' fields are
+ * A Boolean. If 1, the 'width' and 'height' fields are
* interpreted as integer pixel character sizes.
* Otherwise, they are expressed as 1/64th of points.
*
* x_res ::
- * Only used when `pixel' is value~0 to indicate the
+ * Only used when 'pixel' is value~0 to indicate the
* horizontal resolution in dpi.
*
* y_res ::
- * Only used when `pixel' is value~0 to indicate the
+ * Only used when 'pixel' is value~0 to indicate the
* vertical resolution in dpi.
*
* @note:
@@ -491,7 +491,7 @@ FT_BEGIN_HEADER
* The returned @FT_Size object is always owned by the manager. You
* should never try to discard it by yourself.
*
- * You can access the parent @FT_Face object simply as `size->face'
+ * You can access the parent @FT_Face object simply as `size->face`
* if you need it. Note that this object is also owned by the
* manager.
*
@@ -500,7 +500,7 @@ FT_BEGIN_HEADER
* _within_ the lookup and force incremental flushes of the cache
* until enough memory is released for the lookup to succeed.
*
- * If a lookup fails with `FT_Err_Out_Of_Memory' the cache has
+ * If a lookup fails with `FT_Err_Out_Of_Memory` the cache has
* already been completely flushed, and still no memory is available
* for the operation.
*/
@@ -551,11 +551,11 @@ FT_BEGIN_HEADER
*
* @note:
* This function flushes all nodes from the cache corresponding to this
- * `face_id', with the exception of nodes with a non-null reference
+ * `face_id`, with the exception of nodes with a non-null reference
* count.
*
* Such nodes are however modified internally so as to never appear
- * in later lookups with the same `face_id' value, and to be immediately
+ * in later lookups with the same `face_id` value, and to be immediately
* destroyed when released by all their users.
*
*/
@@ -630,7 +630,7 @@ FT_BEGIN_HEADER
* The character code (in the corresponding charmap).
*
* @return:
- * Glyph index. 0~means `no glyph'.
+ * Glyph index. 0~means 'no glyph'.
*
*/
FT_EXPORT( FT_UInt )
@@ -777,13 +777,13 @@ FT_BEGIN_HEADER
* Never try to transform or discard it manually! You can however
* create a copy with @FT_Glyph_Copy and modify the new one.
*
- * If `anode' is _not_ NULL, it receives the address of the cache
+ * If 'anode' is _not_ NULL, it receives the address of the cache
* node containing the glyph image, after increasing its reference
* count. This ensures that the node (as well as the @FT_Glyph) will
* always be kept in the cache until you call @FTC_Node_Unref to
- * `release' it.
+ * 'release' it.
*
- * If `anode' is NULL, the cache node is left unchanged, which means
+ * If 'anode' is NULL, the cache node is left unchanged, which means
* that the @FT_Glyph could be flushed out of the cache on the next
* call to one of the caching sub-system APIs. Don't assume that it
* is persistent!
@@ -836,13 +836,13 @@ FT_BEGIN_HEADER
* Never try to transform or discard it manually! You can however
* create a copy with @FT_Glyph_Copy and modify the new one.
*
- * If `anode' is _not_ NULL, it receives the address of the cache
+ * If 'anode' is _not_ NULL, it receives the address of the cache
* node containing the glyph image, after increasing its reference
* count. This ensures that the node (as well as the @FT_Glyph) will
* always be kept in the cache until you call @FTC_Node_Unref to
- * `release' it.
+ * 'release' it.
*
- * If `anode' is NULL, the cache node is left unchanged, which means
+ * If 'anode' is NULL, the cache node is left unchanged, which means
* that the @FT_Glyph could be flushed out of the cache on the next
* call to one of the caching sub-system APIs. Don't assume that it
* is persistent!
@@ -888,12 +888,12 @@ FT_BEGIN_HEADER
*
* left ::
* The horizontal distance from the pen position to the
- * left bitmap border (a.k.a. `left side bearing', or
- * `lsb').
+ * left bitmap border (a.k.a. 'left side bearing', or
+ * 'lsb').
*
* top ::
* The vertical distance from the pen position (on the
- * baseline) to the upper bitmap border (a.k.a. `top
+ * baseline) to the upper bitmap border (a.k.a. 'top
* side bearing'). The distance is positive for upwards
* y~coordinates.
*
@@ -979,7 +979,7 @@ FT_BEGIN_HEADER
*
* @description:
* Look up a given small glyph bitmap in a given sbit cache and
- * `lock' it to prevent its flushing from the cache until needed.
+ * 'lock' it to prevent its flushing from the cache until needed.
*
* @input:
* cache ::
@@ -1009,15 +1009,15 @@ FT_BEGIN_HEADER
* as well disappear from memory on the next cache lookup, so don't
* treat them as persistent data.
*
- * The descriptor's `buffer' field is set to~0 to indicate a missing
+ * The descriptor's 'buffer' field is set to~0 to indicate a missing
* glyph bitmap.
*
- * If `anode' is _not_ NULL, it receives the address of the cache
+ * If 'anode' is _not_ NULL, it receives the address of the cache
* node containing the bitmap, after increasing its reference count.
* This ensures that the node (as well as the image) will always be
- * kept in the cache until you call @FTC_Node_Unref to `release' it.
+ * kept in the cache until you call @FTC_Node_Unref to 'release' it.
*
- * If `anode' is NULL, the cache node is left unchanged, which means
+ * If 'anode' is NULL, the cache node is left unchanged, which means
* that the bitmap could be flushed out of the cache on the next
* call to one of the caching sub-system APIs. Don't assume that it
* is persistent!
@@ -1070,15 +1070,15 @@ FT_BEGIN_HEADER
* as well disappear from memory on the next cache lookup, so don't
* treat them as persistent data.
*
- * The descriptor's `buffer' field is set to~0 to indicate a missing
+ * The descriptor's 'buffer' field is set to~0 to indicate a missing
* glyph bitmap.
*
- * If `anode' is _not_ NULL, it receives the address of the cache
+ * If 'anode' is _not_ NULL, it receives the address of the cache
* node containing the bitmap, after increasing its reference count.
* This ensures that the node (as well as the image) will always be
- * kept in the cache until you call @FTC_Node_Unref to `release' it.
+ * kept in the cache until you call @FTC_Node_Unref to 'release' it.
*
- * If `anode' is NULL, the cache node is left unchanged, which means
+ * If 'anode' is NULL, the cache node is left unchanged, which means
* that the bitmap could be flushed out of the cache on the next
* call to one of the caching sub-system APIs. Don't assume that it
* is persistent!
diff --git a/include/freetype/ftcolor.h b/include/freetype/ftcolor.h
index e4fa4af..debe9f9 100644
--- a/include/freetype/ftcolor.h
+++ b/include/freetype/ftcolor.h
@@ -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.
@@ -92,7 +92,7 @@ FT_BEGIN_HEADER
* FT_PALETTE_XXX
*
* @description:
- * A list of bit field constants used in the `palette_flags' array of
+ * A list of bit field constants used in the `palette_flags` array of
* the @FT_Palette_Data structure to indicate for which background a
* palette with a given index is usable.
*
@@ -118,29 +118,29 @@ 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 ::
* The number of palettes.
*
* 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' table.
+ * A read-only array of palette name IDs with `num_palettes` elements,
+ * 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.
+ * A read-only array of palette flags with `num_palettes` elements.
* Possible values are an ORed combination of
* @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
@@ -148,17 +148,17 @@ FT_BEGIN_HEADER
*
* palette_entry_name_ids ::
* A read-only array of palette entry name IDs with
- * `num_palette_entries'. In each palette, entries with the same
+ * `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
+ * correspond to 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
+ * might correspond to 'fill' to indicate the filling color palette
* entry, etc.
*
- * An empty entry name ID in the `CPAL' table gets represented as
+ * 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
@@ -201,7 +201,7 @@ FT_BEGIN_HEADER
* All arrays in the returned @FT_Palette_Data structure are read-only.
*
* This function always returns an error if the config macro
- * `TT_CONFIG_OPTION_COLOR_LAYERS' is not defined in `ftoption.h'.
+ * `TT_CONFIG_OPTION_COLOR_LAYERS` is not defined in `ftoption.h`.
*
* @since:
* 2.10
@@ -227,7 +227,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:
@@ -239,8 +239,8 @@ FT_BEGIN_HEADER
*
* @output:
* apalette ::
- * An array of color entries for a palette with index `palette_index'.
- * If `apalette' is set to NULL, no array gets returned (and no color
+ * An array of color entries for a palette with index `palette_index`.
+ * If 'apalette' is set to NULL, no array gets returned (and no color
* entries can be modified).
*
* In case the font doesn't support color palettes, NULL is returned.
@@ -249,14 +249,14 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * The number of color entries is given by the `num_palette_entries'
+ * The number of color entries is given by the `num_palette_entries`
* field in the @FT_Palette_Data structure.
*
- * The array pointed to by `apalette_entries' is owned and managed by
+ * The array pointed to by `apalette_entries` is owned and managed by
* FreeType.
*
* This function always returns an error if the config macro
- * `TT_CONFIG_OPTION_COLOR_LAYERS' is not defined in `ftoption.h'.
+ * `TT_CONFIG_OPTION_COLOR_LAYERS` is not defined in `ftoption.h`.
*
* @since:
* 2.10
@@ -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:
@@ -281,7 +281,7 @@ FT_BEGIN_HEADER
* The source face handle.
*
* foreground_color ::
- * An `FT_Color' structure to define the text foreground color.
+ * An `FT_Color` structure to define the text foreground color.
*
* @return:
* FreeType error code. 0~means success.
@@ -291,11 +291,11 @@ 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'
+ * including the case 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'.
+ * `TT_CONFIG_OPTION_COLOR_LAYERS` is not defined in `ftoption.h`.
*
* @since:
* 2.10
diff --git a/include/freetype/ftdriver.h b/include/freetype/ftdriver.h
index 2384dc6..11988dd 100644
--- a/include/freetype/ftdriver.h
+++ b/include/freetype/ftdriver.h
@@ -50,7 +50,7 @@ FT_BEGIN_HEADER
* @FT_Property_Get. The following lists the available properties
* together with the necessary macros and structures.
*
- * Note that the auto-hinter's module name is `autofitter' for
+ * Note that the auto-hinter's module name is 'autofitter' for
* historical reasons.
*
* Available properties are @increase-x-height, @no-stem-darkening
@@ -78,14 +78,14 @@ FT_BEGIN_HEADER
* it is possible to control its behaviour with @FT_Property_Set and
* @FT_Property_Get.
*
- * The CFF driver's module name is `cff'.
+ * The CFF driver's module name is 'cff'.
*
* Available properties are @hinting-engine, @no-stem-darkening,
* @darkening-parameters, and @random-seed, as documented in the
* @properties section.
*
*
- * *Hinting* *and* *antialiasing* *principles* *of* *the* *new* *engine*
+ * **Hinting and antialiasing principles of the new engine**
*
* The rasterizer is positioning horizontal features (e.g., ascender
* height & x-height, or crossbars) on the pixel grid and minimizing the
@@ -93,14 +93,14 @@ FT_BEGIN_HEADER
* features (vertical stems) on the pixel grid without hinting, thus
* representing the stem position and weight accurately. Sometimes the
* vertical stems may be only partially black. In this context,
- * `antialiasing' means that stems are not positioned exactly on pixel
+ * 'antialiasing' means that stems are not positioned exactly on pixel
* borders, causing a fuzzy appearance.
*
* There are two principles behind this approach.
*
- * 1) No hinting in the horizontal direction: Unlike `superhinted'
+ * 1) No hinting in the horizontal direction: Unlike 'superhinted'
* TrueType, which changes glyph widths to accommodate regular
- * inter-glyph spacing, Adobe's approach is `faithful to the design' in
+ * inter-glyph spacing, Adobe's approach is 'faithful to the design' in
* representing both the glyph width and the inter-glyph spacing
* designed for the font. This makes the screen display as close as it
* can be to the result one would get with infinite resolution, while
@@ -132,13 +132,13 @@ FT_BEGIN_HEADER
*
* On the technical side, horizontal alignment zones for ascender,
* x-height, and other important height values (traditionally called
- * `blue zones') as defined in the font are positioned independently,
+ * 'blue zones') as defined in the font are positioned independently,
* each being rounded to the nearest pixel edge, taking care of
* overshoot suppression at small sizes, stem darkening, and scaling.
*
* Hstems (this is, hint values defined in the font to help align
* horizontal features) that fall within a blue zone are said to be
- * `captured' and are aligned to that zone. Uncaptured stems are moved
+ * 'captured' and are aligned to that zone. Uncaptured stems are moved
* in one of four ways, top edge up or down, bottom edge up or down.
* Unless there are conflicting hstems, the smallest movement is taken
* to minimize distortion.
@@ -164,7 +164,7 @@ FT_BEGIN_HEADER
* @no-long-family-names available if FreeType is compiled with
* PCF_CONFIG_OPTION_LONG_FAMILY_NAMES.
*
- * The PCF driver's module name is `pcf'.
+ * The PCF driver's module name is 'pcf'.
*
*/
@@ -187,8 +187,8 @@ FT_BEGIN_HEADER
* Behind the scenes, both drivers use the Adobe CFF engine for hinting;
* however, the used properties must be specified separately.
*
- * The Type~1 driver's module name is `type1'; the CID driver's module
- * name is `t1cid'.
+ * The Type~1 driver's module name is 'type1'; the CID driver's module
+ * name is 't1cid'.
*
* Available properties are @hinting-engine, @no-stem-darkening,
* @darkening-parameters, and @random-seed, as documented in the
@@ -217,7 +217,7 @@ FT_BEGIN_HEADER
* and @FT_Property_Get. The following lists the available properties
* together with the necessary macros and structures.
*
- * The TrueType driver's module name is `truetype'.
+ * The TrueType driver's module name is 'truetype'.
*
* A single property @interpreter-version is available, as documented in
* the @properties section.
@@ -225,7 +225,7 @@ FT_BEGIN_HEADER
* We start with a list of definitions, kindly provided by Greg
* Hitchcock.
*
- * _Bi-Level_ _Rendering_
+ * _Bi-Level Rendering_
*
* Monochromatic rendering, exclusively used in the early days of
* TrueType by both Apple and Microsoft. Microsoft's GDI interface
@@ -234,27 +234,27 @@ 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
+ * side bearing was hinted, and additional tables, 'hdmx' and 'LTSH', to
* cache hinting widths across multiple sizes and device aspect ratios.
*
- * _Font_ _Smoothing_
+ * _Font Smoothing_
*
* Microsoft's GDI implementation of anti-aliasing. Not traditional
* anti-aliasing as the outlines were hinted before the sampling. The
* widths matched the bi-level rendering.
*
- * _ClearType_ _Rendering_
+ * _ClearType Rendering_
*
* Technique that uses physical subpixels to improve rendering on LCD
* (and other) displays. Because of the higher resolution, many methods
* of improving symmetry in glyphs through hinting the right-side
* bearing were no longer necessary. This lead to what GDI calls
- * `natural widths' ClearType, see
+ * 'natural widths' ClearType, see
* http://www.beatstamm.com/typography/RTRCh4.htm#Sec21. Since hinting
* has extra resolution, most non-linearity went away, but it is still
* possible for hints to change the advance widths in this mode.
*
- * _ClearType_ _Compatible_ _Widths_
+ * _ClearType Compatible Widths_
*
* One of the earliest challenges with ClearType was allowing the
* implementation in GDI to be selected without requiring all UI and
@@ -267,20 +267,20 @@ FT_BEGIN_HEADER
* definition, compatible width ClearType allows for non-linear widths,
* but only when the bi-level version has non-linear widths.
*
- * _ClearType_ _Subpixel_ _Positioning_
+ * _ClearType Subpixel Positioning_
*
* One of the nice benefits of ClearType is the ability to more crisply
* display fractional widths; unfortunately, the GDI model of integer
* bitmaps did not support this. However, the WPF and Direct Write
- * frameworks do support fractional widths. DWrite calls this `natural
- * mode', not to be confused with GDI's `natural widths'. Subpixel
+ * frameworks do support fractional widths. DWrite calls this 'natural
+ * mode', not to be confused with GDI's 'natural widths'. Subpixel
* positioning, in the current implementation of Direct Write,
* unfortunately does not support hinted advance widths, see
* http://www.beatstamm.com/typography/RTRCh4.htm#Sec22. Note that the
* TrueType interpreter fully allows the advance width to be adjusted in
* this mode, just the DWrite client will ignore those changes.
*
- * _ClearType_ _Backward_ _Compatibility_
+ * _ClearType Backward Compatibility_
*
* This is a set of exceptions made in the TrueType interpreter to
* minimize hinting techniques that were problematic with the extra
@@ -293,9 +293,9 @@ FT_BEGIN_HEADER
* disabling some deltas. This could be worked around in backward
* compatibility mode.
*
- * _Native_ _ClearType_ _Mode_
+ * _Native ClearType Mode_
*
- * (Not to be confused with `natural widths'.) This mode removes all
+ * (Not to be confused with 'natural widths'.) This mode removes all
* the exceptions in the TrueType interpreter when running with
* ClearType. Any issues on widths would still apply, though.
*
@@ -357,31 +357,31 @@ FT_BEGIN_HEADER
*
* @description:
* Thanks to Adobe, which contributed a new hinting (and parsing)
- * engine, an application can select between `freetype' and `adobe' if
+ * engine, an application can select between 'freetype' and 'adobe' if
* compiled with CFF_CONFIG_OPTION_OLD_ENGINE. If this configuration
- * macro isn't defined, `hinting-engine' does nothing.
+ * macro isn't defined, 'hinting-engine' does nothing.
*
* The same holds for the Type~1 and CID modules if compiled with
* T1_CONFIG_OPTION_OLD_ENGINE.
*
- * For the `cff' module, the default engine is `freetype' if
- * CFF_CONFIG_OPTION_OLD_ENGINE is defined, and `adobe' otherwise.
+ * For the 'cff' module, the default engine is 'freetype' if
+ * CFF_CONFIG_OPTION_OLD_ENGINE is defined, and 'adobe' otherwise.
*
- * For both the `type1' and `t1cid' modules, the default engine is
- * `freetype' if T1_CONFIG_OPTION_OLD_ENGINE is defined, and `adobe'
+ * For both the 'type1' and 't1cid' modules, the default engine is
+ * 'freetype' if T1_CONFIG_OPTION_OLD_ENGINE is defined, and 'adobe'
* otherwise.
*
* @note:
* This property can be used with @FT_Property_Get also.
*
- * This property can be set via the `FREETYPE_PROPERTIES' environment
- * variable (using values `adobe' or `freetype').
+ * This property can be set via the `FREETYPE_PROPERTIES` environment
+ * variable (using values 'adobe' or 'freetype').
*
* @example:
* The following example code demonstrates how to select Adobe's hinting
- * engine for the `cff' module (omitting the error handling).
+ * engine for the 'cff' module (omitting the error handling).
*
- * {
+ * ```
* FT_Library library;
* FT_UInt hinting_engine = FT_CFF_HINTING_ADOBE;
*
@@ -390,12 +390,12 @@ FT_BEGIN_HEADER
*
* FT_Property_Set( library, "cff",
* "hinting-engine", &hinting_engine );
- * }
+ * ```
*
* @since:
- * 2.4.12 (for `cff' module)
+ * 2.4.12 (for 'cff' module)
*
- * 2.9 (for `type1' and `t1cid' modules)
+ * 2.9 (for 'type1' and 't1cid' modules)
*
*/
@@ -408,7 +408,7 @@ FT_BEGIN_HEADER
* @description:
* All glyphs that pass through the auto-hinter will be emboldened
* unless this property is set to TRUE. The same is true for the CFF,
- * Type~1, and CID font modules if the `Adobe' engine is selected (which
+ * Type~1, and CID font modules if the 'Adobe' engine is selected (which
* is the default).
*
* Stem darkening emboldens glyphs at smaller sizes to make them more
@@ -420,12 +420,12 @@ FT_BEGIN_HEADER
* Gamma correction essentially lightens fonts since shades of grey are
* shifted to higher pixel values (=~higher brightness) to match the
* original intention to the reality of our screens. The side-effect is
- * that glyphs `thin out'. Mac OS~X and Adobe's proprietary font
+ * that glyphs 'thin out'. Mac OS~X and Adobe's proprietary font
* rendering library implement a counter-measure: stem darkening at
* smaller sizes where shades of gray dominate. By emboldening a glyph
* slightly in relation to its pixel size, individual pixels get higher
- * coverage of filled-in outlines and are therefore `blacker'. This
- * counteracts the `thinning out' of glyphs, making text remain readable
+ * coverage of filled-in outlines and are therefore 'blacker'. This
+ * counteracts the 'thinning out' of glyphs, making text remain readable
* at smaller sizes.
*
* By default, the Adobe engines for CFF, Type~1, and CID fonts darken
@@ -433,7 +433,7 @@ FT_BEGIN_HEADER
* Setting this property, stem darkening gets switched off.
*
* For the auto-hinter, stem-darkening is experimental currently and
- * thus switched off by default (this is, `no-stem-darkening' is set to
+ * thus switched off by default (this is, 'no-stem-darkening' is set to
* TRUE by default). Total consistency with the CFF driver is not
* achieved right now because the emboldening method differs and glyphs
* must be scaled down on the Y-axis to keep outline points inside their
@@ -446,13 +446,13 @@ FT_BEGIN_HEADER
* @note:
* This property can be used with @FT_Property_Get also.
*
- * This property can be set via the `FREETYPE_PROPERTIES' environment
- * variable (using values 1 and 0 for `on' and `off', respectively).
+ * This property can be set via the `FREETYPE_PROPERTIES` environment
+ * variable (using values 1 and 0 for 'on' and 'off', respectively).
* It can also be set per face using @FT_Face_Properties with
* @FT_PARAM_TAG_STEM_DARKENING.
*
* @example:
- * {
+ * ```
* FT_Library library;
* FT_Bool no_stem_darkening = TRUE;
*
@@ -461,14 +461,14 @@ FT_BEGIN_HEADER
*
* FT_Property_Set( library, "cff",
* "no-stem-darkening", &no_stem_darkening );
- * }
+ * ```
*
* @since:
- * 2.4.12 (for `cff' module)
+ * 2.4.12 (for 'cff' module)
*
- * 2.6.2 (for `autofitter' module)
+ * 2.6.2 (for 'autofitter' module)
*
- * 2.9 (for `type1' and `t1cid' modules)
+ * 2.9 (for 'type1' and 't1cid' modules)
*
*/
@@ -481,20 +481,20 @@ FT_BEGIN_HEADER
* @description:
* By default, the Adobe hinting engine, as used by the CFF, Type~1, and
* CID font drivers, darkens stems as follows (if the
- * `no-stem-darkening' property isn't set):
+ * 'no-stem-darkening' property isn't set):
*
- * {
+ * ```
* stem width <= 0.5px: darkening amount = 0.4px
* stem width = 1px: darkening amount = 0.275px
* stem width = 1.667px: darkening amount = 0.275px
* stem width >= 2.333px: darkening amount = 0px
- * }
+ * ```
*
* and piecewise linear in-between. At configuration time, these four
* control points can be set with the macro
- * `CFF_CONFIG_OPTION_DARKENING_PARAMETERS'; the CFF, Type~1, and CID
+ * `CFF_CONFIG_OPTION_DARKENING_PARAMETERS`; the CFF, Type~1, and CID
* drivers share these values. At runtime, the control points can be
- * changed using the `darkening-parameters' property (see the example
+ * changed using the 'darkening-parameters' property (see the example
* below that demonstrates this for the Type~1 driver).
*
* The x~values give the stem width, and the y~values the darkening
@@ -510,17 +510,17 @@ FT_BEGIN_HEADER
* @note:
* This property can be used with @FT_Property_Get also.
*
- * This property can be set via the `FREETYPE_PROPERTIES' environment
+ * This property can be set via the `FREETYPE_PROPERTIES` environment
* variable, using eight comma-separated integers without spaces. Here
- * the above example, using `\' to break the line for readability.
+ * the above example, using '\' to break the line for readability.
*
- * {
+ * ```
* FREETYPE_PROPERTIES=\
* type1:darkening-parameters=500,300,1000,200,1500,100,2000,0
- * }
+ * ```
*
* @example:
- * {
+ * ```
* FT_Library library;
* FT_Int darken_params[8] = { 500, 300, // x1, y1
* 1000, 200, // x2, y2
@@ -532,14 +532,14 @@ FT_BEGIN_HEADER
*
* FT_Property_Set( library, "type1",
* "darkening-parameters", darken_params );
- * }
+ * ```
*
* @since:
- * 2.5.1 (for `cff' module)
+ * 2.5.1 (for 'cff' module)
*
- * 2.6.2 (for `autofitter' module)
+ * 2.6.2 (for 'autofitter' module)
*
- * 2.9 (for `type1' and `t1cid' modules)
+ * 2.9 (for 'type1' and 't1cid' modules)
*
*/
@@ -550,29 +550,29 @@ FT_BEGIN_HEADER
* random-seed
*
* @description:
- * By default, the seed value for the CFF `random' operator and the
- * similar `0 28 callothersubr pop' command for the Type~1 and CID
+ * By default, the seed value for the CFF 'random' operator and the
+ * similar '0 28 callothersubr pop' command for the Type~1 and CID
* drivers is set to a random value. However, mainly for debugging
* purposes, it is often necessary to use a known value as a seed so
- * that the pseudo-random number sequences generated by `random' are
+ * that the pseudo-random number sequences generated by 'random' are
* repeatable.
*
- * The `random-seed' property does that. Its argument is a signed 32bit
+ * The 'random-seed' property does that. Its argument is a signed 32bit
* integer; if the value is zero or negative, the seed given by the
- * `intitialRandomSeed' private DICT operator in a CFF file gets used
+ * `intitialRandomSeed` private DICT operator in a CFF file gets used
* (or a default value if there is no such operator). If the value is
- * positive, use it instead of `initialRandomSeed', which is
+ * positive, use it instead of `initialRandomSeed`, which is
* consequently ignored.
*
* @note:
- * This property can be set via the `FREETYPE_PROPERTIES' environment
+ * This property can be set via the `FREETYPE_PROPERTIES` environment
* variable. It can also be set per face using @FT_Face_Properties with
* @FT_PARAM_TAG_RANDOM_SEED.
*
* @since:
- * 2.8 (for `cff' module)
+ * 2.8 (for 'cff' module)
*
- * 2.9 (for `type1' and `t1cid' modules)
+ * 2.9 (for 'type1' and 't1cid' modules)
*
*/
@@ -586,25 +586,25 @@ FT_BEGIN_HEADER
* If PCF_CONFIG_OPTION_LONG_FAMILY_NAMES is active while compiling
* FreeType, the PCF driver constructs long family names.
*
- * There are many PCF fonts just called `Fixed' which look completely
+ * There are many PCF fonts just called 'Fixed' which look completely
* different, and which have nothing to do with each other. When
- * selecting `Fixed' in KDE or Gnome one gets results that appear rather
+ * selecting 'Fixed' in KDE or Gnome one gets results that appear rather
* random, the style changes often if one changes the size and one
* cannot select some fonts at all. The improve this situation, the PCF
* module prepends the foundry name (plus a space) to the family name.
- * It also checks whether there are `wide' characters; all put together,
- * family names like `Sony Fixed' or `Misc Fixed Wide' are constructed.
+ * It also checks whether there are 'wide' characters; all put together,
+ * family names like 'Sony Fixed' or 'Misc Fixed Wide' are constructed.
*
- * If `no-long-family-names' is set, this feature gets switched off.
+ * If 'no-long-family-names' is set, this feature gets switched off.
*
* @note:
* This property can be used with @FT_Property_Get also.
*
- * This property can be set via the `FREETYPE_PROPERTIES' environment
- * variable (using values 1 and 0 for `on' and `off', respectively).
+ * This property can be set via the `FREETYPE_PROPERTIES` environment
+ * variable (using values 1 and 0 for 'on' and 'off', respectively).
*
* @example:
- * {
+ * ```
* FT_Library library;
* FT_Bool no_long_family_names = TRUE;
*
@@ -614,7 +614,7 @@ FT_BEGIN_HEADER
* FT_Property_Set( library, "pcf",
* "no-long-family-names",
* &no_long_family_names );
- * }
+ * ```
*
* @since:
* 2.8
@@ -631,7 +631,7 @@ FT_BEGIN_HEADER
* select the hinting engine for Truetype fonts.
*
* The numeric value in the constant names represents the version
- * number as returned by the `GETINFO' bytecode instruction.
+ * number as returned by the 'GETINFO' bytecode instruction.
*
* @values:
* TT_INTERPRETER_VERSION_35 ::
@@ -642,7 +642,7 @@ FT_BEGIN_HEADER
* Version~38 corresponds to MS rasterizer v.1.9; it is roughly
* equivalent to the hinting provided by DirectWrite ClearType (as can
* be found, for example, in the Internet Explorer~9 running on
- * Windows~7). It is used in FreeType to select the `Infinality'
+ * Windows~7). It is used in FreeType to select the 'Infinality'
* subpixel hinting code. The code may be removed in a future
* version.
*
@@ -650,30 +650,30 @@ FT_BEGIN_HEADER
* Version~40 corresponds to MS rasterizer v.2.1; it is roughly
* equivalent to the hinting provided by DirectWrite ClearType (as can
* be found, for example, in Microsoft's Edge Browser on Windows~10).
- * It is used in FreeType to select the `minimal' subpixel hinting
+ * It is used in FreeType to select the 'minimal' subpixel hinting
* code, a stripped-down and higher performance version of the
- * `Infinality' code.
+ * 'Infinality' code.
*
* @note:
* This property controls the behaviour of the bytecode interpreter
- * and thus how outlines get hinted. It does *not* control how glyph
+ * and thus how outlines get hinted. It does **not** control how glyph
* get rasterized! In particular, it does not control subpixel color
* filtering.
*
* If FreeType has not been compiled with the configuration option
* TT_CONFIG_OPTION_SUBPIXEL_HINTING, selecting version~38 or~40 causes
- * an `FT_Err_Unimplemented_Feature' error.
+ * an `FT_Err_Unimplemented_Feature` error.
*
* Depending on the graphics framework, Microsoft uses different
* bytecode and rendering engines. As a consequence, the version
- * numbers returned by a call to the `GETINFO' bytecode instruction are
+ * numbers returned by a call to the 'GETINFO' bytecode instruction are
* more convoluted than desired.
*
* Here are two tables that try to shed some light on the possible
* values for the MS rasterizer engine, together with the additional
* features introduced by it.
*
- * {
+ * ```
* GETINFO framework version feature
* -------------------------------------------------------------------
* 3 GDI (Win 3.1), v1.0 16-bit, first version
@@ -696,15 +696,15 @@ FT_BEGIN_HEADER
* 40 GDI+ (after Win 7), v2.1 Y-direction ClearType flag
* DWrite (Win 8) in GETINFO opcode,
* Gray ClearType
- * }
+ * ```
*
- * The `version' field gives a rough orientation only, since some
+ * The 'version' field gives a rough orientation only, since some
* applications provided certain features much earlier (as an example,
* Microsoft Reader used subpixel and Y-direction ClearType already in
* Windows 2000). Similarly, updates to a given framework might include
* improved hinting support.
*
- * {
+ * ```
* version sampling rendering comment
* x y x y
* --------------------------------------------------------------
@@ -714,28 +714,28 @@ FT_BEGIN_HEADER
* v1.9 high high color-filter gray Color ClearType
* v2.1 high normal gray B/W Gray ClearType
* v2.1 high high gray gray Gray ClearType
- * }
+ * ```
*
* Color and Gray ClearType are the two available variants of
- * `Y-direction ClearType', meaning grayscale rasterization along the
+ * 'Y-direction ClearType', meaning grayscale rasterization along the
* Y-direction; the name used in the TrueType specification for this
- * feature is `symmetric smoothing'. `Classic ClearType' is the
+ * feature is 'symmetric smoothing'. 'Classic ClearType' is the
* original algorithm used before introducing a modified version in
- * Win~XP. Another name for v1.6's grayscale rendering is `font
- * smoothing', and `Color ClearType' is sometimes also called `DWrite
+ * Win~XP. Another name for v1.6's grayscale rendering is 'font
+ * smoothing', and 'Color ClearType' is sometimes also called 'DWrite
* ClearType'. To differentiate between today's Color ClearType and the
* earlier ClearType variant with B/W rendering along the vertical axis,
- * the latter is sometimes called `GDI ClearType'.
+ * the latter is sometimes called 'GDI ClearType'.
*
- * `Normal' and `high' sampling describe the (virtual) resolution to
- * access the rasterized outline after the hinting process. `Normal'
+ * 'Normal' and 'high' sampling describe the (virtual) resolution to
+ * access the rasterized outline after the hinting process. 'Normal'
* means 1 sample per grid line (i.e., B/W). In the current Microsoft
- * implementation, `high' means an extra virtual resolution of 16x16 (or
- * 16x1) grid lines per pixel for bytecode instructions like `MIRP'.
+ * implementation, 'high' means an extra virtual resolution of 16x16 (or
+ * 16x1) grid lines per pixel for bytecode instructions like 'MIRP'.
* After hinting, these 16 grid lines are mapped to 6x5 (or 6x1) grid
* lines for color filtering if Color ClearType is activated.
*
- * Note that `Gray ClearType' is essentially the same as v1.6's
+ * Note that 'Gray ClearType' is essentially the same as v1.6's
* grayscale rendering. However, the GETINFO instruction handles it
* differently: v1.6 returns bit~12 (hinting for grayscale), while v2.1
* returns bits~13 (hinting for ClearType), 18 (symmetrical smoothing),
@@ -760,14 +760,14 @@ FT_BEGIN_HEADER
*
* @description:
* Currently, three versions are available, two representing the
- * bytecode interpreter with subpixel hinting support (old `Infinality'
- * code and new stripped-down and higher performance `minimal' code) and
+ * bytecode interpreter with subpixel hinting support (old 'Infinality'
+ * code and new stripped-down and higher performance 'minimal' code) and
* one without, respectively. The default is subpixel support if
* TT_CONFIG_OPTION_SUBPIXEL_HINTING is defined, and no subpixel support
* otherwise (since it isn't available then).
*
* If subpixel hinting is on, many TrueType bytecode instructions behave
- * differently compared to B/W or grayscale rendering (except if `native
+ * differently compared to B/W or grayscale rendering (except if 'native
* ClearType' is selected by the font). Microsoft's main idea is to
* render at a much increased horizontal resolution, then sampling down
* the created output to subpixel precision. However, many older fonts
@@ -776,8 +776,8 @@ FT_BEGIN_HEADER
*
* Details on subpixel hinting and some of the necessary tweaks can be
* found in Greg Hitchcock's whitepaper at
- * `https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx'.
- * Note that FreeType currently doesn't really `subpixel hint' (6x1, 6x2,
+ * 'https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx'.
+ * Note that FreeType currently doesn't really 'subpixel hint' (6x1, 6x2,
* or 6x5 supersampling) like discussed in the paper. Depending on the
* chosen interpreter, it simply ignores instructions on vertical stems
* to arrive at very similar results.
@@ -785,14 +785,14 @@ FT_BEGIN_HEADER
* @note:
* This property can be used with @FT_Property_Get also.
*
- * This property can be set via the `FREETYPE_PROPERTIES' environment
- * variable (using values `35', `38', or `40').
+ * This property can be set via the `FREETYPE_PROPERTIES` environment
+ * variable (using values '35', '38', or '40').
*
* @example:
* The following example code demonstrates how to deactivate subpixel
* hinting (omitting the error handling).
*
- * {
+ * ```
* FT_Library library;
* FT_Face face;
* FT_UInt interpreter_version = TT_INTERPRETER_VERSION_35;
@@ -803,7 +803,7 @@ FT_BEGIN_HEADER
* FT_Property_Set( library, "truetype",
* "interpreter-version",
* &interpreter_version );
- * }
+ * ```
*
* @since:
* 2.5
@@ -816,7 +816,7 @@ FT_BEGIN_HEADER
* glyph-to-script-map
*
* @description:
- * *Experimental* *only*
+ * **Experimental only**
*
* The auto-hinter provides various script modules to hint glyphs.
* Examples of supported scripts are Latin or CJK. Before a glyph is
@@ -826,14 +826,14 @@ FT_BEGIN_HEADER
*
* OpenType fonts, however, often provide much more glyphs than
* character codes (small caps, superscripts, ligatures, swashes, etc.),
- * to be controlled by so-called `features'. Handling OpenType features
+ * to be controlled by so-called 'features'. Handling OpenType features
* can be quite complicated and thus needs a separate library on top of
* FreeType.
*
* The mapping between glyph indices and scripts (in the auto-hinter
* sense, see the @FT_AUTOHINTER_SCRIPT_XXX values) is stored as an
- * array with `num_glyphs' elements, as found in the font's @FT_Face
- * structure. The `glyph-to-script-map' property returns a pointer to
+ * array with `num_glyphs` elements, as found in the font's @FT_Face
+ * structure. The 'glyph-to-script-map' property returns a pointer to
* this array, which can be modified as needed. Note that the
* modification should happen before the first glyph gets processed by
* the auto-hinter so that the global analysis of the font shapes
@@ -843,7 +843,7 @@ FT_BEGIN_HEADER
* The following example code demonstrates how to access it (omitting
* the error handling).
*
- * {
+ * ```
* FT_Library library;
* FT_Face face;
* FT_Prop_GlyphToScriptMap prop;
@@ -860,7 +860,7 @@ FT_BEGIN_HEADER
* // adjust `prop.map' as needed right here
*
* FT_Load_Glyph( face, ..., FT_LOAD_FORCE_AUTOHINT );
- * }
+ * ```
*
* @since:
* 2.4.11
@@ -874,7 +874,7 @@ FT_BEGIN_HEADER
* FT_AUTOHINTER_SCRIPT_XXX
*
* @description:
- * *Experimental* *only*
+ * **Experimental only**
*
* A list of constants used for the @glyph-to-script-map property to
* specify the script submodule the auto-hinter should use for hinting a
@@ -885,14 +885,14 @@ FT_BEGIN_HEADER
* Don't auto-hint this glyph.
*
* FT_AUTOHINTER_SCRIPT_LATIN ::
- * Apply the latin auto-hinter. For the auto-hinter, `latin' is a
+ * Apply the latin auto-hinter. For the auto-hinter, 'latin' is a
* very broad term, including Cyrillic and Greek also since characters
* from those scripts share the same design constraints.
*
* By default, characters from the following Unicode ranges are
* assigned to this submodule.
*
- * {
+ * ```
* U+0020 - U+007F // Basic Latin (no control characters)
* U+00A0 - U+00FF // Latin-1 Supplement (no control characters)
* U+0100 - U+017F // Latin Extended-A
@@ -921,7 +921,7 @@ FT_BEGIN_HEADER
* U+FB00 - U+FB06 // Alphab. Present. Forms (Latin Ligatures)
* U+1D400 - U+1D7FF // Mathematical Alphanumeric Symbols
* U+1F100 - U+1F1FF // Enclosed Alphanumeric Supplement
- * }
+ * ```
*
* FT_AUTOHINTER_SCRIPT_CJK ::
* Apply the CJK auto-hinter, covering Chinese, Japanese, Korean, old
@@ -930,7 +930,7 @@ FT_BEGIN_HEADER
* By default, characters from the following Unicode ranges are
* assigned to this submodule.
*
- * {
+ * ```
* U+1100 - U+11FF // Hangul Jamo
* U+2E80 - U+2EFF // CJK Radicals Supplement
* U+2F00 - U+2FDF // Kangxi Radicals
@@ -963,7 +963,7 @@ FT_BEGIN_HEADER
* U+2A700 - U+2B73F // CJK Unified Ideographs Extension C
* U+2B740 - U+2B81F // CJK Unified Ideographs Extension D
* U+2F800 - U+2FA1F // CJK Compatibility Ideographs Supplement
- * }
+ * ```
*
* FT_AUTOHINTER_SCRIPT_INDIC ::
* Apply the indic auto-hinter, covering all major scripts from the
@@ -973,7 +973,7 @@ FT_BEGIN_HEADER
* By default, characters from the following Unicode ranges are
* assigned to this submodule.
*
- * {
+ * ```
* U+0900 - U+0DFF // Indic Range
* U+0F00 - U+0FFF // Tibetan
* U+1900 - U+194F // Limbu
@@ -981,7 +981,7 @@ FT_BEGIN_HEADER
* U+A800 - U+A82F // Syloti Nagri
* U+ABC0 - U+ABFF // Meetei Mayek
* U+11800 - U+118DF // Sharada
- * }
+ * ```
*
* Note that currently Indic support is rudimentary only, missing blue
* zone support.
@@ -1002,7 +1002,7 @@ FT_BEGIN_HEADER
* FT_Prop_GlyphToScriptMap
*
* @description:
- * *Experimental* *only*
+ * **Experimental only**
*
* The data exchange structure for the @glyph-to-script-map property.
*
@@ -1024,12 +1024,12 @@ FT_BEGIN_HEADER
* fallback-script
*
* @description:
- * *Experimental* *only*
+ * **Experimental only**
*
* If no auto-hinter script module can be assigned to a glyph, a
* fallback script gets assigned to it (see also the
* @glyph-to-script-map property). By default, this is
- * @FT_AUTOHINTER_SCRIPT_CJK. Using the `fallback-script' property,
+ * @FT_AUTOHINTER_SCRIPT_CJK. Using the 'fallback-script' property,
* this fallback value can be changed.
*
* @note:
@@ -1044,7 +1044,7 @@ FT_BEGIN_HEADER
* auto-hinter), a change of the fallback script will affect this face.
*
* @example:
- * {
+ * ```
* FT_Library library;
* FT_UInt fallback_script = FT_AUTOHINTER_SCRIPT_NONE;
*
@@ -1053,7 +1053,7 @@ FT_BEGIN_HEADER
*
* FT_Property_Set( library, "autofitter",
* "fallback-script", &fallback_script );
- * }
+ * ```
*
* @since:
* 2.4.11
@@ -1067,19 +1067,19 @@ FT_BEGIN_HEADER
* default-script
*
* @description:
- * *Experimental* *only*
+ * **Experimental only**
*
* If FreeType gets compiled with FT_CONFIG_OPTION_USE_HARFBUZZ to make
* the HarfBuzz library access OpenType features for getting better
* glyph 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 combination of the characters `T', `E', and `L' to
- * form a `TEL' ligature.
+ * explicitly handled in GSUB; an example is a 'dlig' feature,
+ * containing the combination of the characters 'T', 'E', and 'L' to
+ * form a 'TEL' ligature.
*
* By default, this is @FT_AUTOHINTER_SCRIPT_LATIN. Using the
- * `default-script' property, this default value can be changed.
+ * 'default-script' property, this default value can be changed.
*
* @note:
* This property can be used with @FT_Property_Get also.
@@ -1093,7 +1093,7 @@ FT_BEGIN_HEADER
* auto-hinter), a change of the default script will affect this face.
*
* @example:
- * {
+ * ```
* FT_Library library;
* FT_UInt default_script = FT_AUTOHINTER_SCRIPT_NONE;
*
@@ -1102,7 +1102,7 @@ FT_BEGIN_HEADER
*
* FT_Property_Set( library, "autofitter",
* "default-script", &default_script );
- * }
+ * ```
*
* @since:
* 2.5.3
@@ -1116,7 +1116,7 @@ FT_BEGIN_HEADER
* increase-x-height
*
* @description:
- * For ppem values in the range 6~<= ppem <= `increase-x-height', round
+ * For ppem values in the range 6~<= ppem <= 'increase-x-height', round
* up the font's x~height much more often than normally. If the value
* is set to~0, which is the default, this feature is switched off. Use
* this property to improve the legibility of small font sizes if
@@ -1129,7 +1129,7 @@ FT_BEGIN_HEADER
* loading any glyph (using the auto-hinter).
*
* @example:
- * {
+ * ```
* FT_Library library;
* FT_Face face;
* FT_Prop_IncreaseXHeight prop;
@@ -1144,7 +1144,7 @@ FT_BEGIN_HEADER
*
* FT_Property_Set( library, "autofitter",
* "increase-x-height", &prop );
- * }
+ * ```
*
* @since:
* 2.4.11
@@ -1175,13 +1175,13 @@ FT_BEGIN_HEADER
* warping
*
* @description:
- * *Experimental* *only*
+ * **Experimental only**
*
* If FreeType gets compiled with option AF_CONFIG_OPTION_USE_WARPER to
* activate the warp hinting code in the auto-hinter, this property
* switches warping on and off.
*
- * Warping only works in `normal' auto-hinting mode replacing it.
+ * Warping only works in 'normal' auto-hinting mode replacing it.
* The idea of the code is to slightly scale and shift a glyph along
* the non-hinted dimension (which is usually the horizontal axis) so
* that as much of its segments are aligned (more or less) to the grid.
@@ -1192,22 +1192,22 @@ FT_BEGIN_HEADER
* @note:
* This property can be used with @FT_Property_Get also.
*
- * This property can be set via the `FREETYPE_PROPERTIES' environment
- * variable (using values 1 and 0 for `on' and `off', respectively).
+ * This property can be set via the `FREETYPE_PROPERTIES` environment
+ * variable (using values 1 and 0 for 'on' and 'off', respectively).
*
* The warping code can also change advance widths. Have a look at the
- * `lsb_delta' and `rsb_delta' fields in the @FT_GlyphSlotRec structure
+ * `lsb_delta` and `rsb_delta` fields in the @FT_GlyphSlotRec structure
* for details on improving inter-glyph distances while rendering.
*
* Since warping is a global property of the auto-hinter it is best to
* change its value before rendering any face. Otherwise, you should
- * reload all faces that get auto-hinted in `normal' hinting mode.
+ * reload all faces that get auto-hinted in 'normal' hinting mode.
*
* @example:
* This example shows how to switch on warping (omitting the error
* handling).
*
- * {
+ * ```
* FT_Library library;
* FT_Bool warping = 1;
*
@@ -1215,7 +1215,7 @@ FT_BEGIN_HEADER
* FT_Init_FreeType( &library );
*
* FT_Property_Set( library, "autofitter", "warping", &warping );
- * }
+ * ```
*
* @since:
* 2.6
diff --git a/include/freetype/fterrdef.h b/include/freetype/fterrdef.h
index 3d91ed0..491e05f 100644
--- a/include/freetype/fterrdef.h
+++ b/include/freetype/fterrdef.h
@@ -28,20 +28,20 @@
* All possible error codes returned by FreeType functions.
*
* @description:
- * The list below is taken verbatim from the file `fterrdef.h'
- * (loaded automatically by including `FT_FREETYPE_H'). The first
- * argument of the `FT_ERROR_DEF_' macro is the error label; by
- * default, the prefix `FT_Err_' gets added so that you get error
- * names like `FT_Err_Cannot_Open_Resource'. The second argument is
+ * The list below is taken verbatim from the file `fterrdef.h`
+ * (loaded automatically by including `FT_FREETYPE_H`). The first
+ * argument of the `FT_ERROR_DEF_` macro is the error label; by
+ * default, the prefix `FT_Err_` gets added so that you get error
+ * names like `FT_Err_Cannot_Open_Resource`. The second argument is
* the error code, and the last argument an error string, which is not
* used by FreeType.
*
- * Within your application you should *only* use error names and
- * *never* its numeric values! The latter might (and actually do)
+ * Within your application you should **only** use error names and
+ * **never** its numeric values! The latter might (and actually do)
* change in forthcoming FreeType versions.
*
- * Macro `FT_NOERRORDEF_' defines `FT_Err_Ok', which is always zero.
- * See the `Error Enumerations' subsection how to automatically
+ * Macro `FT_NOERRORDEF_` defines `FT_Err_Ok`, which is always zero.
+ * See the 'Error Enumerations' subsection how to automatically
* generate a list of error strings.
*
*/
diff --git a/include/freetype/fterrors.h b/include/freetype/fterrors.h
index d602bd5..502dc05 100644
--- a/include/freetype/fterrors.h
+++ b/include/freetype/fterrors.h
@@ -28,20 +28,20 @@
* How to handle errors and error strings.
*
* @description:
- * The header file `fterrors.h' (which is automatically included by
- * `freetype.h' defines the handling of FreeType's enumeration
+ * The header file `fterrors.h` (which is automatically included by
+ * `freetype.h` defines the handling of FreeType's enumeration
* constants. It can also be used to generate error message strings
* with a small macro trick explained below.
*
- * *Error* *Formats*
+ * **Error Formats**
*
* The configuration macro FT_CONFIG_OPTION_USE_MODULE_ERRORS can be
- * defined in `ftoption.h' in order to make the higher byte indicate
+ * defined in `ftoption.h` in order to make the higher byte indicate
* the module where the error has happened (this is not compatible
* with standard builds of FreeType~2, however). See the file
- * `ftmoderr.h' for more details.
+ * `ftmoderr.h` for more details.
*
- * *Error* *Message* *Strings*
+ * **Error Message Strings**
*
* Error definitions are set up with special macros that allow client
* applications to build a table of error message strings. The
@@ -51,33 +51,33 @@
* To do so, you have to define the following macros before including
* this file.
*
- * {
+ * ```
* FT_ERROR_START_LIST
- * }
+ * ```
*
* This macro is called before anything else to define the start of
* the error list. It is followed by several FT_ERROR_DEF calls.
*
- * {
+ * ```
* FT_ERROR_DEF( e, v, s )
- * }
+ * ```
*
- * This macro is called to define one single error. `e' is the error
- * code identifier (e.g., `Invalid_Argument'), `v' is the error's
- * numerical value, and `s' is the corresponding error string.
+ * This macro is called to define one single error. 'e' is the error
+ * code identifier (e.g., `Invalid_Argument`), 'v' is the error's
+ * numerical value, and 's' is the corresponding error string.
*
- * {
+ * ```
* FT_ERROR_END_LIST
- * }
+ * ```
*
* This macro ends the list.
*
- * Additionally, you have to undefine `FTERRORS_H_' before #including
+ * Additionally, you have to undefine `FTERRORS_H_` before #including
* this file.
*
* Here is a simple example.
*
- * {
+ * ```
* #undef FTERRORS_H_
* #define FT_ERRORDEF( e, v, s ) { e, s },
* #define FT_ERROR_START_LIST {
@@ -90,10 +90,10 @@
* } ft_errors[] =
*
* #include FT_ERRORS_H
- * }
+ * ```
*
- * Note that `FT_Err_Ok' is _not_ defined with `FT_ERRORDEF' but with
- * `FT_NOERRORDEF'; it is always zero.
+ * Note that `FT_Err_Ok` is _not_ defined with `FT_ERRORDEF` but with
+ * `FT_NOERRORDEF`; it is always zero.
*
*/
diff --git a/include/freetype/ftfntfmt.h b/include/freetype/ftfntfmt.h
index 3f3d410..549d0b4 100644
--- a/include/freetype/ftfntfmt.h
+++ b/include/freetype/ftfntfmt.h
@@ -59,8 +59,8 @@ FT_BEGIN_HEADER
*
* @description:
* Return a string describing the format of a given face. Possible
- * values are `TrueType', `Type~1', `BDF', `PCF', `Type~42',
- * `CID~Type~1', `CFF', `PFR', and `Windows~FNT'.
+ * values are 'TrueType', 'Type~1', 'BDF', 'PCF', 'Type~42',
+ * 'CID~Type~1', 'CFF', 'PFR', and 'Windows~FNT'.
*
* The return value is suitable to be used as an X11 FONT_PROPERTY.
*
@@ -73,7 +73,7 @@ FT_BEGIN_HEADER
*
* @note:
* A deprecated name for the same function is
- * `FT_Get_X11_Font_Format'.
+ * `FT_Get_X11_Font_Format`.
*/
FT_EXPORT( const char* )
FT_Get_Font_Format( FT_Face face );
diff --git a/include/freetype/ftgasp.h b/include/freetype/ftgasp.h
index 605ff28..42e8d74 100644
--- a/include/freetype/ftgasp.h
+++ b/include/freetype/ftgasp.h
@@ -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
+ * 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.
*/
@@ -66,7 +66,7 @@ FT_BEGIN_HEADER
*
* FT_GASP_DO_GRIDFIT ::
* Grid-fitting and hinting should be performed at the specified ppem.
- * This *really* means TrueType bytecode interpretation. If this bit
+ * This **really** means TrueType bytecode interpretation. If this bit
* is not set, no hinting gets applied.
*
* FT_GASP_DO_GRAY ::
@@ -80,13 +80,13 @@ FT_BEGIN_HEADER
* Grid-fitting must be used with ClearType's symmetric smoothing.
*
* @note:
- * The bit-flags `FT_GASP_DO_GRIDFIT' and `FT_GASP_DO_GRAY' are to be
+ * The bit-flags `FT_GASP_DO_GRIDFIT` and `FT_GASP_DO_GRAY` are to be
* used for standard font rasterization only. Independently of that,
- * `FT_GASP_SYMMETRIC_SMOOTHING' and `FT_GASP_SYMMETRIC_GRIDFIT' are to
- * be used if ClearType is enabled (and `FT_GASP_DO_GRIDFIT' and
- * `FT_GASP_DO_GRAY' are consequently ignored).
+ * `FT_GASP_SYMMETRIC_SMOOTHING` and `FT_GASP_SYMMETRIC_GRIDFIT` are to
+ * be used if ClearType is enabled (and `FT_GASP_DO_GRIDFIT` and
+ * `FT_GASP_DO_GRAY` are consequently ignored).
*
- * `ClearType' is Microsoft's implementation of LCD rendering, partly
+ * 'ClearType' is Microsoft's implementation of LCD rendering, partly
* protected by patents.
*
* @since:
@@ -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
+ * flags from the font's 'gasp' table corresponding to a given
* character pixel size.
*
* @input:
@@ -118,12 +118,12 @@ 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
* (i.e., using @FT_Set_Var_Design_Coordinates and friends), call this
- * function *after* setting an instance since the return values can
+ * function **after** setting an instance since the return values can
* change.
*
* @since:
diff --git a/include/freetype/ftglyph.h b/include/freetype/ftglyph.h
index 3841930..5e432cb 100644
--- a/include/freetype/ftglyph.h
+++ b/include/freetype/ftglyph.h
@@ -138,7 +138,7 @@ FT_BEGIN_HEADER
*
* @description:
* A structure used for bitmap glyph images. This really is a
- * `sub-class' of @FT_GlyphRec.
+ * 'sub-class' of @FT_GlyphRec.
*
* @fields:
* root ::
@@ -159,7 +159,7 @@ FT_BEGIN_HEADER
*
* @note:
* You can typecast an @FT_Glyph to @FT_BitmapGlyph if you have
- * `glyph->format == FT_GLYPH_FORMAT_BITMAP'. This lets you access
+ * `glyph->format == FT_GLYPH_FORMAT_BITMAP`. This lets you access
* the bitmap's contents easily.
*
* The corresponding pixel buffer is always owned by @FT_BitmapGlyph
@@ -194,7 +194,7 @@ FT_BEGIN_HEADER
*
* @description:
* A structure used for outline (vectorial) glyph images. This
- * really is a `sub-class' of @FT_GlyphRec.
+ * really is a 'sub-class' of @FT_GlyphRec.
*
* @fields:
* root ::
@@ -205,7 +205,7 @@ FT_BEGIN_HEADER
*
* @note:
* You can typecast an @FT_Glyph to @FT_OutlineGlyph if you have
- * `glyph->format == FT_GLYPH_FORMAT_OUTLINE'. This lets you access
+ * `glyph->format == FT_GLYPH_FORMAT_OUTLINE`. This lets you access
* the outline's content easily.
*
* As the outline is extracted from a glyph slot, its coordinates are
@@ -276,8 +276,8 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * Because `*aglyph->advance.x' and `*aglyph->advance.y' are 16.16
- * fixed-point numbers, `slot->advance.x' and `slot->advance.y'
+ * Because `*aglyph->advance.x` and `*aglyph->advance.y` are 16.16
+ * fixed-point numbers, `slot->advance.x` and `slot->advance.y`
* (which are in 26.6 fixed-point format) must be in the range
* ]-32768;32768[.
*/
@@ -395,7 +395,7 @@ FT_BEGIN_HEADER
* FT_Glyph_Get_CBox
*
* @description:
- * Return a glyph's `control box'. The control box encloses all the
+ * Return a glyph's 'control box'. The control box encloses all the
* outline's points, including Bezier control points. Though it
* coincides with the exact bounding box for most glyphs, it can be
* slightly larger in some situations (like when rotating an outline
@@ -404,7 +404,7 @@ FT_BEGIN_HEADER
* Computing the control box is very fast, while getting the bounding
* box can take much more time as it needs to walk over all segments
* and arcs in the outline. To get the latter, you can use the
- * `ftbbox' component, which is dedicated to this single task.
+ * 'ftbbox' component, which is dedicated to this single task.
*
* @input:
* glyph ::
@@ -423,7 +423,7 @@ FT_BEGIN_HEADER
* Coordinates are relative to the glyph origin, using the y~upwards
* convention.
*
- * If the glyph has been loaded with @FT_LOAD_NO_SCALE, `bbox_mode'
+ * If the glyph has been loaded with @FT_LOAD_NO_SCALE, `bbox_mode`
* must be set to @FT_GLYPH_BBOX_UNSCALED to get unscaled font
* units in 26.6 pixel format. The value @FT_GLYPH_BBOX_SUBPIXELS
* is another name for this constant.
@@ -439,26 +439,26 @@ FT_BEGIN_HEADER
* one can compute the width and height of the glyph image (be it in
* integer or 26.6 pixels) as:
*
- * {
+ * ```
* width = bbox.xMax - bbox.xMin;
* height = bbox.yMax - bbox.yMin;
- * }
+ * ```
*
- * Note also that for 26.6 coordinates, if `bbox_mode' is set to
+ * Note also that for 26.6 coordinates, if `bbox_mode` is set to
* @FT_GLYPH_BBOX_GRIDFIT, the coordinates will also be grid-fitted,
* which corresponds to:
*
- * {
+ * ```
* bbox.xMin = FLOOR(bbox.xMin);
* bbox.yMin = FLOOR(bbox.yMin);
* bbox.xMax = CEILING(bbox.xMax);
* bbox.yMax = CEILING(bbox.yMax);
- * }
+ * ```
*
- * To get the bbox in pixel coordinates, set `bbox_mode' to
+ * To get the bbox in pixel coordinates, set `bbox_mode` to
* @FT_GLYPH_BBOX_TRUNCATE.
*
- * To get the bbox in grid-fitted pixel coordinates, set `bbox_mode'
+ * To get the bbox in grid-fitted pixel coordinates, set `bbox_mode`
* to @FT_GLYPH_BBOX_PIXELS.
*/
FT_EXPORT( void )
@@ -501,7 +501,7 @@ FT_BEGIN_HEADER
* @note:
* This function does nothing if the glyph format isn't scalable.
*
- * The glyph image is translated with the `origin' vector before
+ * The glyph image is translated with the 'origin' vector before
* rendering.
*
* The first parameter is a pointer to an @FT_Glyph handle, that will
@@ -509,7 +509,7 @@ FT_BEGIN_HEADER
* Typically, you would use (omitting error handling):
*
*
- * {
+ * ```
* FT_Glyph glyph;
* FT_BitmapGlyph glyph_bitmap;
*
@@ -537,13 +537,13 @@ FT_BEGIN_HEADER
*
* // discard glyph image (bitmap or not)
* FT_Done_Glyph( glyph );
- * }
+ * ```
*
*
* Here another example, again without error handling:
*
*
- * {
+ * ```
* FT_Glyph glyphs[MAX_GLYPHS]
*
*
@@ -575,7 +575,7 @@ FT_BEGIN_HEADER
*
* for ( idx = 0; i < MAX_GLYPHS; i++ )
* FT_Done_Glyph( glyphs[idx] );
- * }
+ * ```
*/
FT_EXPORT( FT_Error )
FT_Glyph_To_Bitmap( FT_Glyph* the_glyph,
@@ -618,18 +618,18 @@ FT_BEGIN_HEADER
* FT_Matrix_Multiply
*
* @description:
- * Perform the matrix operation `b = a*b'.
+ * Perform the matrix operation 'b = a*b'.
*
* @input:
* a ::
- * A pointer to matrix `a'.
+ * A pointer to matrix 'a'.
*
* @inout:
* b ::
- * A pointer to matrix `b'.
+ * A pointer to matrix 'b'.
*
* @note:
- * The result is undefined if either `a' or `b' is zero.
+ * The result is undefined if either 'a' or 'b' is zero.
*
* Since the function uses wrap-around arithmetic, results become
* meaningless if the arguments are very large.
diff --git a/include/freetype/ftgxval.h b/include/freetype/ftgxval.h
index 532b484..1f35bc7 100644
--- a/include/freetype/ftgxval.h
+++ b/include/freetype/ftgxval.h
@@ -99,7 +99,7 @@ FT_BEGIN_HEADER
*
* @description:
* The number of tables checked in this module. Use it as a parameter
- * for the `table-length' argument of function @FT_TrueTypeGX_Validate.
+ * for the 'table-length' argument of function @FT_TrueTypeGX_Validate.
*/
#define FT_VALIDATE_GX_LENGTH ( FT_VALIDATE_GX_LAST_INDEX + 1 )
@@ -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,
@@ -201,7 +201,7 @@ FT_BEGIN_HEADER
* @FT_VALIDATE_GXXXX for possible values.
*
* table_length ::
- * The size of the `tables' array. Normally, @FT_VALIDATE_GX_LENGTH
+ * The size of the 'tables' array. Normally, @FT_VALIDATE_GX_LENGTH
* should be passed.
*
* @output:
@@ -217,7 +217,7 @@ FT_BEGIN_HEADER
* otherwise.
*
* After use, the application should deallocate the buffers pointed to by
- * each `tables' element, by calling @FT_TrueTypeGX_Free. A NULL value
+ * each 'tables' element, by calling @FT_TrueTypeGX_Free. A NULL value
* indicates that the table either doesn't exist in the font, the
* application hasn't asked for validation, or the validator doesn't have
* the ability to validate the sfnt table.
@@ -267,13 +267,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 )
@@ -292,7 +292,7 @@ FT_BEGIN_HEADER
* 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.
*
@@ -313,7 +313,7 @@ FT_BEGIN_HEADER
*
* @note:
* After use, the application should deallocate the buffers pointed to by
- * `ckern_table', by calling @FT_ClassicKern_Free. A NULL value
+ * `ckern_table`, by calling @FT_ClassicKern_Free. A NULL value
* indicates that the table doesn't exist in the font.
*/
FT_EXPORT( FT_Error )
diff --git a/include/freetype/ftgzip.h b/include/freetype/ftgzip.h
index 378a365..04f9d00 100644
--- a/include/freetype/ftgzip.h
+++ b/include/freetype/ftgzip.h
@@ -55,7 +55,7 @@ FT_BEGIN_HEADER
*
* @description:
* Open a new stream to parse gzip-compressed font files. This is
- * mainly used to support the compressed `*.pcf.gz' fonts that come
+ * mainly used to support the compressed `*.pcf.gz` fonts that come
* with XFree86.
*
* @input:
@@ -71,8 +71,8 @@ FT_BEGIN_HEADER
* @note:
* The source stream must be opened _before_ calling this function.
*
- * Calling the internal function `FT_Stream_Close' on the new stream will
- * *not* call `FT_Stream_Close' on the source stream. None of the stream
+ * Calling the internal function `FT_Stream_Close` on the new stream will
+ * **not** call `FT_Stream_Close` on the source stream. None of the stream
* objects will be released to the heap.
*
* The stream implementation is very basic and resets the decompression
@@ -84,7 +84,7 @@ FT_BEGIN_HEADER
* compressed file, the library will try to open a gzipped stream from
* it and re-open the face with it.
*
- * This function may return `FT_Err_Unimplemented_Feature' if your build
+ * This function may return `FT_Err_Unimplemented_Feature` if your build
* of FreeType was not compiled with zlib support.
*/
FT_EXPORT( FT_Error )
@@ -99,7 +99,7 @@ FT_BEGIN_HEADER
*
* @description:
* Decompress a zipped input buffer into an output buffer. This function
- * is modeled after zlib's `uncompress' function.
+ * is modeled after zlib's 'uncompress' function.
*
* @input:
* memory ::
@@ -120,14 +120,14 @@ FT_BEGIN_HEADER
* Before calling the function, this is the total size of the output
* buffer, which must be large enough to hold the entire uncompressed
* data (so the size of the uncompressed data must be known in
- * advance). After calling the function, `output_len' is the size of
- * the used data in `output'.
+ * advance). After calling the function, `output_len` is the size of
+ * the used data in 'output'.
*
* @return:
* FreeType error code. 0~means success.
*
* @note:
- * This function may return `FT_Err_Unimplemented_Feature' if your build
+ * This function may return `FT_Err_Unimplemented_Feature` if your build
* of FreeType was not compiled with zlib support.
*
* @since:
diff --git a/include/freetype/ftimage.h b/include/freetype/ftimage.h
index a3fa0b6..75c671e 100644
--- a/include/freetype/ftimage.h
+++ b/include/freetype/ftimage.h
@@ -109,13 +109,13 @@ FT_BEGIN_HEADER
* left and the upper right corner. In PostScript, those values are
* often called (llx,lly) and (urx,ury), respectively.
*
- * If `yMin' is negative, this value gives the glyph's descender.
+ * If `yMin` is negative, this value gives the glyph's descender.
* Otherwise, the glyph doesn't descend below the baseline.
- * Similarly, if `ymax' is positive, this value gives the glyph's
+ * Similarly, if 'ymax' is positive, this value gives the glyph's
* ascender.
*
- * `xMin' gives the horizontal distance from the glyph's origin to
- * the left edge of the glyph's bounding box. If `xMin' is negative,
+ * `xMin` gives the horizontal distance from the glyph's origin to
+ * the left edge of the glyph's bounding box. If `xMin` is negative,
* the glyph extends to the left of the origin.
*/
typedef struct FT_BBox_
@@ -148,7 +148,7 @@ FT_BEGIN_HEADER
* FT_PIXEL_MODE_GRAY ::
* An 8-bit bitmap, generally used to represent anti-aliased glyph
* images. Each pixel is stored in one byte. Note that the number
- * of `gray' levels is stored in the `num_grays' field of the
+ * of 'gray' levels is stored in the `num_grays` field of the
* @FT_Bitmap structure (it generally is 256).
*
* FT_PIXEL_MODE_GRAY2 ::
@@ -181,7 +181,7 @@ FT_BEGIN_HEADER
* blue channel comes first in memory. The color channels are
* pre-multiplied and in the sRGB colorspace. For example, full
* red at half-translucent opacity will be represented as
- * `00,00,80,80', not `00,00,FF,80'. See also @FT_LOAD_COLOR.
+ * '00,00,80,80', not '00,00,FF,80'. See also @FT_LOAD_COLOR.
*/
typedef enum FT_Pixel_Mode_
{
@@ -216,7 +216,7 @@ FT_BEGIN_HEADER
* @description:
* A structure used to describe a bitmap or pixmap to the raster.
* Note that we now manage pixmaps of various depths through the
- * `pixel_mode' field.
+ * `pixel_mode` field.
*
* @fields:
* rows ::
@@ -229,23 +229,23 @@ FT_BEGIN_HEADER
* The pitch's absolute value is the number of bytes
* taken by one bitmap row, including padding.
* However, the pitch is positive when the bitmap has
- * a `down' flow, and negative when it has an `up'
+ * a 'down' flow, and negative when it has an 'up'
* flow. In all cases, the pitch is an offset to add
* to a bitmap pointer in order to go down one row.
*
- * Note that `padding' means the alignment of a
+ * Note that 'padding' means the alignment of a
* bitmap to a byte border, and FreeType functions
* normally align to the smallest possible integer
* value.
*
- * For the B/W rasterizer, `pitch' is always an even
+ * For the B/W rasterizer, 'pitch' is always an even
* number.
*
* To change the pitch of a bitmap (say, to make it a
* multiple of 4), use @FT_Bitmap_Convert.
* Alternatively, you might use callback functions to
* directly render to the application's surface; see
- * the file `example2.cpp' in the tutorial for a
+ * the file `example2.cpp` in the tutorial for a
* demonstration.
*
* buffer ::
@@ -311,18 +311,18 @@ FT_BEGIN_HEADER
* The number of points in the outline.
*
* points ::
- * A pointer to an array of `n_points' @FT_Vector
+ * A pointer to an array of `n_points` @FT_Vector
* elements, giving the outline's point coordinates.
*
* tags ::
- * A pointer to an array of `n_points' chars, giving
+ * A pointer to an array of `n_points` chars, giving
* each outline point's type.
*
- * If bit~0 is unset, the point is `off' the curve,
- * i.e., a Bezier control point, while it is `on' if
+ * If bit~0 is unset, the point is 'off' the curve,
+ * i.e., a Bezier control point, while it is 'on' if
* set.
*
- * Bit~1 is meaningful for `off' points only. If set,
+ * Bit~1 is meaningful for 'off' points only. If set,
* it indicates a third-order Bezier arc control point;
* and a second-order control point if unset.
*
@@ -334,11 +334,11 @@ FT_BEGIN_HEADER
* Bits 3 and~4 are reserved for internal purposes.
*
* contours ::
- * An array of `n_contours' shorts, giving the end
+ * An array of `n_contours` shorts, giving the end
* point of each contour within the outline. For
* example, the first contour is defined by the points
- * `0' to `contours[0]', the second one is defined by
- * the points `contours[0]+1' to `contours[1]', etc.
+ * '0' to 'contours[0]', the second one is defined by
+ * the points 'contours[0]+1' to 'contours[1]', etc.
*
* flags ::
* A set of bit flags used to characterize the outline
@@ -346,10 +346,10 @@ FT_BEGIN_HEADER
* how to convert/grid-fit it. See @FT_OUTLINE_XXX.
*
* @note:
- * The B/W rasterizer only checks bit~2 in the `tags' array for the
+ * The B/W rasterizer only checks bit~2 in the 'tags' array for the
* first point of each contour. The drop-out mode as given with
* @FT_OUTLINE_IGNORE_DROPOUTS, @FT_OUTLINE_SMART_DROPOUTS, and
- * @FT_OUTLINE_INCLUDE_STUBS in `flags' is then overridden.
+ * @FT_OUTLINE_INCLUDE_STUBS in 'flags' is then overridden.
*/
typedef struct FT_Outline_
{
@@ -379,7 +379,7 @@ FT_BEGIN_HEADER
*
* @description:
* A list of bit-field constants use for the flags in an outline's
- * `flags' field.
+ * 'flags' field.
*
* @values:
* FT_OUTLINE_NONE ::
@@ -387,7 +387,7 @@ FT_BEGIN_HEADER
*
* FT_OUTLINE_OWNER ::
* If set, this flag indicates that the outline's field arrays
- * (i.e., `points', `flags', and `contours') are `owned' by the
+ * (i.e., 'points', 'flags', and 'contours') are 'owned' by the
* outline object, and should thus be freed when it is destroyed.
*
* FT_OUTLINE_EVEN_ODD_FILL ::
@@ -414,7 +414,7 @@ FT_BEGIN_HEADER
* below for more information.
*
* FT_OUTLINE_INCLUDE_STUBS ::
- * If set, turn pixels on for `stubs', otherwise exclude them.
+ * If set, turn pixels on for 'stubs', otherwise exclude them.
* Ignored if @FT_OUTLINE_IGNORE_DROPOUTS is set. See below for
* more information.
*
@@ -438,10 +438,10 @@ FT_BEGIN_HEADER
* rasterizer.
*
* There exists a second mechanism to pass the drop-out mode to the
- * B/W rasterizer; see the `tags' field in @FT_Outline.
+ * B/W rasterizer; see the 'tags' field in @FT_Outline.
*
- * Please refer to the description of the `SCANTYPE' instruction in
- * the OpenType specification (in file `ttinst1.doc') how simple
+ * Please refer to the description of the 'SCANTYPE' instruction in
+ * the OpenType specification (in file `ttinst1.doc`) how simple
* drop-outs, smart drop-outs, and stubs are defined.
*/
#define FT_OUTLINE_NONE 0x0
@@ -495,14 +495,14 @@ FT_BEGIN_HEADER
* FT_Outline_MoveToFunc
*
* @description:
- * A function pointer type used to describe the signature of a `move
+ * A function pointer type used to describe the signature of a 'move
* to' function during outline walking/decomposition.
*
- * A `move to' is emitted to start a new contour in an outline.
+ * A 'move to' is emitted to start a new contour in an outline.
*
* @input:
* to ::
- * A pointer to the target point of the `move to'.
+ * A pointer to the target point of the 'move to'.
*
* user ::
* A typeless pointer, which is passed from the caller of the
@@ -524,14 +524,14 @@ FT_BEGIN_HEADER
* FT_Outline_LineToFunc
*
* @description:
- * A function pointer type used to describe the signature of a `line
+ * A function pointer type used to describe the signature of a 'line
* to' function during outline walking/decomposition.
*
- * A `line to' is emitted to indicate a segment in the outline.
+ * A 'line to' is emitted to indicate a segment in the outline.
*
* @input:
* to ::
- * A pointer to the target point of the `line to'.
+ * A pointer to the target point of the 'line to'.
*
* user ::
* A typeless pointer, which is passed from the caller of the
@@ -553,16 +553,16 @@ FT_BEGIN_HEADER
* FT_Outline_ConicToFunc
*
* @description:
- * A function pointer type used to describe the signature of a `conic
+ * A function pointer type used to describe the signature of a 'conic
* to' function during outline walking or decomposition.
*
- * A `conic to' is emitted to indicate a second-order Bezier arc in
+ * A 'conic to' is emitted to indicate a second-order Bezier arc in
* the outline.
*
* @input:
* control ::
* An intermediate control point between the last position
- * and the new target in `to'.
+ * and the new target in 'to'.
*
* to ::
* A pointer to the target end point of the conic arc.
@@ -588,10 +588,10 @@ FT_BEGIN_HEADER
* FT_Outline_CubicToFunc
*
* @description:
- * A function pointer type used to describe the signature of a `cubic
+ * A function pointer type used to describe the signature of a 'cubic
* to' function during outline walking or decomposition.
*
- * A `cubic to' is emitted to indicate a third-order Bezier arc.
+ * A 'cubic to' is emitted to indicate a third-order Bezier arc.
*
* @input:
* control1 ::
@@ -630,7 +630,7 @@ FT_BEGIN_HEADER
*
* @fields:
* move_to ::
- * The `move to' emitter.
+ * The 'move to' emitter.
*
* line_to ::
* The segment emitter.
@@ -654,12 +654,12 @@ FT_BEGIN_HEADER
* version of the original coordinates (this is important for high
* accuracy during scan-conversion). The transformation is simple:
*
- * {
+ * ```
* x' = (x << shift) - delta
* y' = (y << shift) - delta
- * }
+ * ```
*
- * Set the values of `shift' and `delta' to~0 to get the original
+ * Set the values of 'shift' and 'delta' to~0 to get the original
* point coordinates.
*/
typedef struct FT_Outline_Funcs_
@@ -696,9 +696,9 @@ FT_BEGIN_HEADER
* should redefine this macro in case of problems to something like
* this:
*
- * {
+ * ```
* #define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 ) value
- * }
+ * ```
*
* to get a simple enumeration without assigning special numbers.
*/
@@ -733,13 +733,13 @@ FT_BEGIN_HEADER
*
* FT_GLYPH_FORMAT_BITMAP ::
* The glyph image is a bitmap, and can be described as an
- * @FT_Bitmap. You generally need to access the `bitmap' field of
+ * @FT_Bitmap. You generally need to access the 'bitmap' field of
* the @FT_GlyphSlotRec structure to read it.
*
* FT_GLYPH_FORMAT_OUTLINE ::
* The glyph image is a vectorial outline made of line segments
* and Bezier arcs; it can be described as an @FT_Outline; you
- * generally want to access the `outline' field of the
+ * generally want to access the 'outline' field of the
* @FT_GlyphSlotRec structure to read it.
*
* FT_GLYPH_FORMAT_PLOTTER ::
@@ -892,7 +892,7 @@ FT_BEGIN_HEADER
* The number of spans to draw on this scanline.
*
* spans ::
- * A table of `count' spans to draw on the scanline.
+ * A table of 'count' spans to draw on the scanline.
*
* user ::
* User-supplied data that is passed to the callback.
@@ -947,7 +947,7 @@ FT_BEGIN_HEADER
* FT_RASTER_FLAG_XXX
*
* @description:
- * A list of bit flag constants as used in the `flags' field of a
+ * A list of bit flag constants as used in the 'flags' field of a
* @FT_Raster_Params structure.
*
* @values:
@@ -977,7 +977,7 @@ FT_BEGIN_HEADER
* This flag is only used in direct
* rendering mode. If set, the output will
* be clipped to a box specified in the
- * `clip_box' field of the
+ * `clip_box` field of the
* @FT_Raster_Params structure.
*
* Note that by default, the glyph bitmap
@@ -1042,11 +1042,11 @@ FT_BEGIN_HEADER
*
* @note:
* An anti-aliased glyph bitmap is drawn if the @FT_RASTER_FLAG_AA
- * bit flag is set in the `flags' field, otherwise a monochrome
+ * bit flag is set in the 'flags' field, otherwise a monochrome
* bitmap is generated.
*
- * If the @FT_RASTER_FLAG_DIRECT bit flag is set in `flags', the
- * raster will call the `gray_spans' callback to draw gray pixel
+ * If the @FT_RASTER_FLAG_DIRECT bit flag is set in 'flags', the
+ * raster will call the `gray_spans` callback to draw gray pixel
* spans. This allows direct composition over a pre-existing bitmap
* through user-provided callbacks to perform the span drawing and
* composition. Not supported by the monochrome rasterizer.
@@ -1086,7 +1086,7 @@ FT_BEGIN_HEADER
* Error code. 0~means success.
*
* @note:
- * The `memory' parameter is a typeless pointer in order to avoid
+ * The 'memory' parameter is a typeless pointer in order to avoid
* un-wanted dependencies on the rest of the FreeType code. In
* practice, it is an @FT_Memory object, i.e., a handle to the
* standard FreeType memory allocator. However, this field can be
@@ -1123,7 +1123,7 @@ FT_BEGIN_HEADER
* FT_Raster_ResetFunc
*
* @description:
- * FreeType used to provide an area of memory called the `render
+ * FreeType used to provide an area of memory called the 'render
* pool' available to all registered rasterizers. This was not
* thread safe, however, and now FreeType never allocates this pool.
*
@@ -1162,7 +1162,7 @@ FT_BEGIN_HEADER
* @description:
* This function is a generic facility to change modes or attributes
* in a given raster. This can be used for debugging purposes, or
- * simply to allow implementation-specific `features' in a given
+ * simply to allow implementation-specific 'features' in a given
* raster module.
*
* @input:
@@ -1210,12 +1210,12 @@ FT_BEGIN_HEADER
* glyph formats.
*
* Note also that the render function can fail and return a
- * `FT_Err_Unimplemented_Feature' error code if the raster used does
+ * `FT_Err_Unimplemented_Feature` error code if the raster used does
* not support direct composition.
*
* XXX: For now, the standard raster doesn't support direct
* composition but this should change for the final release (see
- * the files `demos/src/ftgrays.c' and `demos/src/ftgrays2.c'
+ * the files 'demos/src/ftgrays.c' and 'demos/src/ftgrays2.c'
* for examples of distinct implementations that support direct
* composition).
*/
diff --git a/include/freetype/ftincrem.h b/include/freetype/ftincrem.h
index 08bba73..f8ec2a4 100644
--- a/include/freetype/ftincrem.h
+++ b/include/freetype/ftincrem.h
@@ -45,7 +45,7 @@ FT_BEGIN_HEADER
*
* @description:
* This section contains various functions used to perform so-called
- * `incremental' glyph loading. This is a mode where all glyphs loaded
+ * 'incremental' glyph loading. This is a mode where all glyphs loaded
* from a given @FT_Face are provided by the client application.
*
* Apart from that, all other tables are loaded normally from the font
@@ -67,7 +67,7 @@ FT_BEGIN_HEADER
*
* @description:
* An opaque type describing a user-provided object used to implement
- * `incremental' glyph loading within FreeType. This is used to support
+ * 'incremental' glyph loading within FreeType. This is used to support
* embedded fonts in certain environments (e.g., PostScript interpreters),
* where the glyph data isn't in the font file, or must be overridden by
* different values.
@@ -109,7 +109,7 @@ FT_BEGIN_HEADER
*
* @note:
* These correspond to horizontal or vertical metrics depending on the
- * value of the `vertical' argument to the function
+ * value of the 'vertical' argument to the function
* @FT_Incremental_GetGlyphMetricsFunc.
*
*/
@@ -147,8 +147,8 @@ 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
- * *unencrypted* charstring bytes, without any `lenIV' header. It is
+ * 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.
*
* @input:
@@ -286,7 +286,7 @@ FT_BEGIN_HEADER
* wants to support incremental glyph loading. You should use it with
* @FT_PARAM_TAG_INCREMENTAL as in the following example:
*
- * {
+ * ```
* FT_Incremental_InterfaceRec inc_int;
* FT_Parameter parameter;
* FT_Open_Args open_args;
@@ -309,7 +309,7 @@ FT_BEGIN_HEADER
* // open the font
* error = FT_Open_Face( library, &open_args, index, &face );
* ...
- * }
+ * ```
*
*/
typedef struct FT_Incremental_InterfaceRec_
diff --git a/include/freetype/ftlcdfil.h b/include/freetype/ftlcdfil.h
index 8d27135..87a6e98 100644
--- a/include/freetype/ftlcdfil.h
+++ b/include/freetype/ftlcdfil.h
@@ -47,7 +47,7 @@ FT_BEGIN_HEADER
* @description:
* FreeType provides two alternative subpixel rendering technologies.
* Should you #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your
- * `ftoption.h', this enables patented ClearType-style rendering.
+ * `ftoption.h`, this enables patented ClearType-style rendering.
* Otherwise, Harmony LCD rendering is enabled. These technologies are
* controlled differently and API described below, although always
* available, performs its function when appropriate method is enabled
@@ -156,7 +156,7 @@ FT_BEGIN_HEADER
* FreeType.
*
* @since:
- * 2.3.0 (`FT_LCD_FILTER_LEGACY1' since 2.6.2)
+ * 2.3.0 (`FT_LCD_FILTER_LEGACY1` since 2.6.2)
*/
typedef enum FT_LcdFilter_
{
@@ -197,11 +197,11 @@ FT_BEGIN_HEADER
*
* @note:
* This feature is always disabled by default. Clients must make an
- * explicit call to this function with a `filter' value other than
+ * explicit call to this function with a 'filter' value other than
* @FT_LCD_FILTER_NONE in order to enable it.
*
- * Due to *PATENTS* covering subpixel rendering, this function doesn't
- * do anything except returning `FT_Err_Unimplemented_Feature' if the
+ * Due to **PATENTS** covering subpixel rendering, this function doesn't
+ * do anything except returning `FT_Err_Unimplemented_Feature` if the
* configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not
* defined in your build of the library, which should correspond to all
* default builds of FreeType.
@@ -235,8 +235,8 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * Due to *PATENTS* covering subpixel rendering, this function doesn't
- * do anything except returning `FT_Err_Unimplemented_Feature' if the
+ * Due to **PATENTS** covering subpixel rendering, this function doesn't
+ * do anything except returning `FT_Err_Unimplemented_Feature` if the
* configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not
* defined in your build of the library, which should correspond to all
* default builds of FreeType.
@@ -305,7 +305,7 @@ FT_BEGIN_HEADER
*
* - {{-11, 16}, {-11, -16}, {22, 0}} is a certain PenTile arrangement.
*
- * This function does nothing and returns `FT_Err_Unimplemented_Feature'
+ * This function does nothing and returns `FT_Err_Unimplemented_Feature`
* in the context of ClearType-style subpixel rendering when
* FT_CONFIG_OPTION_SUBPIXEL_RENDERING is defined in your build of the
* library.
diff --git a/include/freetype/ftlzw.h b/include/freetype/ftlzw.h
index 01433ca..e37196e 100644
--- a/include/freetype/ftlzw.h
+++ b/include/freetype/ftlzw.h
@@ -54,7 +54,7 @@ FT_BEGIN_HEADER
*
* @description:
* Open a new stream to parse LZW-compressed font files. This is
- * mainly used to support the compressed `*.pcf.Z' fonts that come
+ * mainly used to support the compressed `*.pcf.Z` fonts that come
* with XFree86.
*
* @input:
@@ -70,8 +70,8 @@ FT_BEGIN_HEADER
* @note:
* The source stream must be opened _before_ calling this function.
*
- * Calling the internal function `FT_Stream_Close' on the new stream will
- * *not* call `FT_Stream_Close' on the source stream. None of the stream
+ * Calling the internal function `FT_Stream_Close` on the new stream will
+ * **not** call `FT_Stream_Close` on the source stream. None of the stream
* objects will be released to the heap.
*
* The stream implementation is very basic and resets the decompression
@@ -83,7 +83,7 @@ FT_BEGIN_HEADER
* compressed file, the library will try to open a LZW stream from it
* and re-open the face with it.
*
- * This function may return `FT_Err_Unimplemented_Feature' if your build
+ * This function may return `FT_Err_Unimplemented_Feature` if your build
* of FreeType was not compiled with LZW support.
*/
FT_EXPORT( FT_Error )
diff --git a/include/freetype/ftmac.h b/include/freetype/ftmac.h
index 4249ff5..e146576 100644
--- a/include/freetype/ftmac.h
+++ b/include/freetype/ftmac.h
@@ -82,7 +82,7 @@ FT_BEGIN_HEADER
* A FOND resource.
*
* face_index ::
- * Only supported for the -1 `sanity check' special
+ * Only supported for the -1 'sanity check' special
* case.
*
* @output:
@@ -96,10 +96,10 @@ FT_BEGIN_HEADER
* This function can be used to create @FT_Face objects from fonts
* that are installed in the system as follows.
*
- * {
+ * ```
* fond = GetResource( 'FOND', fontName );
* error = FT_New_Face_From_FOND( library, fond, 0, &face );
- * }
+ * ```
*/
FT_EXPORT( FT_Error )
FT_New_Face_From_FOND( FT_Library library,
@@ -192,7 +192,7 @@ FT_BEGIN_HEADER
* buffer before calling this function.
*
* maxPathSize ::
- * Lengths of the buffer `path' that client allocated.
+ * Lengths of the buffer 'path' that client allocated.
*
* face_index ::
* Index of the face. For passing to @FT_New_Face.
diff --git a/include/freetype/ftmm.h b/include/freetype/ftmm.h
index a903241..ca7bea9 100644
--- a/include/freetype/ftmm.h
+++ b/include/freetype/ftmm.h
@@ -143,18 +143,18 @@ FT_BEGIN_HEADER
* The axis's maximum design coordinate.
*
* tag ::
- * The axis's tag (the equivalent to `name' for TrueType
+ * The axis's tag (the equivalent to 'name' for TrueType
* GX and OpenType variation fonts). FreeType provides
* default values for Adobe MM fonts if possible.
*
* strid ::
- * The axis name entry in the font's `name' table. This
- * is another (and often better) version of the `name'
+ * 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.
*
* @note:
- * The fields `minimum', `def', and `maximum' are 16.16 fractional
+ * The fields 'minimum', 'def', and 'maximum' are 16.16 fractional
* values for TrueType GX and OpenType variation fonts. For Adobe MM
* fonts, the values are integers.
*/
@@ -189,10 +189,10 @@ FT_BEGIN_HEADER
* This is an array with one 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
+ * The entry in 'name' table identifying a PostScript name
* for this instance. Value 0xFFFF indicates a missing
* entry.
*/
@@ -230,12 +230,12 @@ FT_BEGIN_HEADER
* number of designs).
*
* num_namedstyles ::
- * The number of named styles; a `named style' is
+ * The number of named styles; a 'named style' is
* a tuple of design coordinates that has a string
- * ID (in the `name' table) associated with it.
+ * 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'.
+ * [Weight=1.5,Width=1.1] is 'Bold'. Another name
+ * for 'named style' is 'named instance'.
*
* For Adobe Multiple Masters fonts, this value is
* always zero because the format does not support
@@ -331,7 +331,7 @@ FT_BEGIN_HEADER
* @input:
* library ::
* A handle of the face's parent library object that was
- * used in the call to @FT_Get_MM_Var to create `amaster'.
+ * used in the call to @FT_Get_MM_Var to create 'amaster'.
*
* @return:
* FreeType error code. 0~means success.
@@ -372,11 +372,11 @@ FT_BEGIN_HEADER
*
* @note:
* [Since 2.8.1] To reset all axes to the default values, call the
- * function with `num_coords' set to zero and `coords' set to NULL.
+ * function with `num_coords` set to zero and 'coords' set to NULL.
*
- * [Since 2.9] If `num_coords' is larger than zero, this function
- * sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags'
- * field (i.e., @FT_IS_VARIATION will return true). If `num_coords'
+ * [Since 2.9] If `num_coords` is larger than zero, this function
+ * sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags`
+ * field (i.e., @FT_IS_VARIATION will return true). If `num_coords`
* is zero, this bit flag gets unset.
*/
FT_EXPORT( FT_Error )
@@ -414,13 +414,13 @@ FT_BEGIN_HEADER
*
* @note:
* [Since 2.8.1] To reset all axes to the default values, call the
- * function with `num_coords' set to zero and `coords' set to NULL.
- * [Since 2.9] `Default values' means the currently selected named
+ * function with `num_coords` set to zero and 'coords' set to NULL.
+ * [Since 2.9] 'Default values' means the currently selected named
* instance (or the base font if no named instance is selected).
*
- * [Since 2.9] If `num_coords' is larger than zero, this function
- * sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags'
- * field (i.e., @FT_IS_VARIATION will return true). If `num_coords'
+ * [Since 2.9] If `num_coords` is larger than zero, this function
+ * sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags`
+ * field (i.e., @FT_IS_VARIATION will return true). If `num_coords`
* is zero, this bit flag gets unset.
*/
FT_EXPORT( FT_Error )
@@ -498,13 +498,13 @@ FT_BEGIN_HEADER
*
* @note:
* [Since 2.8.1] To reset all axes to the default values, call the
- * function with `num_coords' set to zero and `coords' set to NULL.
- * [Since 2.9] `Default values' means the currently selected named
+ * function with `num_coords` set to zero and 'coords' set to NULL.
+ * [Since 2.9] 'Default values' means the currently selected named
* instance (or the base font if no named instance is selected).
*
- * [Since 2.9] If `num_coords' is larger than zero, this function
- * sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags'
- * field (i.e., @FT_IS_VARIATION will return true). If `num_coords'
+ * [Since 2.9] If `num_coords` is larger than zero, this function
+ * sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags`
+ * field (i.e., @FT_IS_VARIATION will return true). If `num_coords`
* is zero, this bit flag gets unset.
*/
FT_EXPORT( FT_Error )
@@ -606,9 +606,9 @@ FT_BEGIN_HEADER
* FT_Get_Var_Axis_Flags
*
* @description:
- * Get the `flags' field of an OpenType Variation Axis Record.
+ * Get the 'flags' field of an OpenType Variation Axis Record.
*
- * Not meaningful for Adobe MM fonts (`*flags' is always zero).
+ * Not meaningful for Adobe MM fonts ('*flags' is always zero).
*
* @input:
* master ::
@@ -619,7 +619,7 @@ FT_BEGIN_HEADER
*
* @output:
* flags ::
- * The `flags' field. See @FT_VAR_AXIS_FLAG_XXX for
+ * The 'flags' field. See @FT_VAR_AXIS_FLAG_XXX for
* possible values.
*
* @return:
@@ -656,10 +656,10 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * The function uses the value of `instance_index' to set bits 16-30
- * of the face's `face_index' field. It also resets any variation
+ * The function uses the value of `instance_index` to set bits 16-30
+ * of the face's `face_index` field. It also resets any variation
* applied to the font, and the @FT_FACE_FLAG_VARIATION bit of the
- * face's `face_flags' field gets reset to zero (i.e.,
+ * face's `face_flags` field gets reset to zero (i.e.,
* @FT_IS_VARIATION will return false).
*
* For Adobe MM fonts (which don't have named instances) this
diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h
index c50c9ce..28fef9a 100644
--- a/include/freetype/ftmodapi.h
+++ b/include/freetype/ftmodapi.h
@@ -49,10 +49,10 @@ FT_BEGIN_HEADER
* Modules can be added, upgraded, and removed at runtime.
* Additionally, some module properties can be controlled also.
*
- * Here is a list of possible values of the `module_name' field in
+ * Here is a list of possible values of the `module_name` field in
* the @FT_Module_Class structure.
*
- * {
+ * ```
* autofitter
* bdf
* cff
@@ -71,7 +71,7 @@ FT_BEGIN_HEADER
* type42
* t1cid
* winfonts
- * }
+ * ```
*
* Note that the FreeType Cache sub-system is not a FreeType module.
*
@@ -219,7 +219,7 @@ FT_BEGIN_HEADER
* module_interface ::
* A typeless pointer to a structure (which varies between different
* modules) that holds the module's interface functions. This is
- * essentially what `get_interface' returns.
+ * essentially what `get_interface` returns.
*
* module_init ::
* The initializing function.
@@ -352,27 +352,27 @@ FT_BEGIN_HEADER
*
* value ::
* A generic pointer to a variable or structure that gives the new
- * value of the property. The exact definition of `value' is
+ * value of the property. The exact definition of 'value' is
* dependent on the property; see section @properties.
*
* @return:
* FreeType error code. 0~means success.
*
* @note:
- * If `module_name' isn't a valid module name, or `property_name'
- * doesn't specify a valid property, or if `value' doesn't represent a
+ * If `module_name` isn't a valid module name, or `property_name`
+ * doesn't specify a valid property, or if 'value' doesn't represent a
* valid value for the given property, an error is returned.
*
- * The following example sets property `bar' (a simple integer) in
- * module `foo' to value~1.
+ * The following example sets property 'bar' (a simple integer) in
+ * module 'foo' to value~1.
*
- * {
+ * ```
* FT_UInt bar;
*
*
* bar = 1;
* FT_Property_Set( library, "foo", "bar", &bar );
- * }
+ * ```
*
* Note that the FreeType Cache sub-system doesn't recognize module
* property changes. To avoid glyph lookup confusion within the cache
@@ -417,20 +417,20 @@ FT_BEGIN_HEADER
* @inout:
* value ::
* A generic pointer to a variable or structure that gives the
- * value of the property. The exact definition of `value' is
+ * value of the property. The exact definition of 'value' is
* dependent on the property; see section @properties.
*
* @return:
* FreeType error code. 0~means success.
*
* @note:
- * If `module_name' isn't a valid module name, or `property_name'
- * doesn't specify a valid property, or if `value' doesn't represent a
+ * If `module_name` isn't a valid module name, or `property_name`
+ * doesn't specify a valid property, or if 'value' doesn't represent a
* valid value for the given property, an error is returned.
*
- * The following example gets property `baz' (a range) in module `foo'.
+ * The following example gets property 'baz' (a range) in module 'foo'.
*
- * {
+ * ```
* typedef range_
* {
* FT_Int32 min;
@@ -442,7 +442,7 @@ FT_BEGIN_HEADER
*
*
* FT_Property_Get( library, "foo", "baz", &baz );
- * }
+ * ```
*
* It is not possible to retrieve properties of the FreeType Cache
* sub-system with FT_Property_Get; use @FTC_Property_Get instead.
@@ -465,16 +465,16 @@ FT_BEGIN_HEADER
*
* @description:
* If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is
- * set, this function reads the `FREETYPE_PROPERTIES' environment
+ * set, this function reads the `FREETYPE_PROPERTIES` environment
* variable to control driver properties. See section @properties
* for more.
*
* If the compilation option is not set, this function does nothing.
*
- * `FREETYPE_PROPERTIES' has the following syntax form (broken here
+ * `FREETYPE_PROPERTIES` has the following syntax form (broken here
* into multiple lines for better readability).
*
- * {
+ * ```
* <optional whitespace>
* <module-name1> ':'
* <property-name1> '=' <property-value1>
@@ -482,15 +482,15 @@ FT_BEGIN_HEADER
* <module-name2> ':'
* <property-name2> '=' <property-value2>
* ...
- * }
+ * ```
*
* Example:
*
- * {
+ * ```
* FREETYPE_PROPERTIES=truetype:interpreter-version=35 \
* cff:no-stem-darkening=1 \
* autofitter:warping=1
- * }
+ * ```
*
* @inout:
* library ::
@@ -616,8 +616,8 @@ FT_BEGIN_HEADER
* @input:
* hook_index ::
* The index of the debug hook. You should use the
- * values defined in `ftobjs.h', e.g.,
- * `FT_DEBUG_HOOK_TRUETYPE'.
+ * values defined in `ftobjs.h`, e.g.,
+ * `FT_DEBUG_HOOK_TRUETYPE`.
*
* debug_hook ::
* The function used to debug the interpreter.
@@ -627,7 +627,7 @@ FT_BEGIN_HEADER
* the TrueType and the Type~1 interpreter) are defined.
*
* Since the internal headers of FreeType are no longer installed,
- * the symbol `FT_DEBUG_HOOK_TRUETYPE' isn't available publicly.
+ * the symbol `FT_DEBUG_HOOK_TRUETYPE` isn't available publicly.
* This is a bug and will be fixed in a forthcoming release.
*/
FT_EXPORT( void )
diff --git a/include/freetype/ftoutln.h b/include/freetype/ftoutln.h
index 9dae104..be3f4b2 100644
--- a/include/freetype/ftoutln.h
+++ b/include/freetype/ftoutln.h
@@ -47,7 +47,7 @@ FT_BEGIN_HEADER
*
* @description:
* This section contains routines used to create and destroy scalable
- * glyph images known as `outlines'. These can also be measured,
+ * glyph images known as 'outlines'. These can also be measured,
* transformed, and converted into bitmaps and pixmaps.
*
* @order:
@@ -89,7 +89,7 @@ FT_BEGIN_HEADER
*
* @description:
* Walk over an outline's structure to decompose it into individual
- * segments and Bezier arcs. This function also emits `move to'
+ * segments and Bezier arcs. This function also emits 'move to'
* operations to indicate the start of new contours in the outline.
*
* @input:
@@ -97,7 +97,7 @@ FT_BEGIN_HEADER
* A pointer to the source target.
*
* func_interface ::
- * A table of `emitters', i.e., function pointers
+ * A table of 'emitters', i.e., function pointers
* called during decomposition to indicate path
* operations.
*
@@ -113,7 +113,7 @@ FT_BEGIN_HEADER
*
* @note:
* A contour that contains a single point only is represented by a
- * `move to' operation followed by `line to' to the same point. In
+ * 'move to' operation followed by 'line to' to the same point. In
* most cases, it is best to filter this out before using the
* outline for stroking purposes (otherwise it would result in a
* visible dot when round caps are used).
@@ -140,7 +140,7 @@ FT_BEGIN_HEADER
* library ::
* A handle to the library object from where the
* outline is allocated. Note however that the new
- * outline will *not* necessarily be *freed*, when
+ * outline will **not** necessarily be **freed**, when
* destroying the library, by @FT_Done_FreeType.
*
* numPoints ::
@@ -149,7 +149,7 @@ FT_BEGIN_HEADER
*
* numContours ::
* The maximum number of contours within the outline.
- * This value must be in the range 0 to `numPoints'.
+ * This value must be in the range 0 to `numPoints`.
*
* @output:
* anoutline ::
@@ -159,7 +159,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * The reason why this function takes a `library' parameter is simply
+ * The reason why this function takes a 'library' parameter is simply
* to use the library's memory allocator.
*/
FT_EXPORT( FT_Error )
@@ -196,7 +196,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * If the outline's `owner' field is not set, only the outline
+ * If the outline's 'owner' field is not set, only the outline
* descriptor will be released.
*/
FT_EXPORT( FT_Error )
@@ -238,7 +238,7 @@ FT_BEGIN_HEADER
* FT_Outline_Get_CBox
*
* @description:
- * Return an outline's `control box'. The control box encloses all
+ * Return an outline's 'control box'. The control box encloses all
* the outline's points, including Bezier control points. Though it
* coincides with the exact bounding box for most glyphs, it can be
* slightly larger in some situations (like when rotating an outline
@@ -247,7 +247,7 @@ FT_BEGIN_HEADER
* Computing the control box is very fast, while getting the bounding
* box can take much more time as it needs to walk over all segments
* and arcs in the outline. To get the latter, you can use the
- * `ftbbox' component, which is dedicated to this single task.
+ * 'ftbbox' component, which is dedicated to this single task.
*
* @input:
* outline ::
@@ -349,10 +349,10 @@ FT_BEGIN_HEADER
*
* @description:
* Embolden an outline. The new outline will be at most 4~times
- * `strength' pixels wider and higher. You may think of the left and
+ * 'strength' pixels wider and higher. You may think of the left and
* bottom borders as unchanged.
*
- * Negative `strength' values to reduce the outline thickness are
+ * Negative 'strength' values to reduce the outline thickness are
* possible also.
*
* @inout:
@@ -373,19 +373,19 @@ FT_BEGIN_HEADER
* situations like acute angles or intersections are sometimes
* handled incorrectly.
*
- * If you need `better' metrics values you should call
+ * If you need 'better' metrics values you should call
* @FT_Outline_Get_CBox or @FT_Outline_Get_BBox.
*
* To get meaningful results, font scaling values must be set with
* functions like @FT_Set_Char_Size before calling FT_Render_Glyph.
*
* @example:
- * {
+ * ```
* FT_Load_Glyph( face, index, FT_LOAD_DEFAULT );
*
* if ( face->glyph->format == FT_GLYPH_FORMAT_OUTLINE )
* FT_Outline_Embolden( &face->glyph->outline, strength );
- * }
+ * ```
*
*/
FT_EXPORT( FT_Error )
@@ -399,8 +399,8 @@ FT_BEGIN_HEADER
* FT_Outline_EmboldenXY
*
* @description:
- * Embolden an outline. The new outline will be `xstrength' pixels
- * wider and `ystrength' pixels higher. Otherwise, it is similar to
+ * Embolden an outline. The new outline will be 'xstrength' pixels
+ * wider and 'ystrength' pixels higher. Otherwise, it is similar to
* @FT_Outline_Embolden, which uses the same strength in both
* directions.
*
@@ -428,7 +428,7 @@ FT_BEGIN_HEADER
*
* @note:
* This function toggles the bit flag @FT_OUTLINE_REVERSE_FILL in
- * the outline's `flags' field.
+ * the outline's 'flags' field.
*
* It shouldn't be used by a normal client application, unless it
* knows what it is doing.
@@ -463,11 +463,11 @@ FT_BEGIN_HEADER
* @note:
* This function does NOT CREATE the bitmap, it only renders an
* outline image within the one you pass to it! Consequently, the
- * various fields in `abitmap' should be set accordingly.
+ * various fields in 'abitmap' should be set accordingly.
*
* It will use the raster corresponding to the default glyph format.
*
- * The value of the `num_grays' field in `abitmap' is ignored. If
+ * The value of the `num_grays` field in 'abitmap' is ignored. If
* you select the gray-level rasterizer, and you want less than 256
* gray levels, you have to use @FT_Outline_Render directly.
*/
@@ -507,13 +507,13 @@ FT_BEGIN_HEADER
* You should know what you are doing and how @FT_Raster_Params works
* to use this function.
*
- * The field `params.source' will be set to `outline' before the scan
+ * The field `params.source` will be set to 'outline' before the scan
* converter is called, which means that the value you give to it is
* actually ignored.
*
* The gray-level rasterizer always uses 256 gray levels. If you
* want less gray levels, you have to provide your own span callback.
- * See the @FT_RASTER_FLAG_DIRECT value of the `flags' field in the
+ * See the @FT_RASTER_FLAG_DIRECT value of the 'flags' field in the
* @FT_Raster_Params structure for more details.
*/
FT_EXPORT( FT_Error )
diff --git a/include/freetype/ftparams.h b/include/freetype/ftparams.h
index 004eaf5..94c6168 100644
--- a/include/freetype/ftparams.h
+++ b/include/freetype/ftparams.h
@@ -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
+ * 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.
*
@@ -165,7 +165,7 @@ FT_BEGIN_HEADER
*
* This is a passive setting that only takes effect if the font driver
* or autohinter honors it, which the CFF, Type~1, and CID drivers
- * always do, but the autohinter only in `light' hinting mode (as of
+ * always do, but the autohinter only in 'light' hinting mode (as of
* version 2.9).
*
* @since:
diff --git a/include/freetype/ftpfr.h b/include/freetype/ftpfr.h
index deaae61..39100e5 100644
--- a/include/freetype/ftpfr.h
+++ b/include/freetype/ftpfr.h
@@ -63,21 +63,21 @@ FT_BEGIN_HEADER
*
* @output:
* aoutline_resolution ::
- * Outline resolution. This is equivalent to `face->units_per_EM'
+ * Outline resolution. This is equivalent to `face->units_per_EM`
* for non-PFR fonts. Optional (parameter can be NULL).
*
* ametrics_resolution ::
- * Metrics resolution. This is equivalent to `outline_resolution'
+ * Metrics resolution. This is equivalent to `outline_resolution`
* for non-PFR fonts. Optional (parameter can be NULL).
*
* ametrics_x_scale ::
* A 16.16 fixed-point number used to scale distance expressed
* in metrics units to device subpixels. This is equivalent to
- * `face->size->x_scale', but for metrics only. Optional (parameter
+ * `face->size->x_scale`, but for metrics only. Optional (parameter
* can be NULL).
*
* ametrics_y_scale ::
- * Same as `ametrics_x_scale' but for the vertical direction.
+ * Same as `ametrics_x_scale` but for the vertical direction.
* optional (parameter can be NULL).
*
* @return:
@@ -127,7 +127,7 @@ FT_BEGIN_HEADER
* units. This is unlike @FT_Get_Kerning with the @FT_KERNING_UNSCALED
* mode, which always returns distances converted to outline units.
*
- * You can use the value of the `x_scale' and `y_scale' parameters
+ * You can use the value of the `x_scale` and `y_scale` parameters
* returned by @FT_Get_PFR_Metrics to scale these to device subpixels.
*/
FT_EXPORT( FT_Error )
@@ -161,7 +161,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * You can use the `x_scale' or `y_scale' results of @FT_Get_PFR_Metrics
+ * You can use the `x_scale` or `y_scale` results of @FT_Get_PFR_Metrics
* to convert the advance to device subpixels (i.e., 1/64th of pixels).
*/
FT_EXPORT( FT_Error )
diff --git a/include/freetype/ftrender.h b/include/freetype/ftrender.h
index 2b7e5c8..07faa3d 100644
--- a/include/freetype/ftrender.h
+++ b/include/freetype/ftrender.h
@@ -226,7 +226,7 @@ FT_BEGIN_HEADER
*
* This doesn't change the current renderer for other formats.
*
- * Currently, no FreeType renderer module uses `parameters'; you
+ * Currently, no FreeType renderer module uses 'parameters'; you
* should thus always pass NULL as the value.
*/
FT_EXPORT( FT_Error )
diff --git a/include/freetype/ftsizes.h b/include/freetype/ftsizes.h
index 481a053..ea28526 100644
--- a/include/freetype/ftsizes.h
+++ b/include/freetype/ftsizes.h
@@ -56,7 +56,7 @@ FT_BEGIN_HEADER
* @description:
* When creating a new face object (e.g., with @FT_New_Face), an
* @FT_Size object is automatically created and used to store all
- * pixel-size dependent information, available in the `face->size'
+ * pixel-size dependent information, available in the `face->size`
* field.
*
* It is however possible to create more sizes for a given face,
@@ -64,7 +64,7 @@ FT_BEGIN_HEADER
* same font family and style. See @FT_New_Size and @FT_Done_Size.
*
* Note that @FT_Set_Pixel_Sizes and @FT_Set_Char_Size only
- * modify the contents of the current `active' size; you thus need
+ * modify the contents of the current 'active' size; you thus need
* to use @FT_Activate_Size to change it.
*
* 99% of applications won't need the functions provided here,
@@ -133,9 +133,9 @@ FT_BEGIN_HEADER
* Even though it is possible to create several size objects for a
* given face (see @FT_New_Size for details), functions like
* @FT_Load_Glyph or @FT_Load_Char only use the one that has been
- * activated last to determine the `current character pixel size'.
+ * activated last to determine the 'current character pixel size'.
*
- * This function can be used to `activate' a previously created size
+ * This function can be used to 'activate' a previously created size
* object.
*
* @input:
@@ -146,8 +146,8 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * If `face' is the size's parent face object, this function changes
- * the value of `face->size' to the input size handle.
+ * If 'face' is the size's parent face object, this function changes
+ * the value of `face->size` to the input size handle.
*/
FT_EXPORT( FT_Error )
FT_Activate_Size( FT_Size size );
diff --git a/include/freetype/ftsnames.h b/include/freetype/ftsnames.h
index 0a0ac31..d25b569 100644
--- a/include/freetype/ftsnames.h
+++ b/include/freetype/ftsnames.h
@@ -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
+ * a special names table ('name') in font files. This table contains
* textual (and internationalized) information regarding the font,
* like family name, copyright, version, etc.
*
@@ -67,43 +67,43 @@ 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 ::
- * The platform ID for `string'.
+ * The platform ID for 'string'.
* See @TT_PLATFORM_XXX for possible values.
*
* encoding_id ::
- * The encoding ID for `string'.
+ * The encoding ID for 'string'.
* See @TT_APPLE_ID_XXX, @TT_MAC_ID_XXX,
* @TT_ISO_ID_XXX, @TT_MS_ID_XXX, and @TT_ADOBE_ID_XXX
* for possible values.
*
* language_id ::
- * The language ID for `string'.
+ * The language ID for 'string'.
* See @TT_MAC_LANGID_XXX and @TT_MS_LANGID_XXX for
* possible values.
*
- * Registered OpenType values for `language_id' are
+ * Registered OpenType values for `language_id` are
* always smaller than 0x8000; values equal or larger
* than 0x8000 usually indicate a language tag string
* (introduced in OpenType version 1.6). Use function
- * @FT_Get_Sfnt_LangTag with `language_id' as its
+ * @FT_Get_Sfnt_LangTag with `language_id` as its
* argument to retrieve the associated language tag.
*
* name_id ::
- * An identifier for `string'.
+ * An identifier for 'string'.
* See @TT_NAME_ID_XXX for possible values.
*
* string ::
- * The `name' string. Note that its format differs
+ * The 'name' string. Note that its format differs
* depending on the (platform,encoding) pair, being
* either a string of bytes (without a terminating
* NULL byte) or containing UTF-16BE entities.
*
* string_len ::
- * The length of `string' in bytes.
+ * The length of 'string' in bytes.
*
* @note:
* Please refer to the TrueType or OpenType specification for more
@@ -128,18 +128,18 @@ 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
- * `TT_CONFIG_OPTION_SFNT_NAMES' is not defined in `ftoption.h'.
+ * `TT_CONFIG_OPTION_SFNT_NAMES` is not defined in `ftoption.h`.
*/
FT_EXPORT( FT_UInt )
FT_Get_Sfnt_Name_Count( FT_Face face );
@@ -151,14 +151,14 @@ 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 ::
* A handle to the source face.
*
* idx ::
- * The index of the `name' string.
+ * The index of the 'name' string.
*
* @output:
* aname ::
@@ -168,19 +168,19 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * The `string' array returned in the `aname' structure is not
- * null-terminated. Note that you don't have to deallocate `string'
+ * The 'string' array returned in the 'aname' structure is not
+ * null-terminated. Note that you don't have to deallocate 'string'
* by 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
+ * '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
- * `TT_CONFIG_OPTION_SFNT_NAMES' is not defined in `ftoption.h'.
+ * `TT_CONFIG_OPTION_SFNT_NAMES` is not defined in `ftoption.h`.
*/
FT_EXPORT( FT_Error )
FT_Get_Sfnt_Name( FT_Face face,
@@ -194,7 +194,7 @@ FT_BEGIN_HEADER
* FT_SfntLangTag
*
* @description:
- * A structure to model a language tag entry from an SFNT `name'
+ * A structure to model a language tag entry from an SFNT 'name'
* table.
*
* @fields:
@@ -203,7 +203,7 @@ FT_BEGIN_HEADER
* (without trailing NULL bytes).
*
* string_len ::
- * The length of `string' in *bytes*.
+ * The length of 'string' in **bytes**.
*
* @note:
* Please refer to the TrueType or OpenType specification for more
@@ -227,7 +227,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 ::
@@ -239,24 +239,24 @@ FT_BEGIN_HEADER
*
* @output:
* alangTag ::
- * The language tag associated with the `name' table
+ * The language tag associated with the 'name' table
* entry's language ID.
*
* @return:
* FreeType error code. 0~means success.
*
* @note:
- * The `string' array returned in the `alangTag' structure is not
- * null-terminated. Note that you don't have to deallocate `string'
+ * The 'string' array returned in the `alangTag` structure is not
+ * 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.
*
* This function always returns an error if the config macro
- * `TT_CONFIG_OPTION_SFNT_NAMES' is not defined in `ftoption.h'.
+ * `TT_CONFIG_OPTION_SFNT_NAMES` is not defined in `ftoption.h`.
*
* @since:
* 2.8
diff --git a/include/freetype/ftstroke.h b/include/freetype/ftstroke.h
index 91d2776..7ea1705 100644
--- a/include/freetype/ftstroke.h
+++ b/include/freetype/ftstroke.h
@@ -40,10 +40,10 @@ FT_BEGIN_HEADER
*
* @description:
* This component generates stroked outlines of a given vectorial
- * glyph. It also allows you to retrieve the `outside' and/or the
- * `inside' borders of the stroke.
+ * glyph. It also allows you to retrieve the 'outside' and/or the
+ * 'inside' borders of the stroke.
*
- * This can be useful to generate `bordered' glyph, i.e., glyphs
+ * This can be useful to generate 'bordered' glyph, i.e., glyphs
* displayed with a coloured (and anti-aliased) border around their
* shape.
*
@@ -197,9 +197,9 @@ FT_BEGIN_HEADER
* Select the right border, relative to the drawing direction.
*
* @note:
- * Applications are generally interested in the `inside' and `outside'
+ * Applications are generally interested in the 'inside' and 'outside'
* borders. However, there is no direct mapping between these and the
- * `left' and `right' ones, since this really depends on the glyph's
+ * 'left' and 'right' ones, since this really depends on the glyph's
* drawing orientation, which varies between font formats.
*
* You can however use @FT_Outline_GetInsideBorder and
@@ -220,7 +220,7 @@ FT_BEGIN_HEADER
*
* @description:
* Retrieve the @FT_StrokerBorder value corresponding to the
- * `inside' borders of a given outline.
+ * 'inside' borders of a given outline.
*
* @input:
* outline ::
@@ -241,7 +241,7 @@ FT_BEGIN_HEADER
*
* @description:
* Retrieve the @FT_StrokerBorder value corresponding to the
- * `outside' borders of a given outline.
+ * 'outside' borders of a given outline.
*
* @input:
* outline ::
@@ -363,11 +363,11 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * If `opened' is~0 (the default), the outline is treated as a closed
- * path, and the stroker generates two distinct `border' outlines.
+ * If 'opened' is~0 (the default), the outline is treated as a closed
+ * path, and the stroker generates two distinct 'border' outlines.
*
- * If `opened' is~1, the outline is processed as an open path, and the
- * stroker generates a single `stroke' outline.
+ * If 'opened' is~1, the outline is processed as an open path, and the
+ * stroker generates a single 'stroke' outline.
*
* This function calls @FT_Stroker_Rewind automatically.
*/
@@ -425,7 +425,7 @@ FT_BEGIN_HEADER
*
* @note:
* You should call this function after @FT_Stroker_BeginSubPath.
- * If the subpath was not `opened', this function `draws' a
+ * If the subpath was not 'opened', this function 'draws' a
* single line segment to the start position when needed.
*/
FT_EXPORT( FT_Error )
@@ -438,7 +438,7 @@ FT_BEGIN_HEADER
* FT_Stroker_LineTo
*
* @description:
- * `Draw' a single line segment in the stroker's current sub-path,
+ * 'Draw' a single line segment in the stroker's current sub-path,
* from the last position.
*
* @input:
@@ -466,7 +466,7 @@ FT_BEGIN_HEADER
* FT_Stroker_ConicTo
*
* @description:
- * `Draw' a single quadratic Bezier in the stroker's current sub-path,
+ * 'Draw' a single quadratic Bezier in the stroker's current sub-path,
* from the last position.
*
* @input:
@@ -498,7 +498,7 @@ FT_BEGIN_HEADER
* FT_Stroker_CubicTo
*
* @description:
- * `Draw' a single cubic Bezier in the stroker's current sub-path,
+ * 'Draw' a single cubic Bezier in the stroker's current sub-path,
* from the last position.
*
* @input:
@@ -536,7 +536,7 @@ FT_BEGIN_HEADER
* @description:
* Call this function once you have finished parsing your paths
* with the stroker. It returns the number of points and
- * contours necessary to export one of the `border' or `stroke'
+ * contours necessary to export one of the 'border' or 'stroke'
* outlines generated by the stroker.
*
* @input:
@@ -557,12 +557,12 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
- * When an outline, or a sub-path, is `closed', the stroker generates
- * two independent `border' outlines, named `left' and `right'.
+ * When an outline, or a sub-path, is 'closed', the stroker generates
+ * two independent 'border' outlines, named 'left' and 'right'.
*
- * When the outline, or a sub-path, is `opened', the stroker merges
- * the `border' outlines with caps. The `left' border receives all
- * points, while the `right' border becomes empty.
+ * When the outline, or a sub-path, is 'opened', the stroker merges
+ * the 'border' outlines with caps. The 'left' border receives all
+ * points, while the 'right' border becomes empty.
*
* Use the function @FT_Stroker_GetCounts instead if you want to
* retrieve the counts associated to both borders.
@@ -603,12 +603,12 @@ FT_BEGIN_HEADER
* get sure that there is enough room in your @FT_Outline object to
* receive all new data.
*
- * When an outline, or a sub-path, is `closed', the stroker generates
- * two independent `border' outlines, named `left' and `right'.
+ * When an outline, or a sub-path, is 'closed', the stroker generates
+ * two independent 'border' outlines, named 'left' and 'right'.
*
- * When the outline, or a sub-path, is `opened', the stroker merges
- * the `border' outlines with caps. The `left' border receives all
- * points, while the `right' border becomes empty.
+ * When the outline, or a sub-path, is 'opened', the stroker merges
+ * the 'border' outlines with caps. The 'left' border receives all
+ * points, while the 'right' border becomes empty.
*
* Use the function @FT_Stroker_Export instead if you want to
* retrieve all borders at once.
diff --git a/include/freetype/ftsystem.h b/include/freetype/ftsystem.h
index 0b415b6..44011b7 100644
--- a/include/freetype/ftsystem.h
+++ b/include/freetype/ftsystem.h
@@ -72,7 +72,7 @@ FT_BEGIN_HEADER
* FT_Alloc_Func
*
* @description:
- * A function used to allocate `size' bytes from `memory'.
+ * A function used to allocate 'size' bytes from 'memory'.
*
* @input:
* memory ::
@@ -207,7 +207,7 @@ FT_BEGIN_HEADER
*
* @description:
* A union type used to store either a long or a pointer. This is used
- * to store a file descriptor or a `FILE*' in an input stream.
+ * to store a file descriptor or a 'FILE*' in an input stream.
*
*/
typedef union FT_StreamDesc_
@@ -244,7 +244,7 @@ FT_BEGIN_HEADER
*
* @note:
* This function might be called to perform a seek or skip operation
- * with a `count' of~0. A non-zero return value then indicates an
+ * with a 'count' of~0. A non-zero return value then indicates an
* error.
*
*/
@@ -299,7 +299,7 @@ FT_BEGIN_HEADER
*
* descriptor ::
* This field is a union that can hold an integer or a pointer. It is
- * used by stream implementations to store file descriptors or `FILE*'
+ * used by stream implementations to store file descriptors or 'FILE*'
* pointers.
*
* pathname ::
@@ -320,8 +320,8 @@ FT_BEGIN_HEADER
*
* cursor ::
* This field is set and used internally by FreeType when parsing
- * frames. In particular, the `FT_GET_XXX' macros use this instead
- * of the `pos' field.
+ * frames. In particular, the `FT_GET_XXX` macros use this instead
+ * of the 'pos' field.
*
* limit ::
* This field is set and used internally by FreeType when parsing
diff --git a/include/freetype/fttrigon.h b/include/freetype/fttrigon.h
index 7a27bb2..da58496 100644
--- a/include/freetype/fttrigon.h
+++ b/include/freetype/fttrigon.h
@@ -210,7 +210,7 @@ FT_BEGIN_HEADER
* Second angle.
*
* @return:
- * Constrained value of `value2-value1'.
+ * Constrained value of 'value2-value1'.
*
*/
FT_EXPORT( FT_Angle )
@@ -225,8 +225,8 @@ FT_BEGIN_HEADER
*
* @description:
* Return the unit vector corresponding to a given angle. After the
- * call, the value of `vec.x' will be `cos(angle)', and the value of
- * `vec.y' will be `sin(angle)'.
+ * call, the value of `vec.x` will be 'cos(angle)', and the value of
+ * `vec.y` will be 'sin(angle)'.
*
* This function is useful to retrieve both the sinus and cosinus of a
* given angle quickly.
diff --git a/include/freetype/fttypes.h b/include/freetype/fttypes.h
index de69e3b..f79034c 100644
--- a/include/freetype/fttypes.h
+++ b/include/freetype/fttypes.h
@@ -317,7 +317,7 @@ FT_BEGIN_HEADER
* FT_Offset
*
* @description:
- * This is equivalent to the ANSI~C `size_t' type, i.e., the largest
+ * This is equivalent to the ANSI~C `size_t` type, i.e., the largest
* _unsigned_ integer type used to express a file size or position,
* or a memory block size.
*/
@@ -330,7 +330,7 @@ FT_BEGIN_HEADER
* FT_PtrDist
*
* @description:
- * This is equivalent to the ANSI~C `ptrdiff_t' type, i.e., the
+ * This is equivalent to the ANSI~C `ptrdiff_t` type, i.e., the
* largest _signed_ integer type used to express the distance
* between two pointers.
*/
@@ -370,10 +370,10 @@ FT_BEGIN_HEADER
* A simple structure used to store a 2x2 matrix. Coefficients are
* in 16.16 fixed-point format. The computation performed is:
*
- * {
+ * ```
* x' = x*xx + y*xy
* y' = x*yx + y*yy
- * }
+ * ```
*
* @fields:
* xx ::
@@ -425,13 +425,13 @@ FT_BEGIN_HEADER
* FT_Generic_Finalizer
*
* @description:
- * Describe a function used to destroy the `client' data of any
+ * Describe a function used to destroy the 'client' data of any
* FreeType object. See the description of the @FT_Generic type for
* details of usage.
*
* @input:
* The address of the FreeType object that is under finalization.
- * Its client data is accessed through its `generic' field.
+ * Its client data is accessed through its 'generic' field.
*/
typedef void (*FT_Generic_Finalizer)( void* object );
@@ -446,15 +446,15 @@ FT_BEGIN_HEADER
* variety of FreeType core objects. For example, a text layout API
* might want to associate a glyph cache to a given size object.
*
- * Some FreeType object contains a `generic' field, of type
+ * Some FreeType object contains a 'generic' field, of type
* FT_Generic, which usage is left to client applications and font
* servers.
*
* It can be used to store a pointer to client-specific data, as well
- * as the address of a `finalizer' function, which will be called by
+ * as the address of a 'finalizer' function, which will be called by
* FreeType when the object is destroyed (for example, the previous
* client example would put the address of the glyph cache destructor
- * in the `finalizer' field).
+ * in the 'finalizer' field).
*
* @fields:
* data ::
@@ -462,7 +462,7 @@ FT_BEGIN_HEADER
* field is completely ignored by the FreeType library.
*
* finalizer ::
- * A pointer to a `generic finalizer' function, which
+ * A pointer to a 'generic finalizer' function, which
* will be called when the object is destroyed. If this
* field is set to NULL, no code will be called.
*/
@@ -484,7 +484,7 @@ FT_BEGIN_HEADER
* TrueType tables into an unsigned long, to be used within FreeType.
*
* @note:
- * The produced values *must* be 32-bit integers. Don't redefine
+ * The produced values **must** be 32-bit integers. Don't redefine
* this macro.
*/
#define FT_MAKE_TAG( _x1, _x2, _x3, _x4 ) \
diff --git a/include/freetype/ftwinfnt.h b/include/freetype/ftwinfnt.h
index 5d0eb0f..d28ee20 100644
--- a/include/freetype/ftwinfnt.h
+++ b/include/freetype/ftwinfnt.h
@@ -56,7 +56,7 @@ FT_BEGIN_HEADER
* FT_WinFNT_ID_XXX
*
* @description:
- * A list of valid values for the `charset' byte in
+ * A list of valid values for the 'charset' byte in
* @FT_WinFNT_HeaderRec. Exact mapping tables for the various cpXXXX
* encodings (except for cp1361) can be found at
* ftp://ftp.unicode.org/Public in the MAPPINGS/VENDORS/MICSFT/WINDOWS
@@ -66,7 +66,7 @@ FT_BEGIN_HEADER
* @values:
* FT_WinFNT_ID_DEFAULT ::
* This is used for font enumeration and font creation as a
- * `don't care' value. Valid font files don't contain this value.
+ * 'don't care' value. Valid font files don't contain this value.
* When querying for information about the character set of the font
* that is currently selected into a specified device context, this
* return value (of the related Windows API) simply denotes failure.
@@ -80,14 +80,14 @@ FT_BEGIN_HEADER
* FT_WinFNT_ID_OEM ::
* From Michael Poettgen <address@hidden>:
*
- * The `Windows Font Mapping' article says that FT_WinFNT_ID_OEM
- * is used for the charset of vector fonts, like `modern.fon',
- * `roman.fon', and `script.fon' on Windows.
+ * The 'Windows Font Mapping' article says that FT_WinFNT_ID_OEM
+ * is used for the charset of vector fonts, like `modern.fon`,
+ * `roman.fon`, and `script.fon` on Windows.
*
- * The `CreateFont' documentation says: The FT_WinFNT_ID_OEM value
+ * The 'CreateFont' documentation says: The FT_WinFNT_ID_OEM value
* specifies a character set that is operating-system dependent.
*
- * The `IFIMETRICS' documentation from the `Windows Driver
+ * The 'IFIMETRICS' documentation from the 'Windows Driver
* Development Kit' says: This font supports an OEM-specific
* character set. The OEM character set is system dependent.
*
@@ -97,7 +97,7 @@ FT_BEGIN_HEADER
*
*
https://docs.microsoft.com/en-us/windows/desktop/intl/code-page-identifiers ,
*
- * and is used for the `DOS boxes', to support legacy applications.
+ * and is used for the 'DOS boxes', to support legacy applications.
* A German Windows version for example usually uses ANSI codepage
* 1252 and OEM codepage 850.
*
diff --git a/include/freetype/internal/cffotypes.h
b/include/freetype/internal/cffotypes.h
index c01dba4..235a125 100644
--- a/include/freetype/internal/cffotypes.h
+++ b/include/freetype/internal/cffotypes.h
@@ -76,7 +76,7 @@ FT_BEGIN_HEADER
* CFF_Internal
*
* @description:
- * The interface to the `internal' field of `FT_Size'.
+ * The interface to the 'internal' field of `FT_Size`.
*/
typedef struct CFF_InternalRec_
{
diff --git a/include/freetype/internal/ftcalc.h
b/include/freetype/internal/ftcalc.h
index 733b674..675e1cd 100644
--- a/include/freetype/internal/ftcalc.h
+++ b/include/freetype/internal/ftcalc.h
@@ -252,7 +252,7 @@ FT_BEGIN_HEADER
* FT_MulDiv_No_Round
*
* @description:
- * A very simple function used to perform the computation `(a*b)/c'
+ * A very simple function used to perform the computation '(a*b)/c'
* (without rounding) with maximum accuracy (it uses a 64-bit
* intermediate integer whenever necessary).
*
@@ -268,9 +268,9 @@ FT_BEGIN_HEADER
* The divisor.
*
* @return:
- * The result of `(a*b)/c'. This function never traps when trying to
- * divide by zero; it simply returns `MaxInt' or `MinInt' depending
- * on the signs of `a' and `b'.
+ * The result of '(a*b)/c'. This function never traps when trying to
+ * divide by zero; it simply returns 'MaxInt' or 'MinInt' depending
+ * on the signs of 'a' and 'b'.
*/
FT_BASE( FT_Long )
FT_MulDiv_No_Round( FT_Long a,
@@ -433,7 +433,7 @@ FT_BEGIN_HEADER
* The value to compute the root for.
*
* @return:
- * The result of `sqrt(x)'.
+ * The result of 'sqrt(x)'.
*
* @note:
* This function is not very fast.
diff --git a/include/freetype/internal/ftdebug.h
b/include/freetype/internal/ftdebug.h
index 1b4f699..33c87b7 100644
--- a/include/freetype/internal/ftdebug.h
+++ b/include/freetype/internal/ftdebug.h
@@ -111,7 +111,7 @@ FT_BEGIN_HEADER
*
* @note:
* This function may be useful if you want to access elements of
- * the internal `ft_trace_levels' array by an index.
+ * the internal `ft_trace_levels` array by an index.
*/
FT_BASE( FT_Int )
FT_Trace_Get_Count( void );
diff --git a/include/freetype/internal/ftdrv.h
b/include/freetype/internal/ftdrv.h
index 745b78a..d7544eb 100644
--- a/include/freetype/internal/ftdrv.h
+++ b/include/freetype/internal/ftdrv.h
@@ -147,10 +147,10 @@ FT_BEGIN_HEADER
*
* get_advances ::
* A function handle used to return advance
- * widths of `count' glyphs (in font units),
- * starting at `first'. The `vertical' flag must
+ * widths of 'count' glyphs (in font units),
+ * starting at 'first'. The 'vertical' flag must
* be set to get vertical advance heights. The
- * `advances' buffer is caller-allocated.
+ * 'advances' buffer is caller-allocated.
* The idea of this function is to be able to
* perform device-independent text layout without
* loading a single glyph image.
@@ -167,7 +167,7 @@ FT_BEGIN_HEADER
* to 0 if the scaling done in the base layer
* suffices.
* @note:
- * Most function pointers, with the exception of `load_glyph', can be
+ * Most function pointers, with the exception of `load_glyph`, can be
* set to 0 to indicate a default behaviour.
*/
typedef struct FT_Driver_ClassRec_
@@ -215,9 +215,9 @@ FT_BEGIN_HEADER
* @description:
* Used to initialize an instance of FT_Driver_ClassRec struct.
*
- * `ftinit.c' (ft_create_default_module_classes) already contains a
+ * `ftinit.c` (ft_create_default_module_classes) already contains a
* mechanism to call these functions for the default modules
- * described in `ftmodule.h'.
+ * described in `ftmodule.h`.
*
* The struct will be allocated in the global scope (or the scope
* where the macro is used).
diff --git a/include/freetype/internal/ftmemory.h
b/include/freetype/internal/ftmemory.h
index f15c77d..4fa57bb 100644
--- a/include/freetype/internal/ftmemory.h
+++ b/include/freetype/internal/ftmemory.h
@@ -34,7 +34,7 @@ FT_BEGIN_HEADER
* FT_SET_ERROR
*
* @description:
- * This macro is used to set an implicit `error' variable to a given
+ * This macro is used to set an implicit 'error' variable to a given
* expression's value (usually a function call), and convert it to a
* boolean which is set whenever the value is != 0.
*/
diff --git a/include/freetype/internal/ftobjs.h
b/include/freetype/internal/ftobjs.h
index 88ced18..d0babc7 100644
--- a/include/freetype/internal/ftobjs.h
+++ b/include/freetype/internal/ftobjs.h
@@ -330,7 +330,7 @@ FT_BEGIN_HEADER
*
* services ::
* A cache for frequently used services. It should be only
- * accessed with the macro `FT_FACE_LOOKUP_SERVICE'.
+ * accessed with the macro `FT_FACE_LOOKUP_SERVICE`.
*
* incremental_interface ::
* If non-null, the interface through which glyph data and metrics
@@ -344,7 +344,7 @@ FT_BEGIN_HEADER
* respectively, value~-1 means to use the module/driver default.
*
* random_seed ::
- * If positive, override the seed value for the CFF `random'
+ * If positive, override the seed value for the CFF 'random'
* operator. Value~0 means to use the font's value. Value~-1
* means to use the CFF driver's default.
*
@@ -798,7 +798,7 @@ FT_BEGIN_HEADER
*
* clazz ::
* A pointer to the font driver's class. Note that
- * this is NOT root.clazz. `class' wasn't used
+ * this is NOT root.clazz. 'class' wasn't used
* as it is a reserved word in C++.
*
* faces_list ::
diff --git a/include/freetype/internal/ftrfork.h
b/include/freetype/internal/ftrfork.h
index a056171..27561c3 100644
--- a/include/freetype/internal/ftrfork.h
+++ b/include/freetype/internal/ftrfork.h
@@ -118,18 +118,18 @@ FT_BEGIN_HEADER
* @output:
* new_names ::
* An array of guessed file names in which the resource forks may
- * exist. If `new_names[N]' is NULL, the guessed file name is
- * equal to `base_name'.
+ * exist. If 'new_names[N]' is NULL, the guessed file name is
+ * equal to `base_name`.
*
* offsets ::
- * An array of guessed file offsets. `offsets[N]' holds the file
+ * An array of guessed file offsets. 'offsets[N]' holds the file
* offset of the possible start of the resource fork in file
- * `new_names[N]'.
+ * 'new_names[N]'.
*
* errors ::
- * An array of FreeType error codes. `errors[N]' is the error
- * code of Nth guessing rule function. If `errors[N]' is not
- * FT_Err_Ok, `new_names[N]' and `offsets[N]' are meaningless.
+ * An array of FreeType error codes. 'errors[N]' is the error
+ * code of Nth guessing rule function. If 'errors[N]' is not
+ * FT_Err_Ok, 'new_names[N]' and 'offsets[N]' are meaningless.
*/
FT_BASE( void )
FT_Raccess_Guess( FT_Library library,
@@ -149,7 +149,7 @@ FT_BEGIN_HEADER
* Get the information from the header of resource fork. The
* information includes the file offset where the resource map
* starts, and the file offset where the resource data starts.
- * `FT_Raccess_Get_DataOffsets' requires these two data.
+ * `FT_Raccess_Get_DataOffsets` requires these two data.
*
* @input:
* library ::
@@ -207,14 +207,14 @@ FT_BEGIN_HEADER
*
* sort_by_res_id ::
* A Boolean to sort the fragmented resource by their ids.
- * The fragmented resources for `POST' resource should be sorted
- * to restore Type1 font properly. For `sfnt' resources, sorting
+ * The fragmented resources for 'POST' resource should be sorted
+ * to restore Type1 font properly. For 'sfnt' resources, sorting
* may induce a different order of the faces in comparison to that
* by QuickDraw API.
*
* @output:
* offsets ::
- * The stream offsets for the resource data specified by `tag'.
+ * The stream offsets for the resource data specified by 'tag'.
* This array is allocated by the function, so you have to call
* @ft_mem_free after use.
*
@@ -225,8 +225,8 @@ FT_BEGIN_HEADER
* FreeType error code. FT_Err_Ok means success.
*
* @note:
- * Normally you should use `FT_Raccess_Get_HeaderInfo' to get the
- * value for `map_offset' and `rdata_pos'.
+ * Normally you should use `FT_Raccess_Get_HeaderInfo` to get the
+ * value for `map_offset` and `rdata_pos`.
*/
FT_BASE( FT_Error )
FT_Raccess_Get_DataOffsets( FT_Library library,
diff --git a/include/freetype/internal/ftserv.h
b/include/freetype/internal/ftserv.h
index 3f493b5..16a67fa 100644
--- a/include/freetype/internal/ftserv.h
+++ b/include/freetype/internal/ftserv.h
@@ -49,8 +49,8 @@ FT_BEGIN_HEADER
* id ::
* A string describing the service as defined in the service's
* header files (e.g. FT_SERVICE_ID_MULTI_MASTERS which expands to
- * `multi-masters'). It is automatically prefixed with
- * `FT_SERVICE_ID_'.
+ * 'multi-masters'). It is automatically prefixed with
+ * `FT_SERVICE_ID_`.
*
* @output:
* ptr ::
@@ -101,8 +101,8 @@ FT_BEGIN_HEADER
* id ::
* A string describing the service as defined in the service's
* header files (e.g. FT_SERVICE_ID_MULTI_MASTERS which expands to
- * `multi-masters'). It is automatically prefixed with
- * `FT_SERVICE_ID_'.
+ * 'multi-masters'). It is automatically prefixed with
+ * `FT_SERVICE_ID_`.
*
* @output:
* ptr ::
diff --git a/include/freetype/internal/psaux.h
b/include/freetype/internal/psaux.h
index 2c5a6d2..f2d9572 100644
--- a/include/freetype/internal/psaux.h
+++ b/include/freetype/internal/psaux.h
@@ -130,7 +130,7 @@ FT_BEGIN_HEADER
* 1kByte chunks.
*
* init ::
- * Set to 0xDEADBEEF if `elements' and `lengths' have
+ * Set to 0xDEADBEEF if 'elements' and 'lengths' have
* been allocated.
*
* max_elems ::
diff --git a/include/freetype/internal/pshints.h
b/include/freetype/internal/pshints.h
index 90a28ac..b281d09 100644
--- a/include/freetype/internal/pshints.h
+++ b/include/freetype/internal/pshints.h
@@ -86,14 +86,14 @@ FT_BEGIN_HEADER
* @T1_Hints_FuncsRec structure. Recording glyph hints is normally
* achieved through the following scheme:
*
- * - Open a new hint recording session by calling the `open' method.
+ * - Open a new hint recording session by calling the 'open' method.
* This rewinds the recorder and prepare it for new input.
*
* - For each hint found in the glyph charstring, call the corresponding
- * method (`stem', `stem3', or `reset'). Note that these functions do
+ * method ('stem', 'stem3', or 'reset'). Note that these functions do
* not return an error code.
*
- * - Close the recording session by calling the `close' method. It
+ * - Close the recording session by calling the 'close' method. It
* returns an error code if the hints were invalid or something
* strange happened (e.g., memory shortage).
*
@@ -146,7 +146,7 @@ FT_BEGIN_HEADER
*
* @description:
* A method of the @T1_Hints class used to record a new horizontal or
- * vertical stem. This corresponds to the Type 1 `hstem' and `vstem'
+ * vertical stem. This corresponds to the Type 1 'hstem' and 'vstem'
* operators.
*
* @input:
@@ -164,15 +164,15 @@ FT_BEGIN_HEADER
* Use vertical coordinates (y) for horizontal stems (dim=0). Use
* horizontal coordinates (x) for vertical stems (dim=1).
*
- * `coords[0]' is the absolute stem position (lowest coordinate);
- * `coords[1]' is the length.
+ * 'coords[0]' is the absolute stem position (lowest coordinate);
+ * 'coords[1]' is the length.
*
* The length can be negative, in which case it must be either -20 or
- * -21. It is interpreted as a `ghost' stem, according to the Type 1
+ * -21. It is interpreted as a 'ghost' stem, according to the Type 1
* specification.
*
* If the length is -21 (corresponding to a bottom ghost stem), then
- * the real stem position is `coords[0]+coords[1]'.
+ * the real stem position is 'coords[0]+coords[1]'.
*
*/
typedef void
@@ -297,7 +297,7 @@ FT_BEGIN_HEADER
* On input, all points within the outline are in font coordinates. On
* output, they are in 1/64th of pixels.
*
- * The scaling transformation is taken from the `globals' object which
+ * The scaling transformation is taken from the 'globals' object which
* must correspond to the same font as the glyph.
*
*/
@@ -373,14 +373,14 @@ FT_BEGIN_HEADER
* @T2_Hints_FuncsRec structure. Recording glyph hints is normally
* achieved through the following scheme:
*
- * - Open a new hint recording session by calling the `open' method.
+ * - Open a new hint recording session by calling the 'open' method.
* This rewinds the recorder and prepare it for new input.
*
* - For each hint found in the glyph charstring, call the corresponding
- * method (`stems', `hintmask', `counters'). Note that these
+ * method ('stems', 'hintmask', 'counters'). Note that these
* functions do not return an error code.
*
- * - Close the recording session by calling the `close' method. It
+ * - Close the recording session by calling the 'close' method. It
* returns an error code if the hints were invalid or something
* strange happened (e.g., memory shortage).
*
@@ -434,7 +434,7 @@ FT_BEGIN_HEADER
* @description:
* A method of the @T2_Hints class used to set the table of stems in
* either the vertical or horizontal dimension. Equivalent to the
- * `hstem', `vstem', `hstemhm', and `vstemhm' Type 2 operators.
+ * 'hstem', 'vstem', 'hstemhm', and 'vstemhm' Type 2 operators.
*
* @input:
* hints ::
@@ -447,18 +447,18 @@ FT_BEGIN_HEADER
* The number of stems.
*
* coords ::
- * An array of `count' (position,length) pairs in 16.16 format.
+ * An array of 'count' (position,length) pairs in 16.16 format.
*
* @note:
* Use vertical coordinates (y) for horizontal stems (dim=0). Use
* horizontal coordinates (x) for vertical stems (dim=1).
*
- * There are `2*count' elements in the `coords' array. Each even
+ * There are '2*count' elements in the 'coords' array. Each even
* element is an absolute position in font units, each odd element is a
* length in font units.
*
* A length can be negative, in which case it must be either -20 or
- * -21. It is interpreted as a `ghost' stem, according to the Type 1
+ * -21. It is interpreted as a 'ghost' stem, according to the Type 1
* specification.
*
*/
@@ -476,7 +476,7 @@ FT_BEGIN_HEADER
*
* @description:
* A method of the @T2_Hints class used to set a given hintmask (this
- * corresponds to the `hintmask' Type 2 operator).
+ * corresponds to the 'hintmask' Type 2 operator).
*
* @input:
* hints ::
@@ -494,13 +494,13 @@ FT_BEGIN_HEADER
*
* @note:
* If the hintmask starts the charstring (before any glyph point
- * definition), the value of `end_point' should be 0.
+ * definition), the value of `end_point` should be 0.
*
- * `bit_count' is the number of meaningful bits in the `bytes' array; it
+ * `bit_count` is the number of meaningful bits in the 'bytes' array; it
* must be equal to the total number of hints defined so far (i.e.,
* horizontal+verticals).
*
- * The `bytes' array can come directly from the Type 2 charstring and
+ * The 'bytes' array can come directly from the Type 2 charstring and
* respects the same format.
*
*/
@@ -518,7 +518,7 @@ FT_BEGIN_HEADER
*
* @description:
* A method of the @T2_Hints class used to set a given counter mask
- * (this corresponds to the `hintmask' Type 2 operator).
+ * (this corresponds to the 'hintmask' Type 2 operator).
*
* @input:
* hints ::
@@ -536,13 +536,13 @@ FT_BEGIN_HEADER
*
* @note:
* If the hintmask starts the charstring (before any glyph point
- * definition), the value of `end_point' should be 0.
+ * definition), the value of `end_point` should be 0.
*
- * `bit_count' is the number of meaningful bits in the `bytes' array; it
+ * `bit_count` is the number of meaningful bits in the 'bytes' array; it
* must be equal to the total number of hints defined so far (i.e.,
* horizontal+verticals).
*
- * The `bytes' array can come directly from the Type 2 charstring and
+ * The 'bytes' array can come directly from the Type 2 charstring and
* respects the same format.
*
*/
@@ -588,7 +588,7 @@ FT_BEGIN_HEADER
*
* @description:
* A method of the @T2_Hints class used to apply hints to the
- * corresponding glyph outline. Must be called after the `close'
+ * corresponding glyph outline. Must be called after the 'close'
* method.
*
* @input:
@@ -611,7 +611,7 @@ FT_BEGIN_HEADER
* On input, all points within the outline are in font coordinates. On
* output, they are in 1/64th of pixels.
*
- * The scaling transformation is taken from the `globals' object which
+ * The scaling transformation is taken from the 'globals' object which
* must correspond to the same font than the glyph.
*
*/
diff --git a/include/freetype/internal/services/svttcmap.h
b/include/freetype/internal/services/svttcmap.h
index cc4328f..7ef65d4 100644
--- a/include/freetype/internal/services/svttcmap.h
+++ b/include/freetype/internal/services/svttcmap.h
@@ -45,7 +45,7 @@ FT_BEGIN_HEADER
* @fields:
* language ::
* The language ID used in Mac fonts. Definitions of values are in
- * `ttnameid.h'.
+ * `ttnameid.h`.
*
* format ::
* The cmap format. OpenType 1.6 defines the formats 0 (byte
diff --git a/include/freetype/internal/sfnt.h b/include/freetype/internal/sfnt.h
index 178d892..f4d5626 100644
--- a/include/freetype/internal/sfnt.h
+++ b/include/freetype/internal/sfnt.h
@@ -63,7 +63,7 @@ FT_BEGIN_HEADER
* @note:
* The stream cursor must be at the font file's origin.
*
- * This function recognizes fonts embedded in a `TrueType
+ * This function recognizes fonts embedded in a 'TrueType
* collection'.
*
* Once the format tag has been validated by the font driver, it
@@ -167,16 +167,16 @@ FT_BEGIN_HEADER
*
* If length == NULL:
* Loads the whole table. Returns an error if
- * `offset' == 0!
+ * 'offset' == 0!
*
* If *length == 0:
* Exits immediately; returning the length of the given
* table or of the font file, depending on the value of
- * `tag'.
+ * 'tag'.
*
* If *length != 0:
- * Loads the next `length' bytes of table or font,
- * starting at offset `offset' (in table or font too).
+ * Loads the next 'length' bytes of table or font,
+ * starting at offset 'offset' (in table or font too).
*
* @output:
* buffer ::
@@ -199,7 +199,7 @@ FT_BEGIN_HEADER
* TT_Find_SBit_Image_Func
*
* @description:
- * Check whether an embedded bitmap (an `sbit') exists for a given
+ * Check whether an embedded bitmap (an 'sbit') exists for a given
* glyph, at a given strike.
*
* @input:
@@ -220,7 +220,7 @@ FT_BEGIN_HEADER
* The SBit strike containing the glyph index.
*
* aglyph_offset ::
- * The offset of the glyph data in `EBDT' table.
+ * The offset of the glyph data in 'EBDT' table.
*
* @return:
* FreeType error code. 0 means success. Returns
@@ -260,10 +260,10 @@ FT_BEGIN_HEADER
*
* @note:
* The stream cursor must be positioned at the glyph's offset within
- * the `EBDT' table before the call.
+ * the 'EBDT' table before the call.
*
* If the image format uses variable metrics, the stream cursor is
- * positioned just after the metrics header in the `EBDT' table on
+ * positioned just after the metrics header in the 'EBDT' table on
* function exit.
*/
typedef FT_Error
@@ -309,7 +309,7 @@ FT_BEGIN_HEADER
* glyph sbit exists for the index.
*
* @note:
- * The `map.buffer' field is always freed before the glyph is loaded.
+ * The `map.buffer` field is always freed before the glyph is loaded.
*/
typedef FT_Error
(*TT_Load_SBit_Image_Func)( TT_Face face,
@@ -475,7 +475,7 @@ FT_BEGIN_HEADER
* TT_Set_Palette_Func
*
* @description:
- * Load the colors into `face->palette' for a given palette index.
+ * Load the colors into `face->palette` for a given palette index.
*
* @input:
* face ::
@@ -510,7 +510,7 @@ FT_BEGIN_HEADER
* @inout:
* iterator ::
* An @FT_LayerIterator object. For the first call you should set
- * `iterator->p' to NULL. For all following calls, simply use the
+ * `iterator->p` to NULL. For all following calls, simply use the
* same object again.
*
* @output:
@@ -542,10 +542,10 @@ FT_BEGIN_HEADER
* TT_Blend_Colr_Func
*
* @description:
- * Blend the bitmap in `new_glyph' into `base_glyph' using the color
- * specified by `color_index'. If `color_index' is 0xFFFF, use
- * `face->foreground_color' if `face->have_foreground_color' is set.
- * Otherwise check `face->palette_data.palette_flags': If present and
+ * Blend the bitmap in `new_glyph` into `base_glyph` using the color
+ * specified by `color_index`. If `color_index` is 0xFFFF, use
+ * `face->foreground_color` if `face->have_foreground_color` is set.
+ * Otherwise check `face->palette_data.palette_flags`: If present and
* @FT_PALETTE_FOR_DARK_BACKGROUND is set, use BGRA value 0xFFFFFFFF
* (white opaque). Otherwise use BGRA value 0x000000FF (black opaque).
*
@@ -561,7 +561,7 @@ FT_BEGIN_HEADER
* bitmap may get reallocated.
*
* new_glyph ::
- * Slot to be incooperated into `base_glyph'.
+ * Slot to be incooperated into `base_glyph`.
*
* @return:
* FreeType error code. 0 means success. Returns an error if
@@ -580,7 +580,7 @@ FT_BEGIN_HEADER
* TT_Get_Name_Func
*
* @description:
- * From the `name' table, return a given ENGLISH name record in
+ * From the 'name' table, return a given ENGLISH name record in
* ASCII.
*
* @input:
@@ -611,7 +611,7 @@ FT_BEGIN_HEADER
*
* @description:
* Search whether an ENGLISH version for a given name ID is in the
- * `name' table.
+ * 'name' table.
*
* @input:
* face ::
@@ -622,11 +622,11 @@ FT_BEGIN_HEADER
*
* @output:
* win ::
- * If non-negative, an index into the `name' table with
+ * If non-negative, an index into the 'name' table with
* the corresponding (3,1) or (3,0) Windows entry.
*
* apple ::
- * If non-negative, an index into the `name' table with
+ * If non-negative, an index into the 'name' table with
* the corresponding (1,0) Apple entry.
*
* @return:
@@ -658,7 +658,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0 means success.
*
* @note:
- * The function uses `face->goto_table' to seek the stream to the
+ * The function uses `face->goto_table` to seek the stream to the
* start of the table, except while loading the font directory.
*/
typedef FT_Error
@@ -710,7 +710,7 @@ FT_BEGIN_HEADER
*
* @description:
* This structure holds pointers to the functions used to load and
- * free the basic tables that are required in a `sfnt' font file.
+ * free the basic tables that are required in a 'sfnt' font file.
*
* @fields:
* Check the various xxx_Func() descriptions for details.
diff --git a/include/freetype/internal/tttypes.h
b/include/freetype/internal/tttypes.h
index 4df6b29..7e1f26e 100644
--- a/include/freetype/internal/tttypes.h
+++ b/include/freetype/internal/tttypes.h
@@ -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.
@@ -98,13 +98,13 @@ FT_BEGIN_HEADER
* The number of tables in file.
*
* search_range ::
- * Must be `16 * (max power of 2 <= num_tables)'.
+ * Must be '16 * (max power of 2 <= num_tables)'.
*
* entry_selector ::
- * Must be log2 of `search_range / 16'.
+ * Must be log2 of 'search_range / 16'.
*
* range_shift ::
- * Must be `num_tables * 16 - search_range'.
+ * Must be 'num_tables * 16 - search_range'.
*/
typedef struct SFNT_HeaderRec_
{
@@ -232,7 +232,7 @@ FT_BEGIN_HEADER
* TT_LongMetricsRec
*
* @description:
- * A structure modeling the long metrics of the `hmtx' and `vmtx'
+ * A structure modeling the long metrics of the 'hmtx' and 'vmtx'
* TrueType tables. The values are expressed in font units.
*
* @fields:
@@ -256,7 +256,7 @@ FT_BEGIN_HEADER
* TT_ShortMetrics
*
* @description:
- * A simple type to model the short metrics of the `hmtx' and `vmtx'
+ * A simple type to model the short metrics of the 'hmtx' and 'vmtx'
* tables.
*/
typedef FT_Short TT_ShortMetrics;
@@ -290,7 +290,7 @@ FT_BEGIN_HEADER
* The length of the string in bytes.
*
* stringOffset ::
- * The offset to the string in the `name' table.
+ * The offset to the string in the 'name' table.
*
* string ::
* A pointer to the string's bytes. Note that these
@@ -319,7 +319,7 @@ FT_BEGIN_HEADER
* TT_LangTagRec
*
* @description:
- * A structure modeling language tag records in SFNT `name' tables,
+ * A structure modeling language tag records in SFNT 'name' tables,
* introduced in OpenType version 1.6.
*
* @fields:
@@ -327,7 +327,7 @@ FT_BEGIN_HEADER
* The length of the string in bytes.
*
* stringOffset ::
- * The offset to the string in the `name' table.
+ * The offset to the string in the 'name' table.
*
* string ::
* A pointer to the string's bytes. Note that these
@@ -362,7 +362,7 @@ FT_BEGIN_HEADER
* The number of names in table.
*
* storageOffset ::
- * The offset of the name table in the `name'
+ * The offset of the name table in the 'name'
* TrueType table.
*
* names ::
@@ -414,7 +414,7 @@ FT_BEGIN_HEADER
*
* @fields:
* maxPPEM ::
- * The maximum ppem value to which `gaspFlag' applies.
+ * The maximum ppem value to which `gaspFlag` applies.
*
* gaspFlag ::
* A flag describing the grid-fitting and anti-aliasing
@@ -438,7 +438,7 @@ FT_BEGIN_HEADER
* TT_GaspRec
*
* @description:
- * A structure modeling the TrueType `gasp' table used to specify
+ * A structure modeling the TrueType 'gasp' table used to specify
* grid-fitting and anti-aliasing behaviour.
*
* @fields:
@@ -481,7 +481,7 @@ FT_BEGIN_HEADER
* @description:
* A structure used to hold the big metrics of a given glyph bitmap
* in a TrueType or OpenType font. These are usually found in the
- * `EBDT' (Microsoft) or `bloc' (Apple) table.
+ * 'EBDT' (Microsoft) or 'bloc' (Apple) table.
*
* @fields:
* height ::
@@ -532,7 +532,7 @@ FT_BEGIN_HEADER
* @description:
* A structure used to hold the small metrics of a given glyph bitmap
* in a TrueType or OpenType font. These are usually found in the
- * `EBDT' (Microsoft) or the `bdat' (Apple) table.
+ * 'EBDT' (Microsoft) or the 'bdat' (Apple) table.
*
* @fields:
* height ::
@@ -647,8 +647,8 @@ FT_BEGIN_HEADER
* TT_SBit_RangeRec
*
* @description:
- * A TrueType/OpenType subIndexTable as defined in the `EBLC'
- * (Microsoft) or `bloc' (Apple) tables.
+ * A TrueType/OpenType subIndexTable as defined in the 'EBLC'
+ * (Microsoft) or 'bloc' (Apple) tables.
*
* @fields:
* first_glyph ::
@@ -662,10 +662,10 @@ FT_BEGIN_HEADER
* to 5.
*
* image_format ::
- * The format of `EBDT' image data.
+ * The format of 'EBDT' image data.
*
* image_offset ::
- * The offset to image data in `EBDT'.
+ * The offset to image data in 'EBDT'.
*
* image_size ::
* For index formats 2 and 5. This is the size in
@@ -686,7 +686,7 @@ FT_BEGIN_HEADER
* For index formats 4 and 5.
*
* table_offset ::
- * The offset of the index table in the `EBLC'
+ * The offset of the index table in the 'EBLC'
* table. Only used during strike loading.
*/
typedef struct TT_SBit_RangeRec_
@@ -716,8 +716,8 @@ FT_BEGIN_HEADER
* TT_SBit_StrikeRec
*
* @description:
- * A structure used describe a given bitmap strike in the `EBLC'
- * (Microsoft) or `bloc' (Apple) tables.
+ * A structure used describe a given bitmap strike in the 'EBLC'
+ * (Microsoft) or 'bloc' (Apple) tables.
*
* @fields:
* num_index_ranges ::
@@ -727,7 +727,7 @@ FT_BEGIN_HEADER
* An array of glyph index ranges.
*
* color_ref ::
- * Unused. `color_ref' is put in for future
+ * Unused. `color_ref` is put in for future
* enhancements, but these fields are already
* in use by other platforms (e.g. Newton).
* For details, please see
@@ -819,7 +819,7 @@ FT_BEGIN_HEADER
*
* @description:
* A structure used describe a given bitmap scaling table, as defined
- * in the `EBSC' table.
+ * in the 'EBSC' table.
*
* @fields:
* hori ::
@@ -1075,7 +1075,7 @@ FT_BEGIN_HEADER
* resource.
*
* @note:
- * The TT_Face structure is also used as a `parent class' for the
+ * The TT_Face structure is also used as a 'parent class' for the
* OpenType-CFF class (T2_Face).
*/
typedef struct TT_FaceRec_* TT_Face;
@@ -1142,7 +1142,7 @@ FT_BEGIN_HEADER
*
* offset ::
* The offset of the glyph according to the
- * `locations' table.
+ * 'locations' table.
*
* byte_count ::
* The size of the frame in bytes.
@@ -1259,9 +1259,9 @@ FT_BEGIN_HEADER
*
* ttc_header ::
* The TrueType collection header, used when
- * the file is a `ttc' rather than a `ttf'.
+ * the file is a 'ttc' rather than a 'ttf'.
* For ordinary font files, the field
- * `ttc_header.count' is set to 0.
+ * `ttc_header.count` is set to 0.
*
* format_tag ::
* The font format tag.
@@ -1275,14 +1275,14 @@ FT_BEGIN_HEADER
* font file.
*
* header ::
- * The font's font header (`head' table).
+ * The font's font header ('head' table).
* Read on font opening.
*
* horizontal ::
- * The font's horizontal header (`hhea'
+ * The font's horizontal header ('hhea'
* table). This field also contains the
* associated horizontal metrics table
- * (`hmtx').
+ * ('hmtx').
*
* max_profile ::
* The font's maximum profile table. Read on
@@ -1294,15 +1294,15 @@ FT_BEGIN_HEADER
* vertical_info ::
* A boolean which is set when the font file
* contains vertical metrics. If not, the
- * value of the `vertical' field is
+ * value of the 'vertical' field is
* undefined.
*
* vertical ::
- * The font's vertical header (`vhea' table).
+ * The font's vertical header ('vhea' table).
* This field also contains the associated
- * vertical metrics table (`vmtx'), if found.
+ * vertical metrics table ('vmtx'), if found.
* IMPORTANT: The contents of this field is
- * undefined if the `vertical_info' field is
+ * undefined if the `vertical_info` field is
* unset.
*
* num_names ::
@@ -1310,23 +1310,23 @@ FT_BEGIN_HEADER
* TrueType font.
*
* name_table ::
- * The table of name records (`name').
+ * The table of name records ('name').
*
* os2 ::
- * The font's OS/2 table (`OS/2').
+ * The font's OS/2 table ('OS/2').
*
* postscript ::
- * The font's PostScript table (`post'
+ * The font's PostScript table ('post'
* table). The PostScript glyph names are
* not loaded by the driver on face opening.
- * See the `ttpost' module for more details.
+ * See the 'ttpost' module for more details.
*
* cmap_table ::
- * Address of the face's `cmap' SFNT table
+ * Address of the face's 'cmap' SFNT table
* in memory (it's an extracted frame).
*
* cmap_size ::
- * The size in bytes of the `cmap_table'
+ * The size in bytes of the `cmap_table`
* described above.
*
* goto_table ::
@@ -1347,18 +1347,18 @@ FT_BEGIN_HEADER
*
* read_glyph_header ::
* A function used to read a glyph header.
- * It must be called between an `access' and
- * `forget'.
+ * It must be called between an 'access' and
+ * 'forget'.
*
* read_simple_glyph ::
* A function used to read a simple glyph.
* It must be called after the header was
- * read, and before the `forget'.
+ * read, and before the 'forget'.
*
* read_composite_glyph ::
* A function used to read a composite glyph.
* It must be called after the header was
- * read, and before the `forget'.
+ * read, and before the 'forget'.
*
* sfnt ::
* A pointer to the SFNT service.
@@ -1375,16 +1375,16 @@ FT_BEGIN_HEADER
*
* hdmx ::
* The face's horizontal device metrics
- * (`hdmx' table). This table is optional in
+ * ('hdmx' table). This table is optional in
* TrueType/OpenType fonts.
*
* gasp ::
* The grid-fitting and scaling properties
- * table (`gasp'). This table is optional in
+ * table ('gasp'). This table is optional in
* TrueType/OpenType fonts.
*
* pclt ::
- * The `pclt' SFNT table.
+ * The 'pclt' SFNT table.
*
* num_sbit_scales ::
* The number of sbit scales for this font.
@@ -1397,11 +1397,11 @@ FT_BEGIN_HEADER
* postscript_names ::
* A table used to store the Postscript names
* of the glyphs for this font. See the
- * file `ttconfig.h' for comments on the
+ * file `ttconfig.h` for comments on the
* TT_CONFIG_OPTION_POSTSCRIPT_NAMES option.
*
* palette_data ::
- * Some fields from the `CPAL' table that are directly indexed.
+ * Some fields from the 'CPAL' table that are directly indexed.
*
* palette_index ::
* The current palette index, as set by @FT_Palette_Select.
@@ -1413,8 +1413,8 @@ FT_BEGIN_HEADER
* There was a call to @FT_Palette_Set_Foreground_Color.
*
* foreground_color ::
- * The current foreground color corresponding to `CPAL' color index
- * 0xFFFF. Only valid if `have_foreground_color' is set.
+ * The current foreground color corresponding to 'CPAL' color index
+ * 0xFFFF. Only valid if `have_foreground_color` is set.
*
* font_program_size ::
* Size in bytecodes of the face's font
@@ -1424,7 +1424,7 @@ FT_BEGIN_HEADER
* font_program ::
* The face's font program (bytecode stream)
* executed at load time, also used during
- * glyph rendering. Comes from the `fpgm'
+ * glyph rendering. Comes from the 'fpgm'
* table. Ignored for Type 2 font fonts.
*
* cvt_program_size ::
@@ -1434,7 +1434,7 @@ FT_BEGIN_HEADER
* cvt_program ::
* The face's cvt program (bytecode stream)
* executed each time an instance/size is
- * changed/reset. Comes from the `prep'
+ * changed/reset. Comes from the 'prep'
* table. Ignored for Type 2 fonts.
*
* cvt_size ::
@@ -1444,13 +1444,13 @@ FT_BEGIN_HEADER
* cvt ::
* The face's original control value table.
* Coordinates are expressed in unscaled font
- * units. Comes from the `cvt ' table.
+ * units. Comes from the 'cvt ' table.
* Ignored for Type 2 fonts.
*
* interpreter ::
* A pointer to the TrueType bytecode
* interpreters field is also used to hook
- * the debugger in `ttdebug'.
+ * the debugger in 'ttdebug'.
*
* extra ::
* Reserved for third-party font drivers.
@@ -1460,11 +1460,11 @@ FT_BEGIN_HEADER
* postscript name service.
*
* glyf_len ::
- * The length of the `glyf' table. Needed
- * for malformed `loca' tables.
+ * The length of the 'glyf' table. Needed
+ * for malformed 'loca' tables.
*
* glyf_offset ::
- * The file offset of the `glyf' table.
+ * The file offset of the 'glyf' table.
*
* is_cff2 ::
* Set if the font format is CFF2.
@@ -1491,14 +1491,14 @@ FT_BEGIN_HEADER
* PS name .
*
* var_postscript_prefix_len ::
- * The length of the `var_postscript_prefix'
+ * The length of the `var_postscript_prefix`
* string.
*
* horz_metrics_size ::
- * The size of the `hmtx' table.
+ * The size of the 'hmtx' table.
*
* vert_metrics_size ::
- * The size of the `vmtx' table.
+ * The size of the 'vmtx' table.
*
* num_locations ::
* The number of glyph locations in this
@@ -1508,14 +1508,14 @@ FT_BEGIN_HEADER
*
* glyph_locations ::
* An array of longs. These are offsets to
- * glyph data within the `glyf' table.
+ * glyph data within the 'glyf' table.
* Ignored for Type 2 font faces.
*
* hdmx_table ::
- * A pointer to the `hdmx' table.
+ * A pointer to the 'hdmx' table.
*
* hdmx_table_size ::
- * The size of the `hdmx' table.
+ * The size of the 'hdmx' table.
*
* hdmx_record_count ::
* The number of hdmx records.
@@ -1525,14 +1525,14 @@ FT_BEGIN_HEADER
*
* hdmx_record_sizes ::
* An array holding the ppem sizes available
- * in the `hdmx' table.
+ * in the 'hdmx' table.
*
* sbit_table ::
* A pointer to the font's embedded bitmap
* location table.
*
* sbit_table_size ::
- * The size of `sbit_table'.
+ * The size of `sbit_table`.
*
* sbit_table_type ::
* The sbit table type (CBLC, sbix, etc.).
@@ -1547,18 +1547,18 @@ FT_BEGIN_HEADER
* the font's sbit table.
*
* cpal ::
- * A pointer to data related to the `CPAL' table. NULL if the table
+ * A pointer to data related to the 'CPAL' table. NULL if the table
* is not available.
*
* colr ::
- * A pointer to data related to the `COLR' table. NULL if the table
+ * A pointer to data related to the 'COLR' table. NULL if the table
* is not available.
*
* kern_table ::
- * A pointer to the `kern' table.
+ * A pointer to the 'kern' table.
*
* kern_table_size ::
- * The size of the `kern' table.
+ * The size of the 'kern' table.
*
* num_kern_tables ::
* The number of supported kern subtables
@@ -1574,14 +1574,14 @@ FT_BEGIN_HEADER
* if bit n is set, table n is sorted.
*
* bdf ::
- * Data related to an SFNT font's `bdf'
- * table; see `tttypes.h'.
+ * Data related to an SFNT font's 'bdf'
+ * table; see `tttypes.h`.
*
* horz_metrics_offset ::
- * The file offset of the `hmtx' table.
+ * The file offset of the 'hmtx' table.
*
* vert_metrics_offset ::
- * The file offset of the `vmtx' table.
+ * The file offset of the 'vmtx' table.
*
* sph_found_func_flags ::
* Flags identifying special bytecode
diff --git a/include/freetype/t1tables.h b/include/freetype/t1tables.h
index cf4ea12..e33b00a 100644
--- a/include/freetype/t1tables.h
+++ b/include/freetype/t1tables.h
@@ -497,7 +497,7 @@ FT_BEGIN_HEADER
* in the font's FontInfo dictionary are represented by NULL pointers.
*
* If the font's format is not PostScript-based, this function will
- * return the `FT_Err_Invalid_Argument' error code.
+ * return the `FT_Err_Invalid_Argument` error code.
*
*/
FT_EXPORT( FT_Error )
@@ -530,7 +530,7 @@ FT_BEGIN_HEADER
* the face and don't need to be freed by the caller.
*
* If the font's format is not PostScript-based, this function returns
- * the `FT_Err_Invalid_Argument' error code.
+ * the `FT_Err_Invalid_Argument` error code.
*
*/
FT_EXPORT( FT_Error )
@@ -544,7 +544,7 @@ FT_BEGIN_HEADER
* T1_EncodingType
*
* @description:
- * An enumeration describing the `Encoding' entry in a Type 1
+ * An enumeration describing the 'Encoding' entry in a Type 1
* dictionary.
*
* @values:
@@ -721,18 +721,18 @@ FT_BEGIN_HEADER
*
* @note:
* The values returned are not pointers into the internal structures of
- * the face, but are `fresh' copies, so that the memory containing them
+ * the face, but are 'fresh' copies, so that the memory containing them
* belongs to the calling application. This also enforces the
- * `read-only' nature of these values, i.e., this function cannot be
+ * 'read-only' nature of these values, i.e., this function cannot be
* used to manipulate the face.
*
- * `value' is a void pointer because the values returned can be of
+ * 'value' is a void pointer because the values returned can be of
* various types.
*
- * If either `value' is NULL or `value_len' is too small, just the
+ * If either 'value' is NULL or `value_len` is too small, just the
* required memory size for the requested entry is returned.
*
- * The `idx' parameter is used, not only to retrieve elements of, for
+ * The 'idx' parameter is used, not only to retrieve elements of, for
* example, the FontMatrix or FontBBox, but also to retrieve name keys
* from the CharStrings dictionary, and the charstrings themselves. It
* is ignored for atomic values.
@@ -747,7 +747,7 @@ FT_BEGIN_HEADER
* available either.
*
* If the font's format is not PostScript-based, this function returns
- * the `FT_Err_Invalid_Argument' error code.
+ * the `FT_Err_Invalid_Argument` error code.
*
* @since:
* 2.4.8
diff --git a/include/freetype/ttnameid.h b/include/freetype/ttnameid.h
index f71516c..ec7494d 100644
--- a/include/freetype/ttnameid.h
+++ b/include/freetype/ttnameid.h
@@ -47,30 +47,30 @@ FT_BEGIN_HEADER
* TT_PLATFORM_XXX
*
* @description:
- * A list of valid values for the `platform_id' identifier code in
+ * A list of valid values for the `platform_id` identifier code in
* @FT_CharMapRec and @FT_SfntName structures.
*
* @values:
* TT_PLATFORM_APPLE_UNICODE ::
* Used by Apple to indicate a Unicode character map and/or name entry.
- * See @TT_APPLE_ID_XXX for corresponding `encoding_id' values. Note
+ * See @TT_APPLE_ID_XXX for corresponding `encoding_id` values. Note
* that name entries in this format are coded as big-endian UCS-2
* character codes _only_.
*
* TT_PLATFORM_MACINTOSH ::
* Used by Apple to indicate a MacOS-specific charmap and/or name entry.
- * See @TT_MAC_ID_XXX for corresponding `encoding_id' values. Note that
+ * See @TT_MAC_ID_XXX for corresponding `encoding_id` values. Note that
* most TrueType fonts contain an Apple roman charmap to be usable on
* MacOS systems (even if they contain a Microsoft charmap as well).
*
* TT_PLATFORM_ISO ::
* This value was used to specify ISO/IEC 10646 charmaps. It is however
* now deprecated. See @TT_ISO_ID_XXX for a list of corresponding
- * `encoding_id' values.
+ * `encoding_id` values.
*
* TT_PLATFORM_MICROSOFT ::
* Used by Microsoft to indicate Windows-specific charmaps. See
- * @TT_MS_ID_XXX for a list of corresponding `encoding_id' values.
+ * @TT_MS_ID_XXX for a list of corresponding `encoding_id` values.
* Note that most fonts contain a Unicode charmap using
* (TT_PLATFORM_MICROSOFT, @TT_MS_ID_UNICODE_CS).
*
@@ -97,7 +97,7 @@ FT_BEGIN_HEADER
* TT_APPLE_ID_XXX
*
* @description:
- * A list of valid values for the `encoding_id' for
+ * A list of valid values for the `encoding_id` for
* @TT_PLATFORM_APPLE_UNICODE charmaps and name entries.
*
* @values:
@@ -140,7 +140,7 @@ FT_BEGIN_HEADER
* TT_MAC_ID_XXX
*
* @description:
- * A list of valid values for the `encoding_id' for
+ * A list of valid values for the `encoding_id` for
* @TT_PLATFORM_MACINTOSH charmaps and name entries.
*/
@@ -186,7 +186,7 @@ FT_BEGIN_HEADER
* TT_ISO_ID_XXX
*
* @description:
- * A list of valid values for the `encoding_id' for
+ * A list of valid values for the `encoding_id` for
* @TT_PLATFORM_ISO charmaps and name entries.
*
* Their use is now deprecated.
@@ -211,7 +211,7 @@ FT_BEGIN_HEADER
* TT_MS_ID_XXX
*
* @description:
- * A list of valid values for the `encoding_id' for
+ * A list of valid values for the `encoding_id` for
* @TT_PLATFORM_MICROSOFT charmaps and name entries.
*
* @values:
@@ -264,7 +264,7 @@ FT_BEGIN_HEADER
* TT_ADOBE_ID_XXX
*
* @description:
- * A list of valid values for the `encoding_id' for
+ * A list of valid values for the `encoding_id` for
* @TT_PLATFORM_ADOBE charmaps. This is a FreeType-specific extension!
*
* @values:
@@ -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
@@ -786,8 +786,8 @@ FT_BEGIN_HEADER
* TT_NAME_ID_XXX
*
* @description:
- * Possible values of the `name' identifier field in the name records of
- * an SFNT `name' table. These values are platform independent.
+ * Possible values of the 'name' identifier field in the name records of
+ * an SFNT 'name' table. These values are platform independent.
*/
#define TT_NAME_ID_COPYRIGHT 0
@@ -840,8 +840,8 @@ FT_BEGIN_HEADER
* TT_UCR_XXX
*
* @description:
- * Possible bit mask values for the `ulUnicodeRangeX' fields in an SFNT
- * `OS/2' table.
+ * Possible bit mask values for the `ulUnicodeRangeX` fields in an SFNT
+ * 'OS/2' table.
*/
/* ulUnicodeRange1 */
diff --git a/include/freetype/tttables.h b/include/freetype/tttables.h
index c23d3c6..9901a84 100644
--- a/include/freetype/tttables.h
+++ b/include/freetype/tttables.h
@@ -115,9 +115,9 @@ FT_BEGIN_HEADER
* TT_HoriHeader
*
* @description:
- * A structure to model a TrueType horizontal header, the `hhea'
+ * A structure to model a TrueType horizontal header, the 'hhea'
* table, as well as the corresponding horizontal metrics table,
- * `hmtx'.
+ * 'hmtx'.
*
* @fields:
* Version ::
@@ -133,8 +133,8 @@ FT_BEGIN_HEADER
* 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 if you want
+ * You should use the `sTypoAscender` field
+ * of the 'OS/2' table instead if you want
* the correct one.
*
* Descender ::
@@ -148,8 +148,8 @@ FT_BEGIN_HEADER
* 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 instead if you
+ * You should use the `sTypoDescender`
+ * field of the 'OS/2' table instead if you
* want the correct one.
*
* Line_Gap ::
@@ -175,7 +175,7 @@ FT_BEGIN_HEADER
*
* xMax_Extent ::
* The maximum horizontal extent (i.e., the
- * `width' of a glyph's bounding box) for
+ * 'width' of a glyph's bounding box) for
* all glyphs in the font.
*
* caret_Slope_Rise ::
@@ -196,21 +196,21 @@ FT_BEGIN_HEADER
* Always~0.
*
* number_Of_HMetrics ::
- * Number of HMetrics entries in the `hmtx'
+ * 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',
- * `caret_Slope_Run', and `caret_Offset'.
+ * friends) if the font contains an 'MVAR' table: `caret_Slope_Rise`,
+ * `caret_Slope_Run`, and `caret_Offset`.
*/
typedef struct TT_HoriHeader_
{
@@ -249,9 +249,9 @@ FT_BEGIN_HEADER
* TT_VertHeader
*
* @description:
- * A structure used to model a TrueType vertical header, the `vhea'
+ * A structure used to model a TrueType vertical header, the 'vhea'
* table, as well as the corresponding vertical metrics table,
- * `vmtx'.
+ * 'vmtx'.
*
* @fields:
* Version ::
@@ -268,8 +268,8 @@ FT_BEGIN_HEADER
* the glyphs found in the font (maybe
* ASCII).
*
- * You should use the `sTypoAscender'
- * field of the `OS/2' table instead if
+ * You should use the `sTypoAscender`
+ * field of the 'OS/2' table instead if
* you want the correct one.
*
* Descender ::
@@ -284,8 +284,8 @@ FT_BEGIN_HEADER
* the glyphs found in the font (maybe
* ASCII).
*
- * You should use the `sTypoDescender'
- * field of the `OS/2' table instead if
+ * You should use the `sTypoDescender`
+ * field of the 'OS/2' table instead if
* you want the correct one.
*
* Line_Gap ::
@@ -311,7 +311,7 @@ FT_BEGIN_HEADER
*
* yMax_Extent ::
* The maximum vertical extent (i.e., the
- * `height' of a glyph's bounding box) for
+ * 'height' of a glyph's bounding box) for
* all glyphs in the font.
*
* caret_Slope_Rise ::
@@ -333,22 +333,22 @@ FT_BEGIN_HEADER
*
* number_Of_VMetrics ::
* Number of VMetrics entries in the
- * `vmtx' table -- this value can be
+ * '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', `Line_Gap', `caret_Slope_Rise', `caret_Slope_Run',
- * and `caret_Offset'.
+ * friends) if the font contains an 'MVAR' table: 'Ascender',
+ * 'Descender', `Line_Gap`, `caret_Slope_Rise`, `caret_Slope_Run`,
+ * and `caret_Offset`.
*/
typedef struct TT_VertHeader_
{
@@ -387,25 +387,25 @@ FT_BEGIN_HEADER
* TT_OS2
*
* @description:
- * A structure to model a TrueType `OS/2' table. All fields comply
+ * 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' table. In this case, the `version' field is always set to
+ * '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', `sTypoDescender', `sTypoLineGap', `sxHeight',
- * `usWinAscent', `usWinDescent', `yStrikeoutPosition',
- * `yStrikeoutSize', `ySubscriptXOffset', `ySubScriptXSize',
- * `ySubscriptYOffset', `ySubscriptYSize', `ySuperscriptXOffset',
- * `ySuperscriptXSize', `ySuperscriptYOffset', and
- * `ySuperscriptYSize'.
- *
- * Possible values for bits in the `ulUnicodeRangeX' fields are given
+ * friends) if the font contains an 'MVAR' table: `sCapHeight`,
+ * `sTypoAscender`, `sTypoDescender`, `sTypoLineGap`, `sxHeight`,
+ * `usWinAscent`, `usWinDescent`, `yStrikeoutPosition`,
+ * `yStrikeoutSize`, `ySubscriptXOffset`, `ySubScriptXSize`,
+ * `ySubscriptYOffset`, `ySubscriptYSize`, `ySuperscriptXOffset`,
+ * `ySuperscriptXSize`, `ySuperscriptYOffset`, and
+ * `ySuperscriptYSize`.
+ *
+ * Possible values for bits in the `ulUnicodeRangeX` fields are given
* by the @TT_UCR_XXX macros.
*/
@@ -473,7 +473,7 @@ FT_BEGIN_HEADER
* TT_Postscript
*
* @description:
- * A structure to model a TrueType `post' table. All fields comply
+ * 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.
@@ -481,8 +481,8 @@ 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 `underlineThickness'.
+ * friends) if the font contains an 'MVAR' table: `underlinePosition`
+ * and `underlineThickness`.
*/
typedef struct TT_Postscript_
{
@@ -508,7 +508,7 @@ FT_BEGIN_HEADER
* TT_PCLT
*
* @description:
- * A structure to model a TrueType `PCLT' table. All fields comply
+ * A structure to model a TrueType 'PCLT' table. All fields comply
* to the OpenType specification.
*/
typedef struct TT_PCLT_
@@ -538,7 +538,7 @@ FT_BEGIN_HEADER
* TT_MaxProfile
*
* @description:
- * The maximum profile (`maxp') table contains many max values, which
+ * The maximum profile ('maxp') table contains many max values, which
* can be used to pre-allocate arrays for speeding up glyph loading
* and hinting.
*
@@ -553,22 +553,22 @@ FT_BEGIN_HEADER
* maxPoints ::
* The maximum number of points in a
* non-composite TrueType glyph. See also
- * `maxCompositePoints'.
+ * `maxCompositePoints`.
*
* maxContours ::
* The maximum number of contours in a
* non-composite TrueType glyph. See also
- * `maxCompositeContours'.
+ * `maxCompositeContours`.
*
* maxCompositePoints ::
* The maximum number of points in a
* composite TrueType glyph. See also
- * `maxPoints'.
+ * `maxPoints`.
*
* maxCompositeContours ::
* The maximum number of contours in a
* composite TrueType glyph. See also
- * `maxContours'.
+ * `maxContours`.
*
* maxZones ::
* The maximum number of zones used for
@@ -706,10 +706,10 @@ FT_BEGIN_HEADER
*
* @return:
* A type-less pointer to the table. This will be NULL in case of
- * error, or if the corresponding table was not found *OR* loaded
+ * error, or if the corresponding table was not found **OR** loaded
* from the file.
*
- * Use a typecast according to `tag' to access the structure
+ * Use a typecast according to 'tag' to access the structure
* elements.
*
* @note:
@@ -720,15 +720,15 @@ FT_BEGIN_HEADER
* a list.
*
* @example:
- * Here an example how to access the `vhea' table.
+ * Here an example how to access the 'vhea' table.
*
- * {
+ * ```
* TT_VertHeader* vert_header;
*
*
* vert_header =
* (TT_VertHeader*)FT_Get_Sfnt_Table( face, FT_SFNT_VHEA );
- * }
+ * ```
*/
FT_EXPORT( void* )
FT_Get_Sfnt_Table( FT_Face face,
@@ -763,10 +763,10 @@ FT_BEGIN_HEADER
*
* @inout:
* length ::
- * If the `length' parameter is NULL, try to load the whole table.
+ * If the 'length' parameter is NULL, try to load the whole table.
* Return an error code if it fails.
*
- * Else, if `*length' is~0, exit immediately while returning the
+ * Else, if '*length' is~0, exit immediately while returning the
* table's (or file) full size in it.
*
* Else the number of bytes to read from the table or file, from the
@@ -777,9 +777,9 @@ FT_BEGIN_HEADER
*
* @note:
* If you need to determine the table's length you should first call this
- * function with `*length' set to~0, as in the following example:
+ * function with '*length' set to~0, as in the following example:
*
- * {
+ * ```
* FT_ULong length = 0;
*
*
@@ -791,7 +791,7 @@ FT_BEGIN_HEADER
*
* error = FT_Load_Sfnt_Table( face, tag, 0, buffer, &length );
* if ( error ) { ... could not load table ... }
- * }
+ * ```
*
* Note that structures like @TT_Header or @TT_OS2 can't be used with
* this function; they are limited to @FT_Get_Sfnt_Table. Reason is that
@@ -825,14 +825,14 @@ FT_BEGIN_HEADER
*
* @inout:
* tag ::
- * The name tag of the SFNT table. If the value is NULL, `table_index'
- * is ignored, and `length' returns the number of SFNT tables in the
+ * The name tag of the SFNT table. If the value is NULL, `table_index`
+ * is ignored, and 'length' returns the number of SFNT tables in the
* font.
*
* @output:
* length ::
* The length of the SFNT table (or the number of SFNT tables, depending
- * on `tag').
+ * on 'tag').
*
* @return:
* FreeType error code. 0~means success.
@@ -863,7 +863,7 @@ FT_BEGIN_HEADER
* The target charmap.
*
* @return:
- * The language ID of `charmap'. If `charmap' doesn't belong to an
+ * The language ID of 'charmap'. If 'charmap' doesn't belong to an
* SFNT face, just return~0 as the default value.
*
* For a format~14 cmap (to access Unicode IVS), the return value is
@@ -879,14 +879,14 @@ 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 ::
* The target charmap.
*
* @return:
- * The format of `charmap'. If `charmap' doesn't belong to an SFNT
+ * The format of 'charmap'. If 'charmap' doesn't belong to an SFNT
* face, return -1.
*/
FT_EXPORT( FT_Long )
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [freetype2] GSoC-2018-nikhil 628ca69 4/4: * include/*.*: `Markify' header files.,
Nikhil Ramakrishnan <=