diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h index 26f671d41..83c7f14a4 100644 --- a/include/freetype/freetype.h +++ b/include/freetype/freetype.h @@ -84,8 +84,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. + * it is recommended to use `calloc` (or variants of it) instead of + * `malloc` for allocation. * */ @@ -308,7 +308,7 @@ FT_BEGIN_HEADER * `horiAdvance` or `vertAdvance`; you have to manually adjust these * values to account for the added width and height. * - * FreeType doesn't use the 'VORG' table data for CFF fonts because it + * FreeType doesn't use the `VORG` table data for CFF fonts because it * doesn't have an interface to quickly retrieve the glyph height. The * y~coordinate of the vertical origin can be simply computed as * `vertBearingY + height` after loading a glyph. @@ -360,12 +360,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 + * 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 bitmap + * `size`, `width`, and `height` values are not contained in the bitmap * strike itself. They are computed from the global font parameters. */ typedef struct FT_Bitmap_Size_ @@ -718,27 +718,27 @@ FT_BEGIN_HEADER * * @note: * By default, FreeType enables a Unicode charmap and tags it with - * FT_ENCODING_UNICODE when it is either provided or can be generated + * `FT_ENCODING_UNICODE` when it is either provided or can be generated * from PostScript glyph name dictionaries in the font file. All other * encodings are considered legacy and tagged only if explicitly defined - * in the font file. Otherwise, FT_ENCODING_NONE is used. + * in the font file. Otherwise, `FT_ENCODING_NONE` is used. * - * FT_ENCODING_NONE is set by the BDF and PCF drivers if the charmap is + * `FT_ENCODING_NONE` is set by the BDF and PCF drivers if the charmap 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 + * `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', 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' + * `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 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_APPLE_ROMAN). + * `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 * @FT_Get_CMap_Language_ID to query the Mac language ID that may be @@ -786,7 +786,7 @@ FT_BEGIN_HEADER } FT_Encoding; - /* these constants are deprecated; use the corresponding `FT_Encoding' */ + /* these constants are deprecated; use the corresponding `FT_Encoding` */ /* values instead */ #define ft_encoding_none FT_ENCODING_NONE #define ft_encoding_unicode FT_ENCODING_UNICODE @@ -995,7 +995,7 @@ FT_BEGIN_HEADER * baselines, expressed in font units. It is always positive. Only * relevant for scalable formats. * - * If you want the global glyph height, use 'ascender - descender'. + * If you want the global glyph height, use `ascender - descender`. * * max_advance_width :: * The maximum advance width, in font units, for all glyphs in this @@ -1005,7 +1005,7 @@ FT_BEGIN_HEADER * max_advance_height :: * 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 vertical metrics. Only + * `height` for fonts that do not provide vertical metrics. Only * relevant for scalable formats. * * underline_position :: @@ -1032,7 +1032,7 @@ FT_BEGIN_HEADER * * For an OpenType variation font, the values of the following fields can * change after a call to @FT_Set_Var_Design_Coordinates (and friends) if - * the font contains an 'MVAR' table: 'ascender', 'descender', 'height', + * the font contains an `MVAR` table: `ascender`, `descender`, `height`, * `underline_position`, and `underline_thickness`. * * Especially for TrueType fonts see also the documentation for @@ -1059,7 +1059,7 @@ FT_BEGIN_HEADER FT_Generic generic; - /*# The following member variables (down to `underline_thickness') */ + /*# The following member variables (down to `underline_thickness`) */ /*# are only relevant to scalable outlines; cf. @FT_Bitmap_Size */ /*# for bitmap fonts. */ FT_BBox bbox; @@ -1137,7 +1137,7 @@ FT_BEGIN_HEADER * The face contains kerning information. If set, the kerning distance * can be retrieved using the function @FT_Get_Kerning. Otherwise the * function always return the vector (0,0). Note that FreeType doesn't - * handle kerning data from the SFNT 'GPOS' table (as present in many + * handle kerning data from the SFNT `GPOS` table (as present in many * OpenType fonts). * * FT_FACE_FLAG_FAST_GLYPHS :: @@ -1163,7 +1163,7 @@ FT_BEGIN_HEADER * * FT_FACE_FLAG_HINTER :: * The font driver has a hinting machine of its own. For example, with - * TrueType fonts, it makes sense to use data from the SFNT 'gasp' + * TrueType fonts, it makes sense to use data from the SFNT `gasp` * table only if the native TrueType hinting engine (with the bytecode * interpreter) is available and active. * @@ -1482,7 +1482,7 @@ FT_BEGIN_HEADER * @note: * The style information as provided by FreeType is very basic. More * details are beyond the scope and should be done on a higher level (for - * example, by analyzing various fields of the 'OS/2' table in SFNT based + * example, by analyzing various fields of the `OS/2` table in SFNT based * fonts). */ #define FT_STYLE_FLAG_ITALIC ( 1 << 0 ) @@ -1703,7 +1703,7 @@ FT_BEGIN_HEADER * next :: * In some cases (like some font tools), several 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. + * listed through a direct, single-linked list using its `next` field. * * glyph_index :: * [Since 2.10] The glyph index passed as an argument to @FT_Load_Glyph @@ -1739,7 +1739,7 @@ FT_BEGIN_HEADER * This shorthand is, depending on @FT_LOAD_IGNORE_TRANSFORM, the * transformed (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' + * either the `horiAdvance` or the `vertAdvance` value of `metrics` * field. * * format :: @@ -1762,7 +1762,7 @@ FT_BEGIN_HEADER * * 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 + * @FT_GLYPH_FORMAT_OUTLINE. Once a glyph is loaded, `outline` can be * transformed, distorted, emboldened, etc. However, it must not be * freed. * @@ -1948,9 +1948,10 @@ FT_BEGIN_HEADER * If you need reference-counting (cf. @FT_Reference_Library), use * @FT_New_Library and @FT_Done_Library. * - * If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is set, - * this function reads the `FREETYPE_PROPERTIES` environment variable to - * control driver properties. See section @properties for more. + * If compilation option `FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES` is + * set, this function reads the `FREETYPE_PROPERTIES` environment + * variable to control driver properties. See section @properties for + * more. */ FT_EXPORT( FT_Error ) FT_Init_FreeType( FT_Library *alibrary ); @@ -1982,7 +1983,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: @@ -1990,16 +1991,16 @@ 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` flags @@ -2012,7 +2013,7 @@ FT_BEGIN_HEADER #define FT_OPEN_PARAMS 0x10 - /* these constants are deprecated; use the corresponding `FT_OPEN_XXX' */ + /* these constants are deprecated; use the corresponding `FT_OPEN_XXX` */ /* values instead */ #define ft_open_memory FT_OPEN_MEMORY #define ft_open_stream FT_OPEN_STREAM @@ -2088,8 +2089,8 @@ FT_BEGIN_HEADER * Extra parameters passed to the font driver when opening a new face. * * @note: - * The stream type is determined by the contents of 'flags' that - * are tested in the following order by @FT_Open_Face: + * 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`. The data are not @@ -2097,18 +2098,18 @@ FT_BEGIN_HEADER * 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. + * 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. + * 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'. + * 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 + * 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. */ @@ -2241,7 +2242,7 @@ FT_BEGIN_HEADER * In general, 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 useful fields in + * in `*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` gives the * number of faces within the font file. For the negative value @@ -2269,7 +2270,7 @@ FT_BEGIN_HEADER * * 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. + * same `library` argument. * * See the discussion of reference counters in the description of * @FT_Reference_Face. @@ -2524,12 +2525,12 @@ FT_BEGIN_HEADER * 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 scaling + * 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 of + * 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. * @@ -2586,19 +2587,19 @@ 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 + * 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, + * 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 to the + * 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. @@ -2877,10 +2878,10 @@ FT_BEGIN_HEADER * unsets @FT_LOAD_RENDER. * * 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`. + * `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`. * * FT_LOAD_NO_HINTING :: * Disable hinting. This generally generates 'blurrier' bitmap glyphs @@ -2904,8 +2905,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 get @@ -2928,7 +2929,7 @@ 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 + * 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. @@ -2965,7 +2966,7 @@ FT_BEGIN_HEADER * bitmaps, using the @FT_PIXEL_MODE_GRAY format. * * [Since 2.10] If the glyph index contains an entry in the face's - * 'COLR' table with a 'CPAL' palette table (as defined in the OpenType + * `COLR` table with a `CPAL` palette table (as defined in the OpenType * specification), make @FT_Render_Glyph provide a default blending of * the color glyph layers associated with the glyph index, using the * same bitmap format as embedded color bitmap images. This is mainly @@ -2976,7 +2977,7 @@ FT_BEGIN_HEADER * * FT_LOAD_COMPUTE_METRICS :: * [Since 2.6.1] Compute glyph metrics from the glyph data, without the - * use of bundled metrics tables (for example, the 'hdmx' table in + * use of bundled metrics tables (for example, the `hdmx` table in * TrueType fonts). This flag is mainly used by font validating or * font editing applications, which need to ignore, verify, or edit * those tables. @@ -3014,7 +3015,7 @@ FT_BEGIN_HEADER * Note that the auto-hinter needs a valid Unicode cmap (either a native * one or synthesized by FreeType) for producing correct results. If a * font provides an incorrect mapping (for example, assigning the - * character code U+005A, LATIN CAPITAL LETTER Z, to a glyph depicting a + * character code U+005A, LATIN CAPITAL LETTER~Z, to a glyph depicting a * mathematical integral sign), the auto-hinter might produce useless * results. * @@ -3034,7 +3035,7 @@ FT_BEGIN_HEADER #define FT_LOAD_MONOCHROME ( 1L << 12 ) #define FT_LOAD_LINEAR_DESIGN ( 1L << 13 ) #define FT_LOAD_NO_AUTOHINT ( 1L << 15 ) - /* Bits 16-19 are used by `FT_LOAD_TARGET_' */ + /* Bits 16-19 are used by `FT_LOAD_TARGET_` */ #define FT_LOAD_COLOR ( 1L << 20 ) #define FT_LOAD_COMPUTE_METRICS ( 1L << 21 ) #define FT_LOAD_BITMAP_METRICS_ONLY ( 1L << 22 ) @@ -3080,9 +3081,10 @@ FT_BEGIN_HEADER * possible to get fractional advance widths for subpixel positioning * (which is recommended to use). * - * If configuration option AF_CONFIG_OPTION_TT_SIZE_METRICS is active, - * TrueType-like metrics are used to make this mode behave similarly as - * in unpatched FreeType versions between 2.4.6 and 2.7.1 (inclusive). + * If configuration option `AF_CONFIG_OPTION_TT_SIZE_METRICS` is + * active, TrueType-like metrics are used to make this mode behave + * similarly as in unpatched FreeType versions between 2.4.6 and 2.7.1 + * (inclusive). * * FT_LOAD_TARGET_MONO :: * Strong hinting algorithm that should only be used for monochrome @@ -3098,12 +3100,12 @@ FT_BEGIN_HEADER * decimated LCD displays. * * @note: - * You should use only _one_ of the FT_LOAD_TARGET_XXX values in your + * You should use only _one_ of the `FT_LOAD_TARGET_XXX` values in your * `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 - * best). An exception is FT_LOAD_TARGET_MONO since it implies + * best). An exception is `FT_LOAD_TARGET_MONO` since it implies * @FT_LOAD_MONOCHROME. * * You can use a hinting algorithm that doesn't correspond to the same @@ -3227,7 +3229,7 @@ FT_BEGIN_HEADER * pixels and use the @FT_PIXEL_MODE_LCD_V mode. * * @note: - * Should you define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your + * Should you define `FT_CONFIG_OPTION_SUBPIXEL_RENDERING` in your * `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 @@ -3254,7 +3256,7 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `FT_Render_Mode' values instead */ + /* `FT_Render_Mode` values instead */ #define ft_render_mode_normal FT_RENDER_MODE_NORMAL #define ft_render_mode_mono FT_RENDER_MODE_MONO @@ -3388,11 +3390,11 @@ FT_BEGIN_HEADER * Return the kerning vector in original font units. * * @note: - * FT_KERNING_DEFAULT returns full pixel values; it also makes FreeType + * `FT_KERNING_DEFAULT` returns full pixel values; it also makes FreeType * heuristically scale down kerning distances at small ppem values so * that they don't become too big. * - * Both FT_KERNING_DEFAULT and FT_KERNING_UNFITTED use the current + * Both `FT_KERNING_DEFAULT` and `FT_KERNING_UNFITTED` use the current * horizontal scaling factor (as set e.g. with @FT_Set_Char_Size) to * convert font units to pixels. */ @@ -3406,7 +3408,7 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `FT_Kerning_Mode' values instead */ + /* `FT_Kerning_Mode` values instead */ #define ft_kerning_default FT_KERNING_DEFAULT #define ft_kerning_unfitted FT_KERNING_UNFITTED #define ft_kerning_unscaled FT_KERNING_UNSCALED @@ -3449,7 +3451,7 @@ FT_BEGIN_HEADER * out of the scope of this API function -- they can be implemented * through format-specific interfaces. * - * Kerning for OpenType fonts implemented in a 'GPOS' table is not + * Kerning for OpenType fonts implemented in a `GPOS` table is not * supported; use @FT_HAS_KERNING to find out whether a font has data * that can be extracted with `FT_Get_Kerning`. */ @@ -3533,7 +3535,7 @@ 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. + * `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. @@ -3579,7 +3581,7 @@ FT_BEGIN_HEADER * * [Since 2.9] Special PostScript names for named instances are only * returned if the named instance is set with @FT_Set_Named_Instance (and - * the font has corresponding entries in its 'fvar' table). If + * the font has corresponding entries in its `fvar` table). If * @FT_IS_VARIATION returns true, the algorithmically derived PostScript * name is provided, not looking up special entries for named instances. */ @@ -3667,7 +3669,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 ) @@ -3756,7 +3758,7 @@ FT_BEGIN_HEADER * 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 result + * 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. */ @@ -3794,7 +3796,7 @@ FT_BEGIN_HEADER * 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 the + * Note that `*agindex` is set to~0 when there are no more codes in the * charmap. */ FT_EXPORT( FT_ULong ) @@ -3819,18 +3821,18 @@ FT_BEGIN_HEADER * that only a subset of the available properties can be controlled. * * * @FT_PARAM_TAG_STEM_DARKENING (stem darkening, corresponding to the - * property 'no-stem-darkening' provided by the 'autofit', 'cff', + * 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 + * '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: @@ -3848,7 +3850,7 @@ FT_BEGIN_HEADER * * @example: * Here an example that sets three properties. You must define - * FT_CONFIG_OPTION_SUBPIXEL_RENDERING to make the LCD filter examples + * `FT_CONFIG_OPTION_SUBPIXEL_RENDERING` to make the LCD filter examples * work. * * ``` @@ -3930,7 +3932,7 @@ FT_BEGIN_HEADER * FT_SUBGLYPH_FLAG_XXX * * @description: - * A list of constants describing subglyphs. Please refer to the 'glyf' + * A list of constants describing subglyphs. Please refer to the `glyf` * table description in the OpenType specification for the meaning of the * various flags (which get synthesized for non-OpenType subglyphs). * @@ -4019,11 +4021,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. */ @@ -4044,7 +4046,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_ @@ -4062,7 +4064,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. * @@ -4185,7 +4187,7 @@ FT_BEGIN_HEADER * * @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 PostScript font. + * 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. @@ -4368,7 +4370,7 @@ FT_BEGIN_HEADER * * @description: * Check whether this variation of this Unicode character is the one to - * be found in the 'cmap'. + * be found in the charmap. * * @input: * face :: @@ -4534,7 +4536,7 @@ FT_BEGIN_HEADER * FT_MulDiv * * @description: - * Compute '(a*b)/c' with maximum accuracy, using a 64-bit intermediate + * 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 @@ -4551,9 +4553,9 @@ FT_BEGIN_HEADER * The divisor. * * @return: - * The result of '(a*b)/c'. This function never traps when trying to + * 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 signs of `a` and `b`. */ FT_EXPORT( FT_Long ) FT_MulDiv( FT_Long a, @@ -4567,7 +4569,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: @@ -4579,11 +4581,11 @@ FT_BEGIN_HEADER * (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. As this + * 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. @@ -4602,7 +4604,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: @@ -4613,7 +4615,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, @@ -4633,7 +4635,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: @@ -4656,7 +4658,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. @@ -4678,7 +4680,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 ); @@ -4701,10 +4703,10 @@ 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, + FT_Vector_Transform( FT_Vector* vector, const FT_Matrix* matrix ); @@ -4789,7 +4791,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 13c53a9ec..8bee5ad69 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 @@ -149,7 +149,7 @@ FT_BEGIN_HEADER * @output: * padvance :: * The advance values. This array, to be provided by the caller, must - * contain at least 'count' elements. + * contain at least `count` elements. * * If scaling is performed (based on the value of `load_flags`), the * advance values are in 16.16 format. Otherwise, they are in font diff --git a/include/freetype/ftbdf.h b/include/freetype/ftbdf.h index 59249a27d..2b5fddb72 100644 --- a/include/freetype/ftbdf.h +++ b/include/freetype/ftbdf.h @@ -189,7 +189,7 @@ FT_BEGIN_HEADER * * 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; * consequently, @BDF_PROPERTY_TYPE_CARDINAL is a possible return value diff --git a/include/freetype/ftbitmap.h b/include/freetype/ftbitmap.h index 900c0ae52..feda8b561 100644 --- a/include/freetype/ftbitmap.h +++ b/include/freetype/ftbitmap.h @@ -50,10 +50,10 @@ FT_BEGIN_HEADER * automatically adjusting the target's bitmap buffer size as needed. * * Note that none of the functions changes the bitmap's 'flow' (as - * indicated by the sign of the 'pitch' field in @FT_Bitmap). + * indicated by the sign of the `pitch` field in @FT_Bitmap). * * To set the flow, assign an appropriate positive or negative value to - * the 'pitch' field of the target @FT_Bitmap object after calling + * the `pitch` field of the target @FT_Bitmap object after calling * @FT_Bitmap_Init but before calling any of the other functions * described here. */ @@ -169,7 +169,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'. + * line (a.k.a. the 'pitch') a multiple of `alignment`. * * @input: * library :: @@ -195,7 +195,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 memory + * The `library` argument is taken to have access to FreeType's memory * handling functions. * * `source->buffer` and `target->buffer` must neither be equal nor @@ -228,7 +228,7 @@ 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 :: @@ -247,12 +247,12 @@ FT_BEGIN_HEADER * @note: * This function doesn't perform clipping. * - * The bitmap in 'target' gets allocated or reallocated as needed; the + * 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). * * `source->buffer` and `target->buffer` must neither be equal nor * overlap. @@ -310,7 +310,7 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @note: - * The 'library' argument is taken to have access to FreeType's memory + * The `library` argument is taken to have access to FreeType's memory * handling functions. */ FT_EXPORT( FT_Error ) diff --git a/include/freetype/ftcache.h b/include/freetype/ftcache.h index e41b8700b..829ea78ac 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. * @@ -423,16 +423,16 @@ FT_BEGIN_HEADER * The character height. * * pixel :: - * A Boolean. If 1, the 'width' and 'height' fields are interpreted as + * 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 horizontal + * 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 vertical + * Only used when `pixel` is value~0 to indicate the vertical * resolution in dpi. * * @note: @@ -772,12 +772,12 @@ 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 node + * 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. * - * If 'anode' is NULL, the cache node is left unchanged, which means that + * 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! @@ -828,12 +828,12 @@ 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 node + * 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. * - * If 'anode' is NULL, the cache node is left unchanged, which means that + * 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! @@ -996,15 +996,15 @@ FT_BEGIN_HEADER * 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 node + * 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. * - * If 'anode' is NULL, the cache node is left unchanged, which means that + * 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! */ @@ -1055,15 +1055,15 @@ FT_BEGIN_HEADER * 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 node + * 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. * - * If 'anode' is NULL, the cache node is left unchanged, which means that + * 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 f6e5a08e0..93df3a2fd 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. @@ -118,7 +118,7 @@ FT_BEGIN_HEADER * FT_Palette_Data * * @description: - * This structure holds the data of the 'CPAL' table. + * This structure holds the data of the `CPAL` table. * * @fields: * num_palettes :: @@ -126,13 +126,13 @@ FT_BEGIN_HEADER * * palette_name_ids :: * A read-only array of palette name IDs with `num_palettes` elements, - * corresponding to entries like 'dark' or 'light' in the font's 'name' + * corresponding to entries like 'dark' or 'light' in the font's `name` * table. * - * An empty name ID in the 'CPAL' table gets represented as value + * An empty name ID in the `CPAL` table gets represented as value * 0xFFFF. * - * NULL if the font's 'CPAL' table doesn't contain appropriate data. + * NULL if the font's `CPAL` table doesn't contain appropriate data. * * palette_flags :: * A read-only array of palette flags with `num_palettes` elements. @@ -140,7 +140,7 @@ FT_BEGIN_HEADER * @FT_PALETTE_FOR_LIGHT_BACKGROUND and * @FT_PALETTE_FOR_DARK_BACKGROUND. * - * NULL if the font's 'CPAL' table doesn't contain appropriate data. + * NULL if the font's `CPAL` table doesn't contain appropriate data. * * num_palette_entries :: * The number of entries in a single palette. All palettes have the @@ -150,14 +150,14 @@ FT_BEGIN_HEADER * A read-only array of palette entry name IDs with * `num_palette_entries`. In each palette, entries with the same index * have the same function. For example, index~0 might correspond to - * string 'outline' in the font's 'name' table to indicate that this + * string 'outline' in the font's `name` table to indicate that this * palette entry is used for outlines, index~1 might correspond to * 'fill' to indicate the filling color palette entry, etc. * - * An empty entry name ID in the 'CPAL' table gets represented as value + * An empty entry name ID in the `CPAL` table gets represented as value * 0xFFFF. * - * NULL if the font's 'CPAL' table doesn't contain appropriate data. + * NULL if the font's `CPAL` table doesn't contain appropriate data. * * @note: * Use function @FT_Get_Sfnt_Name to map name IDs and entry name IDs to @@ -226,7 +226,7 @@ FT_BEGIN_HEADER * * A corollary of (2) is that calling the function, then modifying some * values, then calling the function again with the same arguments resets - * all color entries to the original 'CPAL' values; all user modifications + * all color entries to the original `CPAL` values; all user modifications * are lost. * * @input: @@ -239,7 +239,7 @@ 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 + * 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. @@ -272,7 +272,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: @@ -290,7 +290,7 @@ FT_BEGIN_HEADER * white opaque (BGRA value 0xFFFFFFFF) if * @FT_PALETTE_FOR_DARK_BACKGROUND is present for the current palette, * and black opaque (BGRA value 0x000000FF) otherwise, including the case - * that no palette types are available in the 'CPAL' table. + * that no palette types are available in the `CPAL` table. * * This function always returns an error if the config macro * `TT_CONFIG_OPTION_COLOR_LAYERS` is not defined in `ftoption.h`. diff --git a/include/freetype/ftdriver.h b/include/freetype/ftdriver.h index b843a4d69..1e6835d69 100644 --- a/include/freetype/ftdriver.h +++ b/include/freetype/ftdriver.h @@ -233,7 +233,7 @@ FT_BEGIN_HEADER * achieve some level of glyph symmetry. To enable reasonable * performance (e.g., not having to run hinting on all glyphs just to get * the widths) there was a bit in the head table indicating if the side - * bearing was hinted, and additional tables, 'hdmx' and 'LTSH', to cache + * bearing was hinted, and additional tables, `hdmx` and `LTSH`, to cache * hinting widths across multiple sizes and device aspect ratios. * * _Font Smoothing_ @@ -357,17 +357,17 @@ FT_BEGIN_HEADER * @description: * Thanks to Adobe, which contributed a new hinting (and parsing) 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. + * with `CFF_CONFIG_OPTION_OLD_ENGINE`. If this configuration 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. + * `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. + * `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' + * 'freetype' if `T1_CONFIG_OPTION_OLD_ENGINE` is defined, and 'adobe' * otherwise. * * @note: @@ -432,7 +432,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 TRUE + * 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 @@ -478,7 +478,7 @@ 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' + * CID font drivers, darkens stems as follows (if the `no-stem-darkening` * property isn't set): * * ``` @@ -492,7 +492,7 @@ FT_BEGIN_HEADER * control points can be set with the macro * `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,7 +510,7 @@ FT_BEGIN_HEADER * * 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=\ @@ -555,7 +555,7 @@ FT_BEGIN_HEADER * 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 (or * a default value if there is no such operator). If the value is @@ -581,7 +581,7 @@ FT_BEGIN_HEADER * no-long-family-names * * @description: - * If PCF_CONFIG_OPTION_LONG_FAMILY_NAMES is active while compiling + * 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 @@ -593,7 +593,7 @@ FT_BEGIN_HEADER * 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. @@ -658,7 +658,7 @@ FT_BEGIN_HEADER * filtering. * * If FreeType has not been compiled with the configuration option - * TT_CONFIG_OPTION_SUBPIXEL_HINTING, selecting version~38 or~40 causes + * `TT_CONFIG_OPTION_SUBPIXEL_HINTING`, selecting version~38 or~40 causes * an `FT_Err_Unimplemented_Feature` error. * * Depending on the graphics framework, Microsoft uses different bytecode @@ -760,8 +760,8 @@ FT_BEGIN_HEADER * 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). + * `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 @@ -830,7 +830,7 @@ FT_BEGIN_HEADER * 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 this array, + * 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 actually uses the modified @@ -1026,7 +1026,7 @@ FT_BEGIN_HEADER * 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, this fallback value can be changed. + * `fallback-script` property, this fallback value can be changed. * * @note: * This property can be used with @FT_Property_Get also. @@ -1065,17 +1065,17 @@ FT_BEGIN_HEADER * @description: * **Experimental only** * - * If FreeType gets compiled with FT_CONFIG_OPTION_USE_HARFBUZZ to make + * 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 + * 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. @@ -1112,7 +1112,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 @@ -1173,7 +1173,7 @@ FT_BEGIN_HEADER * @description: * **Experimental only** * - * If FreeType gets compiled with option AF_CONFIG_OPTION_USE_WARPER to + * 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. * diff --git a/include/freetype/fterrors.h b/include/freetype/fterrors.h index 1f7260266..3e1da19c1 100644 --- a/include/freetype/fterrors.h +++ b/include/freetype/fterrors.h @@ -35,7 +35,7 @@ * * **Error Formats** * - * The configuration macro FT_CONFIG_OPTION_USE_MODULE_ERRORS can be + * The configuration macro `FT_CONFIG_OPTION_USE_MODULE_ERRORS` can be * 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` @@ -56,7 +56,7 @@ * ``` * * This macro is called before anything else to define the start of the - * error list. It is followed by several FT_ERROR_DEF calls. + * error list. It is followed by several `FT_ERROR_DEF` calls. * * ``` * FT_ERROR_DEF( e, v, s ) @@ -101,18 +101,20 @@ * #define FT_ERROR_END_LIST } * ``` * - * If you use FT_CONFIG_OPTION_USE_MODULE_ERRORS, 'error_code' should be - * replaced with 'FT_ERROR_BASE(error_code)' in the last example. + * If you use `FT_CONFIG_OPTION_USE_MODULE_ERRORS`, `error_code` should + * be replaced with `FT_ERROR_BASE(error_code)` in the last example. */ /* */ - /* In previous FreeType versions we used `__FTERRORS_H__'. However, */ + /* In previous FreeType versions we used `__FTERRORS_H__`. However, */ /* using two successive underscores in a non-system symbol name */ /* violates the C (and C++) standard, so it was changed to the */ /* current form. In spite of this, we have to make */ /* */ + /* ``` */ /* #undefine __FTERRORS_H__ */ + /* ``` */ /* */ /* work for backward compatibility. */ /* */ @@ -138,7 +140,7 @@ /* FT_ERR_PREFIX is used as a prefix for error identifiers. */ - /* By default, we use `FT_Err_'. */ + /* By default, we use `FT_Err_`. */ /* */ #ifndef FT_ERR_PREFIX #define FT_ERR_PREFIX FT_Err_ @@ -232,9 +234,9 @@ /* FT_INCLUDE_ERR_PROTOS: Control if function prototypes should be */ /* included with `#include FT_ERRORS_H'. This is */ - /* only true where `FT_ERRORDEF' is undefined. */ + /* only true where `FT_ERRORDEF` is undefined. */ /* FT_ERR_PROTOS_DEFINED: Actual multiple-inclusion protection of */ - /* `fterrors.h'. */ + /* `fterrors.h`. */ #ifdef FT_INCLUDE_ERR_PROTOS #undef FT_INCLUDE_ERR_PROTOS diff --git a/include/freetype/ftgasp.h b/include/freetype/ftgasp.h index 6cba308ba..e178ebe74 100644 --- a/include/freetype/ftgasp.h +++ b/include/freetype/ftgasp.h @@ -2,7 +2,7 @@ * * ftgasp.h * - * Access of TrueType's 'gasp' table (specification). + * Access of TrueType's `gasp` table (specification). * * Copyright 2007-2018 by * David Turner, Robert Wilhelm, and Werner Lemberg. @@ -41,11 +41,11 @@ FT_BEGIN_HEADER * Gasp Table * * @abstract: - * Retrieving TrueType 'gasp' table entries. + * Retrieving TrueType `gasp` table entries. * * @description: * The function @FT_Get_Gasp can be used to query a TrueType or OpenType - * font for specific entries in its 'gasp' table, if any. This is mainly + * font for specific entries in its `gasp` table, if any. This is mainly * useful when implementing native TrueType hinting with the bytecode * interpreter to duplicate the Windows text rendering results. */ @@ -106,7 +106,7 @@ FT_BEGIN_HEADER * * @description: * For a TrueType or OpenType font file, return the rasterizer behaviour - * flags from the font's 'gasp' table corresponding to a given character + * flags from the font's `gasp` table corresponding to a given character * pixel size. * * @input: @@ -118,7 +118,7 @@ FT_BEGIN_HEADER * * @return: * Bit flags (see @FT_GASP_XXX), or @FT_GASP_NO_TABLE if there is no - * 'gasp' table in the face. + * `gasp` table in the face. * * @note: * If you want to use the MM functionality of OpenType variation fonts diff --git a/include/freetype/ftglyph.h b/include/freetype/ftglyph.h index d570b205c..9581b44c3 100644 --- a/include/freetype/ftglyph.h +++ b/include/freetype/ftglyph.h @@ -378,7 +378,7 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `FT_Glyph_BBox_Mode' values instead */ + /* `FT_Glyph_BBox_Mode` values instead */ #define ft_glyph_bbox_unscaled FT_GLYPH_BBOX_UNSCALED #define ft_glyph_bbox_subpixels FT_GLYPH_BBOX_SUBPIXELS #define ft_glyph_bbox_gridfit FT_GLYPH_BBOX_GRIDFIT @@ -495,7 +495,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 be @@ -609,18 +609,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 925c67f4d..75b02505e 100644 --- a/include/freetype/ftgxval.h +++ b/include/freetype/ftgxval.h @@ -73,8 +73,8 @@ FT_BEGIN_HEADER /************************************************************************** * * - * Warning: Use FT_VALIDATE_XXX to validate a table. - * Following definitions are for gxvalid developers. + * Warning: Use `FT_VALIDATE_XXX` to validate a table. + * Following definitions are for gxvalid developers. * * */ @@ -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. @@ -265,13 +265,13 @@ FT_BEGIN_HEADER * * @values: * FT_VALIDATE_MS :: - * Handle the 'kern' table as a classic Microsoft kern table. + * Handle the `kern` table as a classic Microsoft kern table. * * FT_VALIDATE_APPLE :: - * Handle the 'kern' table as a classic Apple kern table. + * Handle the `kern` table as a classic Apple kern table. * * FT_VALIDATE_CKERN :: - * Handle the 'kern' as either classic Apple or Microsoft kern table. + * Handle the `kern` as either classic Apple or Microsoft kern table. */ #define FT_VALIDATE_MS ( FT_VALIDATE_GX_START << 0 ) #define FT_VALIDATE_APPLE ( FT_VALIDATE_GX_START << 1 ) @@ -290,7 +290,7 @@ FT_BEGIN_HEADER * library that actually does the text layout can access those tables * without error checking (which can be quite time consuming). * - * The 'kern' table validator in @FT_TrueTypeGX_Validate deals with both + * The `kern` table validator in @FT_TrueTypeGX_Validate deals with both * the new 32-bit format and the classic 16-bit format, while * FT_ClassicKern_Validate only supports the classic 16-bit format. * diff --git a/include/freetype/ftgzip.h b/include/freetype/ftgzip.h index 085e705eb..2b40aeb3b 100644 --- a/include/freetype/ftgzip.h +++ b/include/freetype/ftgzip.h @@ -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 :: @@ -121,7 +121,7 @@ FT_BEGIN_HEADER * 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'. + * the used data in `output`. * * @return: * FreeType error code. 0~means success. diff --git a/include/freetype/ftimage.h b/include/freetype/ftimage.h index 497359924..c7f968933 100644 --- a/include/freetype/ftimage.h +++ b/include/freetype/ftimage.h @@ -110,7 +110,7 @@ FT_BEGIN_HEADER * * 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 ascender. + * 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, the @@ -194,7 +194,7 @@ FT_BEGIN_HEADER } FT_Pixel_Mode; - /* these constants are deprecated; use the corresponding `FT_Pixel_Mode' */ + /* these constants are deprecated; use the corresponding `FT_Pixel_Mode` */ /* values instead. */ #define ft_pixel_mode_none FT_PIXEL_MODE_NONE #define ft_pixel_mode_mono FT_PIXEL_MODE_MONO @@ -231,7 +231,7 @@ FT_BEGIN_HEADER * border, and FreeType functions normally align to the smallest * possible integer value. * - * For the B/W rasterizer, 'pitch' is always an even number. + * 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 @@ -313,15 +313,15 @@ FT_BEGIN_HEADER * * If bit~2 is set, bits 5-7 contain the drop-out mode (as defined in * the OpenType specification; the value is the same as the argument to - * the SCANMODE instruction). + * the 'SCANMODE' instruction). * * Bits 3 and~4 are reserved for internal purposes. * * contours :: * 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. + * defined by the points '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 and give hints @@ -329,10 +329,10 @@ FT_BEGIN_HEADER * @FT_OUTLINE_XXX. * * @note: - * The B/W rasterizer only checks bit~2 in the 'tags' array for the first + * 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_ { @@ -362,7 +362,7 @@ FT_BEGIN_HEADER * * @description: * A list of bit-field constants used for the flags in an outline's - * 'flags' field. + * `flags` field. * * @values: * FT_OUTLINE_NONE :: @@ -370,7 +370,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 outline + * `points`, `flags`, and `contours`) are 'owned' by the outline * object, and should thus be freed when it is destroyed. * * FT_OUTLINE_EVEN_ODD_FILL :: @@ -419,7 +419,7 @@ FT_BEGIN_HEADER * @FT_OUTLINE_INCLUDE_STUBS are ignored by the smooth rasterizer. * * There exists a second mechanism to pass the drop-out mode to the B/W - * rasterizer; see the 'tags' field in @FT_Outline. + * 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 drop-outs, @@ -438,7 +438,7 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `FT_OUTLINE_XXX' values instead */ + /* `FT_OUTLINE_XXX` values instead */ #define ft_outline_none FT_OUTLINE_NONE #define ft_outline_owner FT_OUTLINE_OWNER #define ft_outline_even_odd_fill FT_OUTLINE_EVEN_ODD_FILL @@ -451,7 +451,7 @@ FT_BEGIN_HEADER #define FT_CURVE_TAG( flag ) ( flag & 0x03 ) - /* see the `tags' field in `FT_Outline' for a description of the values */ + /* see the `tags` field in `FT_Outline` for a description of the values */ #define FT_CURVE_TAG_ON 0x01 #define FT_CURVE_TAG_CONIC 0x00 #define FT_CURVE_TAG_CUBIC 0x02 @@ -467,7 +467,7 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `FT_CURVE_TAG_XXX' values instead */ + /* `FT_CURVE_TAG_XXX` values instead */ #define FT_Curve_Tag_On FT_CURVE_TAG_ON #define FT_Curve_Tag_Conic FT_CURVE_TAG_CONIC #define FT_Curve_Tag_Cubic FT_CURVE_TAG_CUBIC @@ -548,7 +548,7 @@ FT_BEGIN_HEADER * @input: * control :: * An intermediate control point between the last position and the new - * target in 'to'. + * target in `to`. * * to :: * A pointer to the target end point of the conic arc. @@ -645,7 +645,7 @@ FT_BEGIN_HEADER * y' = (y << shift) - delta * ``` * - * Set the values of 'shift' and 'delta' to~0 to get the original point + * Set the values of `shift` and `delta` to~0 to get the original point * coordinates. */ typedef struct FT_Outline_Funcs_ @@ -718,13 +718,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 the + * 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 @FT_GlyphSlotRec structure + * want to access the `outline` field of the @FT_GlyphSlotRec structure * to read it. * * FT_GLYPH_FORMAT_PLOTTER :: @@ -746,7 +746,7 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `FT_Glyph_Format' values instead. */ + /* `FT_Glyph_Format` values instead. */ #define ft_glyph_format_none FT_GLYPH_FORMAT_NONE #define ft_glyph_format_composite FT_GLYPH_FORMAT_COMPOSITE #define ft_glyph_format_bitmap FT_GLYPH_FORMAT_BITMAP @@ -875,7 +875,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. @@ -930,7 +930,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: @@ -965,7 +965,7 @@ FT_BEGIN_HEADER #define FT_RASTER_FLAG_CLIP 0x4 /* these constants are deprecated; use the corresponding */ - /* `FT_RASTER_FLAG_XXX' values instead */ + /* `FT_RASTER_FLAG_XXX` values instead */ #define ft_raster_flag_default FT_RASTER_FLAG_DEFAULT #define ft_raster_flag_aa FT_RASTER_FLAG_AA #define ft_raster_flag_direct FT_RASTER_FLAG_DIRECT @@ -1012,10 +1012,10 @@ 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 bitmap is + * 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 + * 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. @@ -1056,7 +1056,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 completely ignored by a @@ -1180,12 +1180,6 @@ FT_BEGIN_HEADER * Note also that the render function can fail and return a * `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' for - * examples of distinct implementations that support direct - * composition). */ typedef int (*FT_Raster_RenderFunc)( FT_Raster raster, diff --git a/include/freetype/ftincrem.h b/include/freetype/ftincrem.h index b1ad44ce0..4e075cea6 100644 --- a/include/freetype/ftincrem.h +++ b/include/freetype/ftincrem.h @@ -110,7 +110,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. * */ @@ -148,7 +148,7 @@ FT_BEGIN_HEADER * * Note that the format of the glyph's data bytes depends on the font * file format. For TrueType, it must correspond to the raw bytes within - * the 'glyf' table. For PostScript formats, it must correspond to the + * the `glyf` table. For PostScript formats, it must correspond to the * **unencrypted** charstring bytes, without any `lenIV` header. It is * undefined for any other format. * diff --git a/include/freetype/ftlcdfil.h b/include/freetype/ftlcdfil.h index 95e7347ba..94e35d0e2 100644 --- a/include/freetype/ftlcdfil.h +++ b/include/freetype/ftlcdfil.h @@ -45,9 +45,9 @@ FT_BEGIN_HEADER * API to control subpixel rendering. * * @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. + * FreeType provides two alternative subpixel rendering technologies. + * Should you define `FT_CONFIG_OPTION_SUBPIXEL_RENDERING` in your + * `ftoption.h` file, 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 @@ -197,14 +197,14 @@ 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 - * 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. + * 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. * * @since: * 2.3.0 @@ -237,9 +237,9 @@ FT_BEGIN_HEADER * @note: * 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. + * 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. * * LCD filter weights can also be set per face using @FT_Face_Properties * with @FT_PARAM_TAG_LCD_FILTER_WEIGHTS. @@ -307,7 +307,7 @@ FT_BEGIN_HEADER * * 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 + * `FT_CONFIG_OPTION_SUBPIXEL_RENDERING` is defined in your build of the * library. * * @since: diff --git a/include/freetype/ftmac.h b/include/freetype/ftmac.h index ae9171ec5..86cd2a7c8 100644 --- a/include/freetype/ftmac.h +++ b/include/freetype/ftmac.h @@ -18,9 +18,9 @@ /**************************************************************************** * - * NOTE: Include this file after FT_FREETYPE_H and after any + * NOTE: Include this file after `FT_FREETYPE_H` and after any * Mac-specific headers (because this header uses Mac types such as - * Handle, FSSpec, FSRef, etc.) + * 'Handle', 'FSSpec', 'FSRef', etc.) * */ @@ -185,7 +185,7 @@ FT_BEGIN_HEADER * The client must allocate this 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 7a47a50fa..0584ce6df 100644 --- a/include/freetype/ftmm.h +++ b/include/freetype/ftmm.h @@ -144,12 +144,12 @@ FT_BEGIN_HEADER * Adobe MM fonts if possible. * * strid :: - * The axis name entry in the font's 'name' table. This is another + * The axis name entry in the font's `name` table. This is another * (and often better) version of the 'name' field for TrueType GX or * OpenType variation fonts. Not meaningful for Adobe MM fonts. * * @note: - * The fields 'minimum', 'def', and 'maximum' are 16.16 fractional values + * 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. */ @@ -184,10 +184,10 @@ FT_BEGIN_HEADER * entry for each axis. * * strid :: - * The entry in 'name' table identifying this instance. + * The entry in `name` table identifying this instance. * * psid :: - * The entry in 'name' table identifying a PostScript name for this + * The entry in `name` table identifying a PostScript name for this * instance. Value 0xFFFF indicates a missing entry. */ typedef struct FT_Var_Named_Style_ @@ -222,7 +222,7 @@ FT_BEGIN_HEADER * * num_namedstyles :: * The number of named styles; a 'named style' is a tuple of design - * coordinates that has a string ID (in the 'name' table) associated + * coordinates that has a string ID (in the `name` table) associated * with it. The font can tell the user that, for example, * [Weight=1.5,Width=1.1] is 'Bold'. Another name for 'named style' is * 'named instance'. @@ -316,7 +316,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'. + * call to @FT_Get_MM_Var to create `amaster`. * * @return: * FreeType error code. 0~means success. @@ -356,7 +356,7 @@ 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 @@ -397,7 +397,7 @@ 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] 'Default values' means the currently selected named * instance (or the base font if no named instance is selected). * @@ -478,7 +478,7 @@ 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] 'Default values' means the currently selected named * instance (or the base font if no named instance is selected). * @@ -588,7 +588,7 @@ FT_BEGIN_HEADER * @description: * 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 :: diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h index 4dd29c31a..c64db75d1 100644 --- a/include/freetype/ftmodapi.h +++ b/include/freetype/ftmodapi.h @@ -352,7 +352,7 @@ 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: @@ -360,7 +360,7 @@ FT_BEGIN_HEADER * * @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 + * 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 @@ -415,7 +415,7 @@ 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 dependent on + * of the property. The exact definition of `value` is dependent on * the property; see section @properties. * * @return: @@ -423,7 +423,7 @@ FT_BEGIN_HEADER * * @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 + * 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'. @@ -462,9 +462,10 @@ FT_BEGIN_HEADER * FT_Set_Default_Properties * * @description: - * If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is set, - * this function reads the `FREETYPE_PROPERTIES` environment variable to - * control driver properties. See section @properties for more. + * If compilation option `FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES` is + * 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. * diff --git a/include/freetype/ftmoderr.h b/include/freetype/ftmoderr.h index e72933ac8..6c57b88b8 100644 --- a/include/freetype/ftmoderr.h +++ b/include/freetype/ftmoderr.h @@ -20,17 +20,17 @@ * * This file is used to define the FreeType module error codes. * - * If the macro FT_CONFIG_OPTION_USE_MODULE_ERRORS in `ftoption.h` is set, - * the lower byte of an error value identifies the error code as usual. In - * addition, the higher byte identifies the module. For example, the error - * `FT_Err_Invalid_File_Format` has value 0x0003, the error - * `TT_Err_Invalid_File_Format` has value 0x1303, the error + * If the macro `FT_CONFIG_OPTION_USE_MODULE_ERRORS` in `ftoption.h` is + * set, the lower byte of an error value identifies the error code as + * usual. In addition, the higher byte identifies the module. For + * example, the error `FT_Err_Invalid_File_Format` has value 0x0003, the + * error `TT_Err_Invalid_File_Format` has value 0x1303, the error * `T1_Err_Invalid_File_Format` has value 0x1403, etc. * * Note that `FT_Err_Ok`, `TT_Err_Ok`, etc. are always equal to zero, * including the high byte. * - * If FT_CONFIG_OPTION_USE_MODULE_ERRORS isn't set, the higher byte of an + * If `FT_CONFIG_OPTION_USE_MODULE_ERRORS` isn't set, the higher byte of an * error value is set to zero. * * To hide the various `XXX_Err_` prefixes in the source code, FreeType @@ -39,32 +39,40 @@ * FT_ERR( err ) * * Add current error module prefix (as defined with the `FT_ERR_PREFIX` - * macro) to 'err'. For example, in the BDF module the line + * macro) to `err`. For example, in the BDF module the line * + * ``` * error = FT_ERR( Invalid_Outline ); + * ``` * * expands to * + * ``` * error = BDF_Err_Invalid_Outline; + * ``` * * For simplicity, you can always use `FT_Err_Ok` directly instead of - * 'FT_ERR( Ok )'. + * `FT_ERR( Ok )`. * * FT_ERR_EQ( errcode, err ) * FT_ERR_NEQ( errcode, err ) * - * Compare error code 'errcode' with the error 'err' for equality and + * Compare error code `errcode` with the error `err` for equality and * inequality, respectively. Example: * + * ``` * if ( FT_ERR_EQ( error, Invalid_Outline ) ) * ... + * ``` * * Using this macro you don't have to think about error prefixes. Of * course, if module errors are not active, the above example is the * same as * + * ``` * if ( error == FT_Err_Invalid_Outline ) * ... + * ``` * * FT_ERROR_BASE( errcode ) * FT_ERROR_MODULE( errcode ) diff --git a/include/freetype/ftoutln.h b/include/freetype/ftoutln.h index 292616c30..8723c4a44 100644 --- a/include/freetype/ftoutln.h +++ b/include/freetype/ftoutln.h @@ -156,7 +156,7 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @note: - * The reason why this function takes a 'library' parameter is simply to + * The reason why this function takes a `library` parameter is simply to * use the library's memory allocator. */ FT_EXPORT( FT_Error ) @@ -333,10 +333,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: @@ -382,8 +382,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. * * @since: @@ -410,7 +410,7 @@ FT_BEGIN_HEADER * * @note: * This function toggles the bit flag @FT_OUTLINE_REVERSE_FILL in the - * outline's 'flags' field. + * outline's `flags` field. * * It shouldn't be used by a normal client application, unless it knows * what it is doing. @@ -443,13 +443,13 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @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. + * 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. * * It will use the raster corresponding to the default glyph format. * - * The value of the `num_grays` field in 'abitmap' is ignored. If you + * 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. */ @@ -488,13 +488,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 + * @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 07960411d..b9ab12820 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 1.4). + * family names in the `name` table (introduced in OpenType version 1.4). * Use this for backward compatibility with legacy systems that have a * four-faces-per-family restriction. * @@ -82,7 +82,7 @@ FT_BEGIN_HEADER * * @description: * A tag for @FT_Parameter to make @FT_Open_Face ignore typographic - * subfamily names in the 'name' table (introduced in OpenType version + * subfamily names in the `name` table (introduced in OpenType version * 1.4). Use this for backward compatibility with legacy systems that * have a four-faces-per-family restriction. * diff --git a/include/freetype/ftrender.h b/include/freetype/ftrender.h index 74e83d014..53ab418e9 100644 --- a/include/freetype/ftrender.h +++ b/include/freetype/ftrender.h @@ -225,7 +225,7 @@ FT_BEGIN_HEADER * * This doesn't change the current renderer for other formats. * - * Currently, no FreeType renderer module uses 'parameters'; you should + * 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 0382c29cb..f4f9361f2 100644 --- a/include/freetype/ftsizes.h +++ b/include/freetype/ftsizes.h @@ -143,7 +143,7 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @note: - * If 'face' is the size's parent face object, this function changes the + * 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 ) diff --git a/include/freetype/ftsnames.h b/include/freetype/ftsnames.h index 4df787e8d..6fe30f44c 100644 --- a/include/freetype/ftsnames.h +++ b/include/freetype/ftsnames.h @@ -2,7 +2,7 @@ * * ftsnames.h * - * Simple interface to access SFNT 'name' tables (which are used + * Simple interface to access SFNT `name` tables (which are used * to hold font names, copyright info, notices, etc.) (specification). * * This is _not_ used to retrieve glyph names! @@ -50,7 +50,7 @@ FT_BEGIN_HEADER * * @description: * The TrueType and OpenType specifications allow the inclusion of a - * special names table ('name') in font files. This table contains + * special names table (`name`) in font files. This table contains * textual (and internationalized) information regarding the font, like * family name, copyright, version, etc. * @@ -67,20 +67,20 @@ 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'. See @TT_PLATFORM_XXX for possible + * The platform ID for `string`. See @TT_PLATFORM_XXX for possible * values. * * encoding_id :: - * The encoding ID for 'string'. See @TT_APPLE_ID_XXX, @TT_MAC_ID_XXX, + * 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'. See @TT_MAC_LANGID_XXX and + * 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 always smaller than @@ -90,7 +90,7 @@ FT_BEGIN_HEADER * retrieve the associated language tag. * * name_id :: - * An identifier for 'string'. See @TT_NAME_ID_XXX for possible + * An identifier for `string`. See @TT_NAME_ID_XXX for possible * values. * * string :: @@ -99,7 +99,7 @@ FT_BEGIN_HEADER * 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 @@ -124,14 +124,14 @@ FT_BEGIN_HEADER * FT_Get_Sfnt_Name_Count * * @description: - * Retrieve the number of name strings in the SFNT 'name' table. + * Retrieve the number of name strings in the SFNT `name` table. * * @input: * face :: * A handle to the source face. * * @return: - * The number of strings in the 'name' table. + * The number of strings in the `name` table. * * @note: * This function always returns an error if the config macro @@ -147,7 +147,7 @@ FT_BEGIN_HEADER * FT_Get_Sfnt_Name * * @description: - * Retrieve a string of the SFNT 'name' table for a given index. + * Retrieve a string of the SFNT `name` table for a given index. * * @input: * face :: @@ -164,15 +164,15 @@ 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' by + * 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 platform, + * `name` table entries, then do a loop until you get the right platform, * encoding, and name ID. * - * 'name' table format~1 entries can use language tags also, see + * `name` table format~1 entries can use language tags also, see * @FT_Get_Sfnt_LangTag. * * This function always returns an error if the config macro @@ -190,7 +190,7 @@ FT_BEGIN_HEADER * FT_SfntLangTag * * @description: - * A structure to model a language tag entry from an SFNT 'name' table. + * A structure to model a language tag entry from an SFNT `name` table. * * @fields: * string :: @@ -198,7 +198,7 @@ FT_BEGIN_HEADER * 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 @@ -222,7 +222,7 @@ FT_BEGIN_HEADER * * @description: * Retrieve the language tag associated with a language ID of an SFNT - * 'name' table entry. + * `name` table entry. * * @input: * face :: @@ -234,18 +234,18 @@ FT_BEGIN_HEADER * * @output: * alangTag :: - * The language tag associated with the 'name' table entry's language + * The language tag associated with the `name` table entry's language * ID. * * @return: * 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' by + * 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. diff --git a/include/freetype/ftstroke.h b/include/freetype/ftstroke.h index a8af02ee2..d328c5ae2 100644 --- a/include/freetype/ftstroke.h +++ b/include/freetype/ftstroke.h @@ -119,7 +119,7 @@ FT_BEGIN_HEADER * the intersection of the segments a distance greater than the product * of the miter limit value and the border radius), then a bevel join * (see above) is used instead. This prevents long spikes being - * created. FT_STROKER_LINEJOIN_MITER_FIXED generates a miter line + * created. `FT_STROKER_LINEJOIN_MITER_FIXED` generates a miter line * join as used in PostScript and PDF. * * FT_STROKER_LINEJOIN_MITER_VARIABLE :: @@ -129,10 +129,10 @@ FT_BEGIN_HEADER * line perpendicular to the bisector of the angle between the strokes, * at the distance from the intersection of the segments equal to the * product of the miter limit value and the border radius. This - * prevents long spikes being created. - * FT_STROKER_LINEJOIN_MITER_VARIABLE generates a mitered line join as - * used in XPS. FT_STROKER_LINEJOIN_MITER is an alias for - * FT_STROKER_LINEJOIN_MITER_VARIABLE, retained for backward + * prevents long spikes being created. + * `FT_STROKER_LINEJOIN_MITER_VARIABLE` generates a mitered line join + * as used in XPS. `FT_STROKER_LINEJOIN_MITER` is an alias for + * `FT_STROKER_LINEJOIN_MITER_VARIABLE`, retained for backward * compatibility. */ typedef enum FT_Stroker_LineJoin_ @@ -296,8 +296,8 @@ FT_BEGIN_HEADER * The line join style. * * miter_limit :: - * The miter limit for the FT_STROKER_LINEJOIN_MITER_FIXED and - * FT_STROKER_LINEJOIN_MITER_VARIABLE line join styles, expressed as + * The miter limit for the `FT_STROKER_LINEJOIN_MITER_FIXED` and + * `FT_STROKER_LINEJOIN_MITER_VARIABLE` line join styles, expressed as * 16.16 fixed-point value. * * @note: @@ -356,10 +356,10 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @note: - * If 'opened' is~0 (the default), the outline is treated as a closed + * 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 + * 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. diff --git a/include/freetype/ftsynth.h b/include/freetype/ftsynth.h index f2e785696..14e93db2f 100644 --- a/include/freetype/ftsynth.h +++ b/include/freetype/ftsynth.h @@ -35,7 +35,7 @@ /* Main reason for not lifting the functions in this module to a */ - /* `standard' API is that the used parameters for emboldening and */ + /* 'standard' API is that the used parameters for emboldening and */ /* slanting are not configurable. Consider the functions as a */ /* code resource that should be copied into the application and */ /* adapted to the particular needs. */ @@ -57,7 +57,7 @@ FT_BEGIN_HEADER - /* Embolden a glyph by a `reasonable' value (which is highly a matter of */ + /* Embolden a glyph by a 'reasonable' value (which is highly a matter of */ /* taste). This function is actually a convenience function, providing */ /* a wrapper for @FT_Outline_Embolden and @FT_Bitmap_Embolden. */ /* */ diff --git a/include/freetype/ftsystem.h b/include/freetype/ftsystem.h index c9a2cb142..d6947f526 100644 --- a/include/freetype/ftsystem.h +++ b/include/freetype/ftsystem.h @@ -71,7 +71,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 :: @@ -206,7 +206,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_ @@ -243,7 +243,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 error. + * a `count` of~0. A non-zero return value then indicates an error. * */ typedef unsigned long @@ -297,7 +297,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 :: @@ -318,7 +318,7 @@ 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. + * 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 2c6020059..23c7a3614 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 `angle2-angle1`. * */ 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 a311b87da..df57986b5 100644 --- a/include/freetype/fttypes.h +++ b/include/freetype/fttypes.h @@ -430,7 +430,7 @@ FT_BEGIN_HEADER * * @input: * The address of the FreeType object that is under finalization. Its - * client data is accessed through its 'generic' field. + * client data is accessed through its `generic` field. */ typedef void (*FT_Generic_Finalizer)( void* object ); @@ -445,14 +445,14 @@ 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 FT_Generic, + * 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 * 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). + * the `finalizer` field). * * @fields: * data :: @@ -594,7 +594,7 @@ FT_BEGIN_HEADER #define FT_ERR_XCAT( x, y ) x ## y #define FT_ERR_CAT( x, y ) FT_ERR_XCAT( x, y ) - /* see `ftmoderr.h' for descriptions of the following macros */ + /* see `ftmoderr.h` for descriptions of the following macros */ #define FT_ERR( e ) FT_ERR_CAT( FT_ERR_PREFIX, e ) diff --git a/include/freetype/ftwinfnt.h b/include/freetype/ftwinfnt.h index ac03a3cc6..1e2c7e287 100644 --- a/include/freetype/ftwinfnt.h +++ b/include/freetype/ftwinfnt.h @@ -56,11 +56,11 @@ FT_BEGIN_HEADER * FT_WinFNT_ID_XXX * * @description: - * 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 subdirectory. cp1361 is roughly a - * superset of MAPPINGS/OBSOLETE/EASTASIA/KSC/JOHAB.TXT. + * 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` subdirectory. 'cp1361' is roughly a + * superset of `MAPPINGS/OBSOLETE/EASTASIA/KSC/JOHAB.TXT`. * * @values: * FT_WinFNT_ID_DEFAULT :: @@ -79,18 +79,18 @@ FT_BEGIN_HEADER * FT_WinFNT_ID_OEM :: * From Michael Poettgen : * - * The 'Windows Font Mapping' article says that FT_WinFNT_ID_OEM is + * 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 Development * Kit' says: This font supports an OEM-specific character set. The * OEM character set is system dependent. * - * In general OEM, as opposed to ANSI (i.e., cp1252), denotes the + * In general OEM, as opposed to ANSI (i.e., 'cp1252'), denotes the * second default codepage that most international versions of Windows * have. It is one of the OEM codepages from * diff --git a/include/freetype/t1tables.h b/include/freetype/t1tables.h index 08c4a5003..dbbf8cea7 100644 --- a/include/freetype/t1tables.h +++ b/include/freetype/t1tables.h @@ -250,7 +250,7 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `T1_Blend_Flags' values instead */ + /* `T1_Blend_Flags` values instead */ #define t1_blend_underline_position T1_BLEND_UNDERLINE_POSITION #define t1_blend_underline_thickness T1_BLEND_UNDERLINE_THICKNESS #define t1_blend_italic_angle T1_BLEND_ITALIC_ANGLE @@ -730,20 +730,20 @@ FT_BEGIN_HEADER * '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. * - * PS_DICT_BLUE_SCALE returns a value that is scaled up by 1000. To get - * the value as in the font stream, you need to divide by 65536000.0 (to - * remove the FT_Fixed scale, and the x1000 scale). + * `PS_DICT_BLUE_SCALE` returns a value that is scaled up by 1000. To + * get the value as in the font stream, you need to divide by 65536000.0 + * (to remove the FT_Fixed scale, and the x1000 scale). * * IMPORTANT: Only key/value pairs read by the FreeType interpreter can * be retrieved. So, for example, PostScript procedures such as NP, ND, diff --git a/include/freetype/ttnameid.h b/include/freetype/ttnameid.h index 15111400f..27e1a1b00 100644 --- a/include/freetype/ttnameid.h +++ b/include/freetype/ttnameid.h @@ -36,7 +36,7 @@ FT_BEGIN_HEADER /************************************************************************** * * Possible values for the 'platform' identifier code in the name records - * of an SFNT 'name' table. + * of an SFNT `name` table. * */ @@ -73,7 +73,7 @@ FT_BEGIN_HEADER * Used by Microsoft to indicate Windows-specific charmaps. See * @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). + * (`TT_PLATFORM_MICROSOFT`, @TT_MS_ID_UNICODE_CS). * * TT_PLATFORM_CUSTOM :: * Used to indicate application-specific charmaps. @@ -291,7 +291,7 @@ FT_BEGIN_HEADER * * @description: * Possible values of the language identifier field in the name records - * of the SFNT 'name' table if the 'platform' identifier code is + * of the SFNT `name` table if the 'platform' identifier code is * @TT_PLATFORM_MACINTOSH. These values are also used as return values * for function @FT_Get_CMap_Language_ID. * @@ -431,7 +431,7 @@ FT_BEGIN_HEADER * * @description: * Possible values of the language identifier field in the name records - * of the SFNT 'name' table if the 'platform' identifier code is + * of the SFNT `name` table if the 'platform' identifier code is * @TT_PLATFORM_MICROSOFT. These values are also used as return values * for function @FT_Get_CMap_Language_ID. * @@ -441,7 +441,7 @@ FT_BEGIN_HEADER * * however, we only provide macros for language identifiers present in * the OpenType specification: Microsoft has abandoned the concept of - * LCIDs (language code identifiers), and format~1 of the 'name' table + * LCIDs (language code identifiers), and format~1 of the `name` table * provides a better mechanism for languages not covered here. * * More legacy values not listed in the reference can be found in the @@ -787,7 +787,7 @@ FT_BEGIN_HEADER * * @description: * Possible values of the 'name' identifier field in the name records of - * an SFNT 'name' table. These values are platform independent. + * an SFNT `name` table. These values are platform independent. */ #define TT_NAME_ID_COPYRIGHT 0 @@ -841,7 +841,7 @@ FT_BEGIN_HEADER * * @description: * Possible bit mask values for the `ulUnicodeRangeX` fields in an SFNT - * 'OS/2' table. + * `OS/2` table. */ /* ulUnicodeRange1 */ diff --git a/include/freetype/tttables.h b/include/freetype/tttables.h index cbb17def7..30d5b71c8 100644 --- a/include/freetype/tttables.h +++ b/include/freetype/tttables.h @@ -115,8 +115,8 @@ FT_BEGIN_HEADER * TT_HoriHeader * * @description: - * A structure to model a TrueType horizontal header, the 'hhea' table, - * as well as the corresponding horizontal metrics table, 'hmtx'. + * A structure to model a TrueType horizontal header, the `hhea` table, + * as well as the corresponding horizontal metrics table, `hmtx`. * * @fields: * Version :: @@ -130,7 +130,7 @@ FT_BEGIN_HEADER * font designer, and often reflects only a portion of the glyphs found * in the font (maybe ASCII). * - * You should use the `sTypoAscender` field of the 'OS/2' table instead + * You should use the `sTypoAscender` field of the `OS/2` table instead * if you want the correct one. * * Descender :: @@ -141,7 +141,7 @@ FT_BEGIN_HEADER * font designer, and often reflects only a portion of the glyphs found * in the font (maybe ASCII). * - * You should use the `sTypoDescender` field of the 'OS/2' table + * You should use the `sTypoDescender` field of the `OS/2` table * instead if you want the correct one. * * Line_Gap :: @@ -181,19 +181,19 @@ FT_BEGIN_HEADER * Always~0. * * number_Of_HMetrics :: - * Number of HMetrics entries in the 'hmtx' table -- this value can be + * Number of HMetrics entries in the `hmtx` table -- this value can be * smaller than the total number of glyphs in the font. * * long_metrics :: - * A pointer into the 'hmtx' table. + * A pointer into the `hmtx` table. * * short_metrics :: - * A pointer into the 'hmtx' table. + * A pointer into the `hmtx` table. * * @note: * For an OpenType variation font, the values of the following fields can * change after a call to @FT_Set_Var_Design_Coordinates (and friends) if - * the font contains an 'MVAR' table: `caret_Slope_Rise`, + * the font contains an `MVAR` table: `caret_Slope_Rise`, * `caret_Slope_Run`, and `caret_Offset`. */ typedef struct TT_HoriHeader_ @@ -219,7 +219,7 @@ FT_BEGIN_HEADER /* The following fields are not defined by the OpenType specification */ /* but they are used to connect the metrics header to the relevant */ - /* `hmtx' table. */ + /* `hmtx` table. */ void* long_metrics; void* short_metrics; @@ -233,8 +233,8 @@ FT_BEGIN_HEADER * TT_VertHeader * * @description: - * A structure used to model a TrueType vertical header, the 'vhea' - * table, as well as the corresponding vertical metrics table, 'vmtx'. + * A structure used to model a TrueType vertical header, the `vhea` + * table, as well as the corresponding vertical metrics table, `vmtx`. * * @fields: * Version :: @@ -248,7 +248,7 @@ FT_BEGIN_HEADER * font designer, and often reflects only a portion of the glyphs found * in the font (maybe ASCII). * - * You should use the `sTypoAscender` field of the 'OS/2' table instead + * You should use the `sTypoAscender` field of the `OS/2` table instead * if you want the correct one. * * Descender :: @@ -259,7 +259,7 @@ FT_BEGIN_HEADER * font designer, and often reflects only a portion of the glyphs found * in the font (maybe ASCII). * - * You should use the `sTypoDescender` field of the 'OS/2' table + * You should use the `sTypoDescender` field of the `OS/2` table * instead if you want the correct one. * * Line_Gap :: @@ -299,19 +299,19 @@ FT_BEGIN_HEADER * Always~0. * * number_Of_VMetrics :: - * Number of VMetrics entries in the 'vmtx' table -- this value can be + * Number of VMetrics entries in the `vmtx` table -- this value can be * smaller than the total number of glyphs in the font. * * long_metrics :: - * A pointer into the 'vmtx' table. + * A pointer into the `vmtx` table. * * short_metrics :: - * A pointer into the 'vmtx' table. + * A pointer into the `vmtx` table. * * @note: * For an OpenType variation font, the values of the following fields can * change after a call to @FT_Set_Var_Design_Coordinates (and friends) if - * the font contains an 'MVAR' table: 'Ascender', 'Descender', + * the font contains an `MVAR` table: `Ascender`, `Descender`, * `Line_Gap`, `caret_Slope_Rise`, `caret_Slope_Run`, and `caret_Offset`. */ typedef struct TT_VertHeader_ @@ -337,7 +337,7 @@ FT_BEGIN_HEADER /* The following fields are not defined by the OpenType specification */ /* but they are used to connect the metrics header to the relevant */ - /* `vmtx' table. */ + /* `vmtx` table. */ void* long_metrics; void* short_metrics; @@ -351,16 +351,16 @@ FT_BEGIN_HEADER * TT_OS2 * * @description: - * A structure to model a TrueType 'OS/2' table. All fields comply to + * A structure to model a TrueType `OS/2` table. All fields comply to * the OpenType specification. * - * Note that we now support old Mac fonts that do not include an 'OS/2' - * table. In this case, the 'version' field is always set to 0xFFFF. + * Note that we now support old Mac fonts that do not include an `OS/2` + * table. In this case, the `version` field is always set to 0xFFFF. * * @note: * For an OpenType variation font, the values of the following fields can * change after a call to @FT_Set_Var_Design_Coordinates (and friends) if - * the font contains an 'MVAR' table: `sCapHeight`, `sTypoAscender`, + * the font contains an `MVAR` table: `sCapHeight`, `sTypoAscender`, * `sTypoDescender`, `sTypoLineGap`, `sxHeight`, `usWinAscent`, * `usWinDescent`, `yStrikeoutPosition`, `yStrikeoutSize`, * `ySubscriptXOffset`, `ySubScriptXSize`, `ySubscriptYOffset`, @@ -435,7 +435,7 @@ FT_BEGIN_HEADER * TT_Postscript * * @description: - * A structure to model a TrueType 'post' table. All fields comply to + * A structure to model a TrueType `post` table. All fields comply to * the OpenType specification. This structure does not reference a * font's PostScript glyph names; use @FT_Get_Glyph_Name to retrieve * them. @@ -443,7 +443,7 @@ FT_BEGIN_HEADER * @note: * For an OpenType variation font, the values of the following fields can * change after a call to @FT_Set_Var_Design_Coordinates (and friends) if - * the font contains an 'MVAR' table: `underlinePosition` and + * the font contains an `MVAR` table: `underlinePosition` and * `underlineThickness`. */ typedef struct TT_Postscript_ @@ -458,7 +458,7 @@ FT_BEGIN_HEADER FT_ULong minMemType1; FT_ULong maxMemType1; - /* Glyph names follow in the `post' table, but we don't */ + /* Glyph names follow in the `post` table, but we don't */ /* load them by default. */ } TT_Postscript; @@ -470,7 +470,7 @@ FT_BEGIN_HEADER * TT_PCLT * * @description: - * A structure to model a TrueType 'PCLT' table. All fields comply to + * A structure to model a TrueType `PCLT` table. All fields comply to * the OpenType specification. */ typedef struct TT_PCLT_ @@ -500,7 +500,7 @@ FT_BEGIN_HEADER * TT_MaxProfile * * @description: - * The maximum profile ('maxp') table contains many max values, which can + * The maximum profile (`maxp`) table contains many max values, which can * be used to pre-allocate arrays for speeding up glyph loading and * hinting. * @@ -630,7 +630,7 @@ FT_BEGIN_HEADER } FT_Sfnt_Tag; - /* these constants are deprecated; use the corresponding `FT_Sfnt_Tag' */ + /* these constants are deprecated; use the corresponding `FT_Sfnt_Tag` */ /* values instead */ #define ft_sfnt_head FT_SFNT_HEAD #define ft_sfnt_maxp FT_SFNT_MAXP @@ -661,7 +661,7 @@ FT_BEGIN_HEADER * or if the corresponding table was not found **OR** loaded from the * file. * - * Use a typecast according to 'tag' to access the structure elements. + * Use a typecast according to `tag` to access the structure elements. * * @note: * The table is owned by the face object and disappears with it. @@ -671,7 +671,7 @@ FT_BEGIN_HEADER * list. * * @example: - * Here an example how to access the 'vhea' table. + * Here an example how to access the `vhea` table. * * ``` * TT_VertHeader* vert_header; @@ -714,10 +714,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 @@ -728,7 +728,7 @@ 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; @@ -777,13 +777,13 @@ 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 + * 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'). + * depending on `tag`). * * @return: * FreeType error code. 0~means success. @@ -814,7 +814,7 @@ FT_BEGIN_HEADER * The target charmap. * * @return: - * The language ID of 'charmap'. If 'charmap' doesn't belong to an SFNT + * 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 @@ -830,14 +830,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 face, + * The format of `charmap`. If `charmap` doesn't belong to an SFNT face, * return -1. */ FT_EXPORT( FT_Long )