From 1ad07c1c79841e54ff3d5c37e28bfb91f402ee84 Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Thu, 21 Sep 2017 14:56:58 +0200 Subject: [PATCH] Add some `since' fields (back to version 2.4.8). --- include/freetype/freetype.h | 92 ++++++++++++++++++++----------------- include/freetype/ftautoh.h | 25 ++++++++++ include/freetype/ftcffdrv.h | 19 ++++++++ include/freetype/ftgzip.h | 3 ++ include/freetype/ftimage.h | 14 +++--- include/freetype/ftlcdfil.h | 6 +++ include/freetype/ftmm.h | 12 +++++ include/freetype/ftmodapi.h | 3 ++ include/freetype/ftpcfdrv.h | 2 + include/freetype/ftsnames.h | 12 +++++ include/freetype/ftttdrv.h | 3 ++ include/freetype/t1tables.h | 9 ++++ 12 files changed, 152 insertions(+), 48 deletions(-) diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h index b0c261799..de4dc3982 100644 --- a/include/freetype/freetype.h +++ b/include/freetype/freetype.h @@ -888,15 +888,15 @@ FT_BEGIN_HEADER /* are set to~0 if there is only one face in */ /* the font file. */ /* */ - /* Bits 16-30 are relevant to GX and OpenType */ - /* variation fonts only, holding the named */ - /* instance index for the current face index */ - /* (starting with value~1; value~0 indicates */ - /* font access without a named instance). For */ - /* non-variation fonts, bits 16-30 are */ - /* ignored. If we have the third named */ - /* instance of face~4, say, `face_index' is */ - /* set to 0x00030004. */ + /* [Since 2.6.1] Bits 16-30 are relevant to GX */ + /* and OpenType variation fonts only, holding */ + /* the named instance index for the current */ + /* face index (starting with value~1; value~0 */ + /* indicates font access without a named */ + /* instance). For non-variation fonts, bits */ + /* 16-30 are ignored. If we have the third */ + /* named instance of face~4, say, `face_index' */ + /* is set to 0x00030004. */ /* */ /* Bit 31 is always zero (this is, */ /* `face_index' is always a positive value). */ @@ -907,15 +907,16 @@ FT_BEGIN_HEADER /* */ /* style_flags :: The lower 16~bits contain a set of bit */ /* flags indicating the style of the face; see */ - /* @FT_STYLE_FLAG_XXX for the details. Bits */ - /* 16-30 hold the number of named instances */ - /* available for the current face if we have a */ - /* GX or OpenType variation (sub)font. Bit 31 */ - /* is always zero (this is, `style_flags' is */ - /* always a positive value). Note that a */ - /* variation font has always at least one */ - /* named instance, namely the default */ - /* instance. */ + /* @FT_STYLE_FLAG_XXX for the details. */ + /* */ + /* [Since 2.6.1] Bits 16-30 hold the number */ + /* of named instances available for the */ + /* current face if we have a GX or OpenType */ + /* variation (sub)font. Bit 31 is always zero */ + /* (this is, `style_flags' is always a */ + /* positive value). Note that a variation */ + /* font has always at least one named */ + /* instance, namely the default instance. */ /* */ /* num_glyphs :: The number of glyphs in the face. If the */ /* face is scalable and has sbits (see */ @@ -1212,8 +1213,8 @@ FT_BEGIN_HEADER /* tricky fonts; they are hard-coded in file `ttobjs.c'. */ /* */ /* FT_FACE_FLAG_COLOR :: */ - /* The face has color glyph tables. To access color glyphs use */ - /* @FT_LOAD_COLOR. */ + /* [Since 2.5.1] The face has color glyph tables. To access color */ + /* glyphs use @FT_LOAD_COLOR. */ /* */ #define FT_FACE_FLAG_SCALABLE ( 1L << 0 ) #define FT_FACE_FLAG_FIXED_SIZES ( 1L << 1 ) @@ -1391,6 +1392,9 @@ FT_BEGIN_HEADER * A macro that returns true whenever a face object is a named instance * of a GX or OpenType variation font. * + * @since: + * 2.7 + * */ #define FT_IS_NAMED_INSTANCE( face ) \ ( (face)->face_index & 0x7FFF0000L ) @@ -1437,6 +1441,9 @@ FT_BEGIN_HEADER * A macro that returns true whenever a face object contains * tables for color glyphs. * + * @since: + * 2.5.1 + * */ #define FT_HAS_COLOR( face ) \ ( (face)->face_flags & FT_FACE_FLAG_COLOR ) @@ -2155,14 +2162,14 @@ FT_BEGIN_HEADER /* with value~0). Set it to~0 if there is only one */ /* face in the font file. */ /* */ - /* Bits 16-30 are relevant to GX and OpenType variation */ - /* fonts only, specifying the named instance index for */ - /* the current face index (starting with value~1; */ - /* value~0 makes FreeType ignore named instances). For */ - /* non-variation fonts, bits 16-30 are ignored. */ - /* Assuming that you want to access the third named */ - /* instance in face~4, `face_index' should be set to */ - /* 0x00030004. If you want to access face~4 without */ + /* [Since 2.6.1] Bits 16-30 are relevant to GX and */ + /* OpenType variation fonts only, specifying the named */ + /* instance index for the current face index (starting */ + /* with value~1; value~0 makes FreeType ignore named */ + /* instances). For non-variation fonts, bits 16-30 are */ + /* ignored. Assuming that you want to access the third */ + /* named instance in face~4, `face_index' should be set */ + /* to 0x00030004. If you want to access face~4 without */ /* variation handling, simply set `face_index' to */ /* value~4. */ /* */ @@ -2869,26 +2876,26 @@ FT_BEGIN_HEADER * Disable the auto-hinter. See also the note below. * * FT_LOAD_COLOR :: - * Load embedded color bitmap images. The resulting color bitmaps, - * if available, will have the @FT_PIXEL_MODE_BGRA format. If the - * flag is not set and color bitmaps are found, they are converted - * to 256-level gray bitmaps transparently, using the + * [Since 2.5] Load embedded color bitmap images. The resulting color + * bitmaps, if available, will have the @FT_PIXEL_MODE_BGRA format. + * If the flag is not set and color bitmaps are found, they are + * converted to 256-level gray bitmaps transparently, using the * @FT_PIXEL_MODE_GRAY format. * * FT_LOAD_COMPUTE_METRICS :: - * Compute glyph metrics from the glyph data, without the use of - * bundled metrics tables (for example, the `hdmx' table in TrueType - * fonts). This flag is mainly used by font validating or font - * editing applications, which need to ignore, verify, or edit those - * tables. + * [Since 2.6.1] Compute glyph metrics from the glyph data, without + * the use of bundled metrics tables (for example, the `hdmx' table in + * TrueType fonts). This flag is mainly used by font validating or + * font editing applications, which need to ignore, verify, or edit + * those tables. * * Currently, this flag is only implemented for TrueType fonts. * * FT_LOAD_BITMAP_METRICS_ONLY :: - * Request loading of the metrics and bitmap image information of a - * (possibly embedded) bitmap glyph without allocating or copying - * the bitmap image data itself. No effect if the target glyph is - * not a bitmap image. + * [Since 2.7.1] Request loading of the metrics and bitmap image + * information of a (possibly embedded) bitmap glyph without + * allocating or copying the bitmap image data itself. No effect if + * the target glyph is not a bitmap image. * * This flag unsets @FT_LOAD_RENDER. * @@ -3775,6 +3782,9 @@ FT_BEGIN_HEADER * FT_Face_Properties( face, 1, &property ); * } * + * @since: + * 2.8 + * */ FT_EXPORT( FT_Error ) FT_Face_Properties( FT_Face face, diff --git a/include/freetype/ftautoh.h b/include/freetype/ftautoh.h index 2bb675ae4..60fadea4b 100644 --- a/include/freetype/ftautoh.h +++ b/include/freetype/ftautoh.h @@ -106,6 +106,9 @@ FT_BEGIN_HEADER * FT_Load_Glyph( face, ..., FT_LOAD_FORCE_AUTOHINT ); * } * + * @since: + * 2.4.11 + * */ @@ -227,6 +230,9 @@ FT_BEGIN_HEADER * Note that currently Indic support is rudimentary only, missing blue * zone support. * + * @since: + * 2.4.11 + * */ #define FT_AUTOHINTER_SCRIPT_NONE 0 #define FT_AUTOHINTER_SCRIPT_LATIN 1 @@ -244,6 +250,9 @@ FT_BEGIN_HEADER * * The data exchange structure for the @glyph-to-script-map property. * + * @since: + * 2.4.11 + * */ typedef struct FT_Prop_GlyphToScriptMap_ { @@ -289,6 +298,9 @@ FT_BEGIN_HEADER * an @FT_Face structure but not loaded any glyph (using the * auto-hinter), a change of the fallback script will affect this face. * + * @since: + * 2.4.11 + * */ @@ -372,6 +384,9 @@ FT_BEGIN_HEADER * Set this value right after calling @FT_Set_Char_Size, but before * loading any glyph (using the auto-hinter). * + * @since: + * 2.4.11 + * */ @@ -480,6 +495,9 @@ FT_BEGIN_HEADER * variable similar to the CFF driver. It can also be set per face * using @FT_Face_Properties with @FT_PARAM_TAG_STEM_DARKENING. * + * @since: + * 2.6.2 + * */ @@ -499,6 +517,9 @@ FT_BEGIN_HEADER * or autohinter honors it, which the CFF driver always does, but the * autohinter only in `light' hinting mode (as of version 2.7.0). * + * @since: + * 2.8 + * */ #define FT_PARAM_TAG_STEM_DARKENING \ FT_MAKE_TAG( 'd', 'a', 'r', 'k' ) @@ -519,6 +540,10 @@ FT_BEGIN_HEADER * * This property can be set via the `FREETYPE_PROPERTIES' environment * variable similar to the CFF driver. + * + * @since: + * 2.6.2 + * */ diff --git a/include/freetype/ftcffdrv.h b/include/freetype/ftcffdrv.h index 477b6ddb1..f1e9452bf 100644 --- a/include/freetype/ftcffdrv.h +++ b/include/freetype/ftcffdrv.h @@ -151,6 +151,9 @@ FT_BEGIN_HEADER * * This property can be set via the `FREETYPE_PROPERTIES' environment * variable (using values `adobe' or `freetype'). + * + * @since: + * 2.4.12 */ @@ -170,6 +173,9 @@ FT_BEGIN_HEADER * FT_CFF_HINTING_ADOBE :: * Use the hinting engine contributed by Adobe. * + * @since: + * 2.4.12 + * */ #define FT_CFF_HINTING_FREETYPE 0 #define FT_CFF_HINTING_ADOBE 1 @@ -207,6 +213,9 @@ FT_BEGIN_HEADER * It can also be set per face using @FT_Face_Properties with * @FT_PARAM_TAG_STEM_DARKENING. * + * @since: + * 2.4.12 + * */ @@ -264,6 +273,10 @@ FT_BEGIN_HEADER * FREETYPE_PROPERTIES=\ * cff:darkening-parameters=500,300,1000,200,1500,100,2000,0 * } + * + * @since: + * 2.5.1 + * */ @@ -290,6 +303,9 @@ FT_BEGIN_HEADER * variable. It can also be set per face using @FT_Face_Properties with * @FT_PARAM_TAG_RANDOM_SEED. * + * @since: + * 2.8 + * */ @@ -304,6 +320,9 @@ FT_BEGIN_HEADER * module's random seed value with a face-specific one; see * @random-seed. * + * @since: + * 2.8 + * */ #define FT_PARAM_TAG_RANDOM_SEED \ FT_MAKE_TAG( 's', 'e', 'e', 'd' ) diff --git a/include/freetype/ftgzip.h b/include/freetype/ftgzip.h index bd5ceaab9..ba5482768 100644 --- a/include/freetype/ftgzip.h +++ b/include/freetype/ftgzip.h @@ -129,6 +129,9 @@ FT_BEGIN_HEADER * @note: * This function may return `FT_Err_Unimplemented_Feature' if your build * of FreeType was not compiled with zlib support. + * + * @since: + * 2.5.1 */ FT_EXPORT( FT_Error ) FT_Gzip_Uncompress( FT_Memory memory, diff --git a/include/freetype/ftimage.h b/include/freetype/ftimage.h index 1c789e5a4..968460895 100644 --- a/include/freetype/ftimage.h +++ b/include/freetype/ftimage.h @@ -169,13 +169,13 @@ FT_BEGIN_HEADER /* @FT_RENDER_MODE_LCD_V. */ /* */ /* FT_PIXEL_MODE_BGRA :: */ - /* An image with four 8-bit channels per pixel, representing a */ - /* color image (such as emoticons) with alpha channel. For each */ - /* pixel, the format is BGRA, which means, the blue channel comes */ - /* first in memory. The color channels are pre-multiplied and in */ - /* the sRGB colorspace. For example, full red at half-translucent */ - /* opacity will be represented as `00,00,80,80', not `00,00,FF,80'. */ - /* See also @FT_LOAD_COLOR. */ + /* [Since 2.5] An image with four 8-bit channels per pixel, */ + /* representing a color image (such as emoticons) with alpha */ + /* channel. For each pixel, the format is BGRA, which means, the */ + /* blue channel comes first in memory. The color channels are */ + /* pre-multiplied and in the sRGB colorspace. For example, full */ + /* red at half-translucent opacity will be represented as */ + /* `00,00,80,80', not `00,00,FF,80'. See also @FT_LOAD_COLOR. */ /* */ typedef enum FT_Pixel_Mode_ { diff --git a/include/freetype/ftlcdfil.h b/include/freetype/ftlcdfil.h index bdaf9af90..ea4a66e69 100644 --- a/include/freetype/ftlcdfil.h +++ b/include/freetype/ftlcdfil.h @@ -292,6 +292,9 @@ FT_BEGIN_HEADER * the global default values or the values set up with * @FT_Library_SetLcdFilterWeights. * + * @since: + * 2.8 + * */ #define FT_PARAM_TAG_LCD_FILTER_WEIGHTS \ FT_MAKE_TAG( 'l', 'c', 'd', 'f' ) @@ -305,6 +308,9 @@ FT_BEGIN_HEADER * A typedef for passing the five LCD filter weights to * @FT_Face_Properties within an @FT_Parameter structure. * + * @since: + * 2.8 + * */ #define FT_LCD_FILTER_FIVE_TAPS 5 diff --git a/include/freetype/ftmm.h b/include/freetype/ftmm.h index 80ac98d61..c08119933 100644 --- a/include/freetype/ftmm.h +++ b/include/freetype/ftmm.h @@ -392,6 +392,9 @@ FT_BEGIN_HEADER /* */ /* FreeType error code. 0~means success. */ /* */ + /* */ + /* 2.7.1 */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Var_Design_Coordinates( FT_Face face, FT_UInt num_coords, @@ -462,6 +465,9 @@ FT_BEGIN_HEADER /* */ /* FreeType error code. 0~means success. */ /* */ + /* */ + /* 2.7.1 */ + /* */ FT_EXPORT( FT_Error ) FT_Get_MM_Blend_Coordinates( FT_Face face, FT_UInt num_coords, @@ -490,6 +496,9 @@ FT_BEGIN_HEADER /* */ /* This is another name of @FT_Get_MM_Blend_Coordinates. */ /* */ + /* */ + /* 2.7.1 */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Var_Blend_Coordinates( FT_Face face, FT_UInt num_coords, @@ -534,6 +543,9 @@ FT_BEGIN_HEADER /* */ /* FreeType error code. 0~means success. */ /* */ + /* */ + /* 2.8.1 */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Var_Axis_Flags( FT_MM_Var* master, FT_UInt axis_index, diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h index 4147aadf8..9c901329a 100644 --- a/include/freetype/ftmodapi.h +++ b/include/freetype/ftmodapi.h @@ -475,6 +475,9 @@ FT_BEGIN_HEADER /* */ /* library :: A handle to a new library object. */ /* */ + /* */ + /* 2.8 */ + /* */ FT_EXPORT( void ) FT_Set_Default_Properties( FT_Library library ); diff --git a/include/freetype/ftpcfdrv.h b/include/freetype/ftpcfdrv.h index 6622c936f..c9d5cedec 100644 --- a/include/freetype/ftpcfdrv.h +++ b/include/freetype/ftpcfdrv.h @@ -93,6 +93,8 @@ FT_BEGIN_HEADER * This property can be set via the `FREETYPE_PROPERTIES' environment * variable (using values 1 and 0 for `on' and `off', respectively). * + * @since: + * 2.8 */ diff --git a/include/freetype/ftsnames.h b/include/freetype/ftsnames.h index a31654057..d524ad74c 100644 --- a/include/freetype/ftsnames.h +++ b/include/freetype/ftsnames.h @@ -189,6 +189,9 @@ FT_BEGIN_HEADER /* Please refer to the TrueType or OpenType specification for more */ /* details. */ /* */ + /* */ + /* 2.8 */ + /* */ typedef struct FT_SfntLangTag_ { FT_Byte* string; /* this string is *not* null-terminated! */ @@ -229,6 +232,9 @@ FT_BEGIN_HEADER /* invalid format~1 language ID values, FT_Err_Invalid_Argument is */ /* returned. */ /* */ + /* */ + /* 2.8 */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Sfnt_LangTag( FT_Face face, FT_UInt langID, @@ -246,6 +252,9 @@ FT_BEGIN_HEADER * 1.4). Use this for backward compatibility with legacy systems that * have a four-faces-per-family restriction. * + * @since: + * 2.8 + * */ #define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY \ FT_MAKE_TAG( 'i', 'g', 'p', 'f' ) @@ -267,6 +276,9 @@ FT_BEGIN_HEADER * 1.4). Use this for backward compatibility with legacy systems that * have a four-faces-per-family restriction. * + * @since: + * 2.8 + * */ #define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY \ FT_MAKE_TAG( 'i', 'g', 'p', 's' ) diff --git a/include/freetype/ftttdrv.h b/include/freetype/ftttdrv.h index 26bc5e966..381eee7e6 100644 --- a/include/freetype/ftttdrv.h +++ b/include/freetype/ftttdrv.h @@ -182,6 +182,9 @@ FT_BEGIN_HEADER * * This property can be set via the `FREETYPE_PROPERTIES' environment * variable (using values `35', `38', or `40'). + * + * @since: + * 2.5 */ diff --git a/include/freetype/t1tables.h b/include/freetype/t1tables.h index 3f6b36e10..940b4a06b 100644 --- a/include/freetype/t1tables.h +++ b/include/freetype/t1tables.h @@ -554,6 +554,9 @@ FT_BEGIN_HEADER /* T1_ENCODING_TYPE_ISOLATIN1 :: */ /* T1_ENCODING_TYPE_EXPERT :: */ /* */ + /* */ + /* 2.4.8 */ + /* */ typedef enum T1_EncodingType_ { T1_ENCODING_TYPE_NONE = 0, @@ -622,6 +625,9 @@ FT_BEGIN_HEADER /* PS_DICT_FS_TYPE :: */ /* PS_DICT_ITALIC_ANGLE :: */ /* */ + /* */ + /* 2.4.8 */ + /* */ typedef enum PS_Dict_Keys_ { /* conventionally in the font dictionary */ @@ -743,6 +749,9 @@ FT_BEGIN_HEADER * If the font's format is not PostScript-based, this function returns * the `FT_Err_Invalid_Argument' error code. * + * @since: + * 2.4.8 + * */ FT_EXPORT( FT_Long ) FT_Get_PS_Font_Value( FT_Face face,