Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.

This commit is contained in:
Werner Lemberg 2018-06-17 11:22:37 +02:00
parent da84691914
commit 19d8687f0b
22 changed files with 981 additions and 973 deletions

View File

@ -1528,7 +1528,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @Const: * @enum:
* FT_STYLE_FLAG_XXX * FT_STYLE_FLAG_XXX
* *
* @Description: * @Description:
@ -4118,7 +4118,7 @@ FT_BEGIN_HEADER
/************************************************************************* /*************************************************************************
* *
* @func: * @function:
* FT_Get_SubGlyph_Info * FT_Get_SubGlyph_Info
* *
* @description: * @description:
@ -4200,7 +4200,7 @@ FT_BEGIN_HEADER
/************************************************************************* /*************************************************************************
* *
* @func: * @function:
* FT_Get_Color_Glyph_Layer * FT_Get_Color_Glyph_Layer
* *
* @description: * @description:

View File

@ -58,7 +58,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @Const: * @enum:
* FT_ADVANCE_FLAG_FAST_ONLY * FT_ADVANCE_FLAG_FAST_ONLY
* *
* @Description: * @Description:

View File

@ -93,28 +93,28 @@ FT_BEGIN_HEADER
typedef struct BDF_PropertyRec_* BDF_Property; typedef struct BDF_PropertyRec_* BDF_Property;
/********************************************************************** /**********************************************************************
* *
* @struct: * @struct:
* BDF_PropertyRec * BDF_PropertyRec
* *
* @description: * @description:
* This structure models a given BDF/PCF property. * This structure models a given BDF/PCF property.
* *
* @fields: * @fields:
* type :: * type ::
* The property type. * The property type.
* *
* u.atom :: * u.atom ::
* The atom string, if type is @BDF_PROPERTY_TYPE_ATOM. May be * The atom string, if type is @BDF_PROPERTY_TYPE_ATOM. May be
* NULL, indicating an empty string. * NULL, indicating an empty string.
* *
* u.integer :: * u.integer ::
* A signed integer, if type is @BDF_PROPERTY_TYPE_INTEGER. * A signed integer, if type is @BDF_PROPERTY_TYPE_INTEGER.
* *
* u.cardinal :: * u.cardinal ::
* An unsigned integer, if type is @BDF_PROPERTY_TYPE_CARDINAL. * An unsigned integer, if type is @BDF_PROPERTY_TYPE_CARDINAL.
*/ */
typedef struct BDF_PropertyRec_ typedef struct BDF_PropertyRec_
{ {
BDF_PropertyType type; BDF_PropertyType type;
@ -128,76 +128,76 @@ FT_BEGIN_HEADER
} BDF_PropertyRec; } BDF_PropertyRec;
/********************************************************************** /**********************************************************************
* *
* @function: * @function:
* FT_Get_BDF_Charset_ID * FT_Get_BDF_Charset_ID
* *
* @description: * @description:
* Retrieve a BDF font character set identity, according to * Retrieve a BDF font character set identity, according to
* the BDF specification. * the BDF specification.
* *
* @input: * @input:
* face :: * face ::
* A handle to the input face. * A handle to the input face.
* *
* @output: * @output:
* acharset_encoding :: * acharset_encoding ::
* Charset encoding, as a C~string, owned by the face. * Charset encoding, as a C~string, owned by the face.
* *
* acharset_registry :: * acharset_registry ::
* Charset registry, as a C~string, owned by the face. * Charset registry, as a C~string, owned by the face.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* This function only works with BDF faces, returning an error otherwise. * This function only works with BDF faces, returning an error otherwise.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Get_BDF_Charset_ID( FT_Face face, FT_Get_BDF_Charset_ID( FT_Face face,
const char* *acharset_encoding, const char* *acharset_encoding,
const char* *acharset_registry ); const char* *acharset_registry );
/********************************************************************** /**********************************************************************
* *
* @function: * @function:
* FT_Get_BDF_Property * FT_Get_BDF_Property
* *
* @description: * @description:
* Retrieve a BDF property from a BDF or PCF font file. * Retrieve a BDF property from a BDF or PCF font file.
* *
* @input: * @input:
* face :: * face ::
* A handle to the input face. * A handle to the input face.
* *
* name :: * name ::
* The property name. * The property name.
* *
* @output: * @output:
* aproperty :: * aproperty ::
* The property. * The property.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* This function works with BDF _and_ PCF fonts. It returns an error * This function works with BDF _and_ PCF fonts. It returns an error
* otherwise. It also returns an error if the property is not in the * otherwise. It also returns an error if the property is not in the
* font. * font.
* *
* A `property' is a either key-value pair within the STARTPROPERTIES * A `property' is a either key-value pair within the STARTPROPERTIES
* ... ENDPROPERTIES block of a BDF font or a key-value pair from the * ... ENDPROPERTIES block of a BDF font or a key-value pair from the
* `info->props' array within a `FontRec' structure of a PCF font. * `info->props' array within a `FontRec' structure of a PCF font.
* *
* Integer properties are always stored as `signed' within PCF fonts; * Integer properties are always stored as `signed' within PCF fonts;
* consequently, @BDF_PROPERTY_TYPE_CARDINAL is a possible return value * consequently, @BDF_PROPERTY_TYPE_CARDINAL is a possible return value
* for BDF fonts only. * for BDF fonts only.
* *
* In case of error, `aproperty->type' is always set to * In case of error, `aproperty->type' is always set to
* @BDF_PROPERTY_TYPE_NONE. * @BDF_PROPERTY_TYPE_NONE.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Get_BDF_Property( FT_Face face, FT_Get_BDF_Property( FT_Face face,
const char* prop_name, const char* prop_name,

View File

@ -48,45 +48,45 @@ FT_BEGIN_HEADER
*/ */
/************************************************************************ /************************************************************************
* *
* @function: * @function:
* FT_Stream_OpenBzip2 * FT_Stream_OpenBzip2
* *
* @description: * @description:
* Open a new stream to parse bzip2-compressed font files. This is * Open a new stream to parse bzip2-compressed font files. This is
* mainly used to support the compressed `*.pcf.bz2' fonts that come * mainly used to support the compressed `*.pcf.bz2' fonts that come
* with XFree86. * with XFree86.
* *
* @input: * @input:
* stream :: * stream ::
* The target embedding stream. * The target embedding stream.
* *
* source :: * source ::
* The source stream. * The source stream.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* The source stream must be opened _before_ calling this function. * The source stream must be opened _before_ calling this function.
* *
* Calling the internal function `FT_Stream_Close' on the new stream will * Calling the internal function `FT_Stream_Close' on the new stream will
* *not* call `FT_Stream_Close' on the source stream. None of the stream * *not* call `FT_Stream_Close' on the source stream. None of the stream
* objects will be released to the heap. * objects will be released to the heap.
* *
* The stream implementation is very basic and resets the decompression * The stream implementation is very basic and resets the decompression
* process each time seeking backwards is needed within the stream. * process each time seeking backwards is needed within the stream.
* *
* In certain builds of the library, bzip2 compression recognition is * In certain builds of the library, bzip2 compression recognition is
* automatically handled when calling @FT_New_Face or @FT_Open_Face. * automatically handled when calling @FT_New_Face or @FT_Open_Face.
* This means that if no font driver is capable of handling the raw * This means that if no font driver is capable of handling the raw
* compressed file, the library will try to open a bzip2 compressed stream * compressed file, the library will try to open a bzip2 compressed stream
* from it and re-open the face with it. * from it and re-open the face with it.
* *
* This function may return `FT_Err_Unimplemented_Feature' if your build * This function may return `FT_Err_Unimplemented_Feature' if your build
* of FreeType was not compiled with bzip2 support. * of FreeType was not compiled with bzip2 support.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Stream_OpenBzip2( FT_Stream stream, FT_Stream_OpenBzip2( FT_Stream stream,
FT_Stream source ); FT_Stream source );

View File

@ -6,134 +6,138 @@
*/ */
/**************************************************************************** /****************************************************************************
* *
* @Chapter: * @Chapter:
* general_remarks * general_remarks
* *
* @Title: * @Title:
* General Remarks * General Remarks
* *
* @Sections: * @Sections:
* header_inclusion * header_inclusion
* user_allocation * user_allocation
* *
*/ */
/**************************************************************************** /****************************************************************************
* *
* @Chapter: * @Chapter:
* core_api * core_api
* *
* @Title: * @Title:
* Core API * Core API
* *
* @Sections: * @Sections:
* version * version
* basic_types * basic_types
* base_interface * base_interface
* glyph_variants * glyph_variants
* glyph_management * glyph_management
* mac_specific * mac_specific
* sizes_management * sizes_management
* header_file_macros * header_file_macros
* *
*/ */
/**************************************************************************** /****************************************************************************
* *
* @Chapter: * @Chapter:
* format_specific * format_specific
* *
* @Title: * @Title:
* Format-Specific API * Format-Specific API
* *
* @Sections: * @Sections:
* multiple_masters * multiple_masters
* truetype_tables * truetype_tables
* type1_tables * type1_tables
* sfnt_names * sfnt_names
* bdf_fonts * bdf_fonts
* cid_fonts * cid_fonts
* pfr_fonts * pfr_fonts
* winfnt_fonts * winfnt_fonts
* font_formats * font_formats
* gasp_table * gasp_table
* *
*/ */
/**************************************************************************** /****************************************************************************
* *
* @Chapter: * @Chapter:
* module_specific * module_specific
* *
* @Title: * @Title:
* Controlling FreeType Modules * Controlling FreeType Modules
* *
* @Sections: * @Sections:
* auto_hinter * auto_hinter
* cff_driver * cff_driver
* t1_cid_driver * t1_cid_driver
* tt_driver * tt_driver
* pcf_driver * pcf_driver
* properties * properties
* parameter_tags * parameter_tags
* lcd_rendering * lcd_rendering
* *
*/ */
/**************************************************************************** /****************************************************************************
* *
* @Chapter: * @Chapter:
* cache_subsystem * cache_subsystem
* *
* @Title: * @Title:
* Cache Sub-System * Cache Sub-System
* *
* @Sections: * @Sections:
* cache_subsystem * cache_subsystem
* *
*/ */
/**************************************************************************** /****************************************************************************
* *
* @Chapter: * @Chapter:
* support_api * support_api
* *
* @Title: * @Title:
* Support API * Support API
* *
* @Sections: * @Sections:
* computations * computations
* list_processing * list_processing
* outline_processing * outline_processing
* quick_advance * quick_advance
* bitmap_handling * bitmap_handling
* raster * raster
* glyph_stroker * glyph_stroker
* system_interface * system_interface
* module_management * module_management
* gzip * gzip
* lzw * lzw
* bzip2 * bzip2
* *
*/ */
/****************************************************************************
* /****************************************************************************
* @Chapter: *
* error_codes * @Chapter:
* * error_codes
* @Title: *
* Error Codes * @Title:
* * Error Codes
* @Sections: *
* error_enumerations * @Sections:
* error_code_values * error_enumerations
* * error_code_values
*/ *
*/
/* END */

View File

@ -180,7 +180,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @func: * @function:
* FT_Palette_Data_Get * FT_Palette_Data_Get
* *
* @description: * @description:
@ -213,7 +213,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @func: * @function:
* FT_Palette_Select * FT_Palette_Select
* *
* @description: * @description:
@ -269,7 +269,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @func: * @function:
* FT_Palette_Set_Foreground_Color * FT_Palette_Set_Foreground_Color
* *
* @description: * @description:

View File

@ -101,7 +101,7 @@ FT_BEGIN_HEADER
/************************************************************************* /*************************************************************************
* *
* @func: * @function:
* FT_Get_Gasp * FT_Get_Gasp
* *
* @description: * @description:

View File

@ -112,51 +112,51 @@ FT_BEGIN_HEADER
( FT_VALIDATE_GX_START << FT_VALIDATE_##tag##_INDEX ) ( FT_VALIDATE_GX_START << FT_VALIDATE_##tag##_INDEX )
/********************************************************************** /**********************************************************************
* *
* @enum: * @enum:
* FT_VALIDATE_GXXXX * FT_VALIDATE_GXXXX
* *
* @description: * @description:
* A list of bit-field constants used with @FT_TrueTypeGX_Validate to * A list of bit-field constants used with @FT_TrueTypeGX_Validate to
* indicate which TrueTypeGX/AAT Type tables should be validated. * indicate which TrueTypeGX/AAT Type tables should be validated.
* *
* @values: * @values:
* FT_VALIDATE_feat :: * FT_VALIDATE_feat ::
* Validate `feat' table. * Validate `feat' table.
* *
* FT_VALIDATE_mort :: * FT_VALIDATE_mort ::
* Validate `mort' table. * Validate `mort' table.
* *
* FT_VALIDATE_morx :: * FT_VALIDATE_morx ::
* Validate `morx' table. * Validate `morx' table.
* *
* FT_VALIDATE_bsln :: * FT_VALIDATE_bsln ::
* Validate `bsln' table. * Validate `bsln' table.
* *
* FT_VALIDATE_just :: * FT_VALIDATE_just ::
* Validate `just' table. * Validate `just' table.
* *
* FT_VALIDATE_kern :: * FT_VALIDATE_kern ::
* Validate `kern' table. * Validate `kern' table.
* *
* FT_VALIDATE_opbd :: * FT_VALIDATE_opbd ::
* Validate `opbd' table. * Validate `opbd' table.
* *
* FT_VALIDATE_trak :: * FT_VALIDATE_trak ::
* Validate `trak' table. * Validate `trak' table.
* *
* FT_VALIDATE_prop :: * FT_VALIDATE_prop ::
* Validate `prop' table. * Validate `prop' table.
* *
* FT_VALIDATE_lcar :: * FT_VALIDATE_lcar ::
* Validate `lcar' table. * Validate `lcar' table.
* *
* FT_VALIDATE_GX :: * FT_VALIDATE_GX ::
* Validate all TrueTypeGX tables (feat, mort, morx, bsln, just, kern, * Validate all TrueTypeGX tables (feat, mort, morx, bsln, just, kern,
* opbd, trak, prop and lcar). * opbd, trak, prop and lcar).
* *
*/ */
#define FT_VALIDATE_feat FT_VALIDATE_GX_BITFIELD( feat ) #define FT_VALIDATE_feat FT_VALIDATE_GX_BITFIELD( feat )
#define FT_VALIDATE_mort FT_VALIDATE_GX_BITFIELD( mort ) #define FT_VALIDATE_mort FT_VALIDATE_GX_BITFIELD( mort )
@ -181,47 +181,47 @@ FT_BEGIN_HEADER
FT_VALIDATE_lcar ) FT_VALIDATE_lcar )
/********************************************************************** /**********************************************************************
* *
* @function: * @function:
* FT_TrueTypeGX_Validate * FT_TrueTypeGX_Validate
* *
* @description: * @description:
* Validate various TrueTypeGX tables to assure that all offsets and * Validate various TrueTypeGX tables to assure that all offsets and
* indices are valid. The idea is that a higher-level library that * indices are valid. The idea is that a higher-level library that
* actually does the text layout can access those tables without * actually does the text layout can access those tables without
* error checking (which can be quite time consuming). * error checking (which can be quite time consuming).
* *
* @input: * @input:
* face :: * face ::
* A handle to the input face. * A handle to the input face.
* *
* validation_flags :: * validation_flags ::
* A bit field that specifies the tables to be validated. See * A bit field that specifies the tables to be validated. See
* @FT_VALIDATE_GXXXX for possible values. * @FT_VALIDATE_GXXXX for possible values.
* *
* table_length :: * 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. * should be passed.
* *
* @output: * @output:
* tables :: * tables ::
* The array where all validated sfnt tables are stored. * The array where all validated sfnt tables are stored.
* The array itself must be allocated by a client. * The array itself must be allocated by a client.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* This function only works with TrueTypeGX fonts, returning an error * This function only works with TrueTypeGX fonts, returning an error
* otherwise. * otherwise.
* *
* After use, the application should deallocate the buffers pointed to by * 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 * indicates that the table either doesn't exist in the font, the
* application hasn't asked for validation, or the validator doesn't have * application hasn't asked for validation, or the validator doesn't have
* the ability to validate the sfnt table. * the ability to validate the sfnt table.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_TrueTypeGX_Validate( FT_Face face, FT_TrueTypeGX_Validate( FT_Face face,
FT_UInt validation_flags, FT_UInt validation_flags,
@ -229,119 +229,119 @@ FT_BEGIN_HEADER
FT_UInt table_length ); FT_UInt table_length );
/********************************************************************** /**********************************************************************
* *
* @function: * @function:
* FT_TrueTypeGX_Free * FT_TrueTypeGX_Free
* *
* @description: * @description:
* Free the buffer allocated by TrueTypeGX validator. * Free the buffer allocated by TrueTypeGX validator.
* *
* @input: * @input:
* face :: * face ::
* A handle to the input face. * A handle to the input face.
* *
* table :: * table ::
* The pointer to the buffer allocated by * The pointer to the buffer allocated by
* @FT_TrueTypeGX_Validate. * @FT_TrueTypeGX_Validate.
* *
* @note: * @note:
* This function must be used to free the buffer allocated by * This function must be used to free the buffer allocated by
* @FT_TrueTypeGX_Validate only. * @FT_TrueTypeGX_Validate only.
*/ */
FT_EXPORT( void ) FT_EXPORT( void )
FT_TrueTypeGX_Free( FT_Face face, FT_TrueTypeGX_Free( FT_Face face,
FT_Bytes table ); FT_Bytes table );
/********************************************************************** /**********************************************************************
* *
* @enum: * @enum:
* FT_VALIDATE_CKERNXXX * FT_VALIDATE_CKERNXXX
* *
* @description: * @description:
* A list of bit-field constants used with @FT_ClassicKern_Validate * A list of bit-field constants used with @FT_ClassicKern_Validate
* to indicate the classic kern dialect or dialects. If the selected * to indicate the classic kern dialect or dialects. If the selected
* type doesn't fit, @FT_ClassicKern_Validate regards the table as * type doesn't fit, @FT_ClassicKern_Validate regards the table as
* invalid. * invalid.
* *
* @values: * @values:
* FT_VALIDATE_MS :: * 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 :: * 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 :: * 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_MS ( FT_VALIDATE_GX_START << 0 )
#define FT_VALIDATE_APPLE ( FT_VALIDATE_GX_START << 1 ) #define FT_VALIDATE_APPLE ( FT_VALIDATE_GX_START << 1 )
#define FT_VALIDATE_CKERN ( FT_VALIDATE_MS | FT_VALIDATE_APPLE ) #define FT_VALIDATE_CKERN ( FT_VALIDATE_MS | FT_VALIDATE_APPLE )
/********************************************************************** /**********************************************************************
* *
* @function: * @function:
* FT_ClassicKern_Validate * FT_ClassicKern_Validate
* *
* @description: * @description:
* Validate classic (16-bit format) kern table to assure that the offsets * Validate classic (16-bit format) kern table to assure that the offsets
* and indices are valid. The idea is that a higher-level library that * and indices are valid. The idea is that a higher-level library that
* actually does the text layout can access those tables without error * actually does the text layout can access those tables without error
* checking (which can be quite time consuming). * 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 * the new 32-bit format and the classic 16-bit format, while
* FT_ClassicKern_Validate only supports the classic 16-bit format. * FT_ClassicKern_Validate only supports the classic 16-bit format.
* *
* @input: * @input:
* face :: * face ::
* A handle to the input face. * A handle to the input face.
* *
* validation_flags :: * validation_flags ::
* A bit field that specifies the dialect to be validated. See * A bit field that specifies the dialect to be validated. See
* @FT_VALIDATE_CKERNXXX for possible values. * @FT_VALIDATE_CKERNXXX for possible values.
* *
* @output: * @output:
* ckern_table :: * ckern_table ::
* A pointer to the kern table. * A pointer to the kern table.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* After use, the application should deallocate the buffers pointed to by * After use, the application should deallocate the buffers pointed to by
* `ckern_table', by calling @FT_ClassicKern_Free. A NULL value * `ckern_table', by calling @FT_ClassicKern_Free. A NULL value
* indicates that the table doesn't exist in the font. * indicates that the table doesn't exist in the font.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_ClassicKern_Validate( FT_Face face, FT_ClassicKern_Validate( FT_Face face,
FT_UInt validation_flags, FT_UInt validation_flags,
FT_Bytes *ckern_table ); FT_Bytes *ckern_table );
/********************************************************************** /**********************************************************************
* *
* @function: * @function:
* FT_ClassicKern_Free * FT_ClassicKern_Free
* *
* @description: * @description:
* Free the buffer allocated by classic Kern validator. * Free the buffer allocated by classic Kern validator.
* *
* @input: * @input:
* face :: * face ::
* A handle to the input face. * A handle to the input face.
* *
* table :: * table ::
* The pointer to the buffer that is allocated by * The pointer to the buffer that is allocated by
* @FT_ClassicKern_Validate. * @FT_ClassicKern_Validate.
* *
* @note: * @note:
* This function must be used to free the buffer allocated by * This function must be used to free the buffer allocated by
* @FT_ClassicKern_Validate only. * @FT_ClassicKern_Validate only.
*/ */
FT_EXPORT( void ) FT_EXPORT( void )
FT_ClassicKern_Free( FT_Face face, FT_ClassicKern_Free( FT_Face face,
FT_Bytes table ); FT_Bytes table );

View File

@ -48,91 +48,91 @@ FT_BEGIN_HEADER
*/ */
/************************************************************************ /************************************************************************
* *
* @function: * @function:
* FT_Stream_OpenGzip * FT_Stream_OpenGzip
* *
* @description: * @description:
* Open a new stream to parse gzip-compressed font files. This is * Open a new stream to parse gzip-compressed font files. This is
* mainly used to support the compressed `*.pcf.gz' fonts that come * mainly used to support the compressed `*.pcf.gz' fonts that come
* with XFree86. * with XFree86.
* *
* @input: * @input:
* stream :: * stream ::
* The target embedding stream. * The target embedding stream.
* *
* source :: * source ::
* The source stream. * The source stream.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* The source stream must be opened _before_ calling this function. * The source stream must be opened _before_ calling this function.
* *
* Calling the internal function `FT_Stream_Close' on the new stream will * Calling the internal function `FT_Stream_Close' on the new stream will
* *not* call `FT_Stream_Close' on the source stream. None of the stream * *not* call `FT_Stream_Close' on the source stream. None of the stream
* objects will be released to the heap. * objects will be released to the heap.
* *
* The stream implementation is very basic and resets the decompression * The stream implementation is very basic and resets the decompression
* process each time seeking backwards is needed within the stream. * process each time seeking backwards is needed within the stream.
* *
* In certain builds of the library, gzip compression recognition is * In certain builds of the library, gzip compression recognition is
* automatically handled when calling @FT_New_Face or @FT_Open_Face. * automatically handled when calling @FT_New_Face or @FT_Open_Face.
* This means that if no font driver is capable of handling the raw * This means that if no font driver is capable of handling the raw
* compressed file, the library will try to open a gzipped stream from * compressed file, the library will try to open a gzipped stream from
* it and re-open the face with it. * it and re-open the face with it.
* *
* This function may return `FT_Err_Unimplemented_Feature' if your build * This function may return `FT_Err_Unimplemented_Feature' if your build
* of FreeType was not compiled with zlib support. * of FreeType was not compiled with zlib support.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Stream_OpenGzip( FT_Stream stream, FT_Stream_OpenGzip( FT_Stream stream,
FT_Stream source ); FT_Stream source );
/************************************************************************ /************************************************************************
* *
* @function: * @function:
* FT_Gzip_Uncompress * FT_Gzip_Uncompress
* *
* @description: * @description:
* Decompress a zipped input buffer into an output buffer. This function * 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: * @input:
* memory :: * memory ::
* A FreeType memory handle. * A FreeType memory handle.
* *
* input :: * input ::
* The input buffer. * The input buffer.
* *
* input_len :: * input_len ::
* The length of the input buffer. * The length of the input buffer.
* *
* @output: * @output:
* output :: * output ::
* The output buffer. * The output buffer.
* *
* @inout: * @inout:
* output_len :: * output_len ::
* Before calling the function, this is the total size of the output * Before calling the function, this is the total size of the output
* buffer, which must be large enough to hold the entire uncompressed * buffer, which must be large enough to hold the entire uncompressed
* data (so the size of the uncompressed data must be known in * data (so the size of the uncompressed data must be known in
* advance). After calling the function, `output_len' is the size of * advance). After calling the function, `output_len' is the size of
* the used data in `output'. * the used data in `output'.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* This function may return `FT_Err_Unimplemented_Feature' if your build * This function may return `FT_Err_Unimplemented_Feature' if your build
* of FreeType was not compiled with zlib support. * of FreeType was not compiled with zlib support.
* *
* @since: * @since:
* 2.5.1 * 2.5.1
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Gzip_Uncompress( FT_Memory memory, FT_Gzip_Uncompress( FT_Memory memory,
FT_Byte* output, FT_Byte* output,

View File

@ -173,7 +173,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @func: * @function:
* FT_Library_SetLcdFilter * FT_Library_SetLcdFilter
* *
* @description: * @description:
@ -216,7 +216,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @func: * @function:
* FT_Library_SetLcdFilterWeights * FT_Library_SetLcdFilterWeights
* *
* @description: * @description:
@ -272,7 +272,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @func: * @function:
* FT_Library_SetLcdGeometry * FT_Library_SetLcdGeometry
* *
* @description: * @description:

View File

@ -47,45 +47,45 @@ FT_BEGIN_HEADER
* *
*/ */
/************************************************************************ /************************************************************************
* *
* @function: * @function:
* FT_Stream_OpenLZW * FT_Stream_OpenLZW
* *
* @description: * @description:
* Open a new stream to parse LZW-compressed font files. This is * Open a new stream to parse LZW-compressed font files. This is
* mainly used to support the compressed `*.pcf.Z' fonts that come * mainly used to support the compressed `*.pcf.Z' fonts that come
* with XFree86. * with XFree86.
* *
* @input: * @input:
* stream :: * stream ::
* The target embedding stream. * The target embedding stream.
* *
* source :: * source ::
* The source stream. * The source stream.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* The source stream must be opened _before_ calling this function. * The source stream must be opened _before_ calling this function.
* *
* Calling the internal function `FT_Stream_Close' on the new stream will * Calling the internal function `FT_Stream_Close' on the new stream will
* *not* call `FT_Stream_Close' on the source stream. None of the stream * *not* call `FT_Stream_Close' on the source stream. None of the stream
* objects will be released to the heap. * objects will be released to the heap.
* *
* The stream implementation is very basic and resets the decompression * The stream implementation is very basic and resets the decompression
* process each time seeking backwards is needed within the stream * process each time seeking backwards is needed within the stream
* *
* In certain builds of the library, LZW compression recognition is * In certain builds of the library, LZW compression recognition is
* automatically handled when calling @FT_New_Face or @FT_Open_Face. * automatically handled when calling @FT_New_Face or @FT_Open_Face.
* This means that if no font driver is capable of handling the raw * This means that if no font driver is capable of handling the raw
* compressed file, the library will try to open a LZW stream from it * compressed file, the library will try to open a LZW stream from it
* and re-open the face with it. * and re-open the face with it.
* *
* This function may return `FT_Err_Unimplemented_Feature' if your build * This function may return `FT_Err_Unimplemented_Feature' if your build
* of FreeType was not compiled with LZW support. * of FreeType was not compiled with LZW support.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Stream_OpenLZW( FT_Stream stream, FT_Stream_OpenLZW( FT_Stream stream,
FT_Stream source ); FT_Stream source );

View File

@ -92,7 +92,7 @@ FT_BEGIN_HEADER
* @Return: * @Return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @Notes: * @Note:
* This function can be used to create @FT_Face objects from fonts * This function can be used to create @FT_Face objects from fonts
* that are installed in the system as follows. * that are installed in the system as follows.
* *

View File

@ -380,8 +380,8 @@ FT_BEGIN_HEADER
* sub-system itself with FT_Property_Set; use @FTC_Property_Set * sub-system itself with FT_Property_Set; use @FTC_Property_Set
* instead. * instead.
* *
* @since: * @since:
* 2.4.11 * 2.4.11
* *
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -443,8 +443,8 @@ FT_BEGIN_HEADER
* It is not possible to retrieve properties of the FreeType Cache * It is not possible to retrieve properties of the FreeType Cache
* sub-system with FT_Property_Get; use @FTC_Property_Get instead. * sub-system with FT_Property_Get; use @FTC_Property_Get instead.
* *
* @since: * @since:
* 2.4.11 * 2.4.11
* *
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -671,28 +671,28 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @enum: * @enum:
* FT_TrueTypeEngineType * FT_TrueTypeEngineType
* *
* @description: * @description:
* A list of values describing which kind of TrueType bytecode * A list of values describing which kind of TrueType bytecode
* engine is implemented in a given FT_Library instance. It is used * engine is implemented in a given FT_Library instance. It is used
* by the @FT_Get_TrueType_Engine_Type function. * by the @FT_Get_TrueType_Engine_Type function.
* *
* @values: * @values:
* FT_TRUETYPE_ENGINE_TYPE_NONE :: * FT_TRUETYPE_ENGINE_TYPE_NONE ::
* The library doesn't implement any kind of bytecode interpreter. * The library doesn't implement any kind of bytecode interpreter.
* *
* FT_TRUETYPE_ENGINE_TYPE_UNPATENTED :: * FT_TRUETYPE_ENGINE_TYPE_UNPATENTED ::
* Deprecated and removed. * Deprecated and removed.
* *
* FT_TRUETYPE_ENGINE_TYPE_PATENTED :: * FT_TRUETYPE_ENGINE_TYPE_PATENTED ::
* The library implements a bytecode interpreter that covers * The library implements a bytecode interpreter that covers
* the full instruction set of the TrueType virtual machine (this * the full instruction set of the TrueType virtual machine (this
* was governed by patents until May 2010, hence the name). * was governed by patents until May 2010, hence the name).
* *
* @since: * @since:
* 2.2 * 2.2
* *
*/ */
typedef enum FT_TrueTypeEngineType_ typedef enum FT_TrueTypeEngineType_
@ -706,22 +706,22 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @func: * @function:
* FT_Get_TrueType_Engine_Type * FT_Get_TrueType_Engine_Type
* *
* @description: * @description:
* Return an @FT_TrueTypeEngineType value to indicate which level of * Return an @FT_TrueTypeEngineType value to indicate which level of
* the TrueType virtual machine a given library instance supports. * the TrueType virtual machine a given library instance supports.
* *
* @input: * @input:
* library :: * library ::
* A library instance. * A library instance.
* *
* @return: * @return:
* A value indicating which level is supported. * A value indicating which level is supported.
* *
* @since: * @since:
* 2.2 * 2.2
* *
*/ */
FT_EXPORT( FT_TrueTypeEngineType ) FT_EXPORT( FT_TrueTypeEngineType )

View File

@ -20,8 +20,8 @@
* *
* *
* Warning: This module might be moved to a different library in the * Warning: This module might be moved to a different library in the
* future to avoid a tight dependency between FreeType and the * future to avoid a tight dependency between FreeType and the
* OpenType specification. * OpenType specification.
* *
* *
*/ */
@ -67,38 +67,38 @@ FT_BEGIN_HEADER
*/ */
/********************************************************************** /**********************************************************************
* *
* @enum: * @enum:
* FT_VALIDATE_OTXXX * FT_VALIDATE_OTXXX
* *
* @description: * @description:
* A list of bit-field constants used with @FT_OpenType_Validate to * A list of bit-field constants used with @FT_OpenType_Validate to
* indicate which OpenType tables should be validated. * indicate which OpenType tables should be validated.
* *
* @values: * @values:
* FT_VALIDATE_BASE :: * FT_VALIDATE_BASE ::
* Validate BASE table. * Validate BASE table.
* *
* FT_VALIDATE_GDEF :: * FT_VALIDATE_GDEF ::
* Validate GDEF table. * Validate GDEF table.
* *
* FT_VALIDATE_GPOS :: * FT_VALIDATE_GPOS ::
* Validate GPOS table. * Validate GPOS table.
* *
* FT_VALIDATE_GSUB :: * FT_VALIDATE_GSUB ::
* Validate GSUB table. * Validate GSUB table.
* *
* FT_VALIDATE_JSTF :: * FT_VALIDATE_JSTF ::
* Validate JSTF table. * Validate JSTF table.
* *
* FT_VALIDATE_MATH :: * FT_VALIDATE_MATH ::
* Validate MATH table. * Validate MATH table.
* *
* FT_VALIDATE_OT :: * FT_VALIDATE_OT ::
* Validate all OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH). * Validate all OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH).
* *
*/ */
#define FT_VALIDATE_BASE 0x0100 #define FT_VALIDATE_BASE 0x0100
#define FT_VALIDATE_GDEF 0x0200 #define FT_VALIDATE_GDEF 0x0200
#define FT_VALIDATE_GPOS 0x0400 #define FT_VALIDATE_GPOS 0x0400
@ -113,53 +113,54 @@ FT_BEGIN_HEADER
FT_VALIDATE_JSTF | \ FT_VALIDATE_JSTF | \
FT_VALIDATE_MATH ) FT_VALIDATE_MATH )
/**********************************************************************
* /**********************************************************************
* @function: *
* FT_OpenType_Validate * @function:
* * FT_OpenType_Validate
* @description: *
* Validate various OpenType tables to assure that all offsets and * @description:
* indices are valid. The idea is that a higher-level library that * Validate various OpenType tables to assure that all offsets and
* actually does the text layout can access those tables without * indices are valid. The idea is that a higher-level library that
* error checking (which can be quite time consuming). * actually does the text layout can access those tables without
* * error checking (which can be quite time consuming).
* @input: *
* face :: * @input:
* A handle to the input face. * face ::
* * A handle to the input face.
* validation_flags :: *
* A bit field that specifies the tables to be validated. See * validation_flags ::
* @FT_VALIDATE_OTXXX for possible values. * A bit field that specifies the tables to be validated. See
* * @FT_VALIDATE_OTXXX for possible values.
* @output: *
* BASE_table :: * @output:
* A pointer to the BASE table. * BASE_table ::
* * A pointer to the BASE table.
* GDEF_table :: *
* A pointer to the GDEF table. * GDEF_table ::
* * A pointer to the GDEF table.
* GPOS_table :: *
* A pointer to the GPOS table. * GPOS_table ::
* * A pointer to the GPOS table.
* GSUB_table :: *
* A pointer to the GSUB table. * GSUB_table ::
* * A pointer to the GSUB table.
* JSTF_table :: *
* A pointer to the JSTF table. * JSTF_table ::
* * A pointer to the JSTF table.
* @return: *
* FreeType error code. 0~means success. * @return:
* * FreeType error code. 0~means success.
* @note: *
* This function only works with OpenType fonts, returning an error * @note:
* otherwise. * This function only works with OpenType fonts, returning an error
* * otherwise.
* After use, the application should deallocate the five tables with *
* @FT_OpenType_Free. A NULL value indicates that the table either * After use, the application should deallocate the five tables with
* doesn't exist in the font, or the application hasn't asked for * @FT_OpenType_Free. A NULL value indicates that the table either
* validation. * doesn't exist in the font, or the application hasn't asked for
*/ * validation.
*/
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_OpenType_Validate( FT_Face face, FT_OpenType_Validate( FT_Face face,
FT_UInt validation_flags, FT_UInt validation_flags,
@ -169,30 +170,32 @@ FT_BEGIN_HEADER
FT_Bytes *GSUB_table, FT_Bytes *GSUB_table,
FT_Bytes *JSTF_table ); FT_Bytes *JSTF_table );
/**********************************************************************
* /**********************************************************************
* @function: *
* FT_OpenType_Free * @function:
* * FT_OpenType_Free
* @description: *
* Free the buffer allocated by OpenType validator. * @description:
* * Free the buffer allocated by OpenType validator.
* @input: *
* face :: * @input:
* A handle to the input face. * face ::
* * A handle to the input face.
* table :: *
* The pointer to the buffer that is allocated by * table ::
* @FT_OpenType_Validate. * The pointer to the buffer that is allocated by
* * @FT_OpenType_Validate.
* @note: *
* This function must be used to free the buffer allocated by * @note:
* @FT_OpenType_Validate only. * This function must be used to free the buffer allocated by
*/ * @FT_OpenType_Validate only.
*/
FT_EXPORT( void ) FT_EXPORT( void )
FT_OpenType_Free( FT_Face face, FT_OpenType_Free( FT_Face face,
FT_Bytes table ); FT_Bytes table );
/* */ /* */

View File

@ -521,41 +521,41 @@ FT_BEGIN_HEADER
FT_Raster_Params* params ); FT_Raster_Params* params );
/************************************************************************** /**************************************************************************
* *
* @enum: * @enum:
* FT_Orientation * FT_Orientation
* *
* @description: * @description:
* A list of values used to describe an outline's contour orientation. * A list of values used to describe an outline's contour orientation.
* *
* The TrueType and PostScript specifications use different conventions * The TrueType and PostScript specifications use different conventions
* to determine whether outline contours should be filled or unfilled. * to determine whether outline contours should be filled or unfilled.
* *
* @values: * @values:
* FT_ORIENTATION_TRUETYPE :: * FT_ORIENTATION_TRUETYPE ::
* According to the TrueType specification, clockwise contours must * According to the TrueType specification, clockwise contours must
* be filled, and counter-clockwise ones must be unfilled. * be filled, and counter-clockwise ones must be unfilled.
* *
* FT_ORIENTATION_POSTSCRIPT :: * FT_ORIENTATION_POSTSCRIPT ::
* According to the PostScript specification, counter-clockwise contours * According to the PostScript specification, counter-clockwise contours
* must be filled, and clockwise ones must be unfilled. * must be filled, and clockwise ones must be unfilled.
* *
* FT_ORIENTATION_FILL_RIGHT :: * FT_ORIENTATION_FILL_RIGHT ::
* This is identical to @FT_ORIENTATION_TRUETYPE, but is used to * This is identical to @FT_ORIENTATION_TRUETYPE, but is used to
* remember that in TrueType, everything that is to the right of * remember that in TrueType, everything that is to the right of
* the drawing direction of a contour must be filled. * the drawing direction of a contour must be filled.
* *
* FT_ORIENTATION_FILL_LEFT :: * FT_ORIENTATION_FILL_LEFT ::
* This is identical to @FT_ORIENTATION_POSTSCRIPT, but is used to * This is identical to @FT_ORIENTATION_POSTSCRIPT, but is used to
* remember that in PostScript, everything that is to the left of * remember that in PostScript, everything that is to the left of
* the drawing direction of a contour must be filled. * the drawing direction of a contour must be filled.
* *
* FT_ORIENTATION_NONE :: * FT_ORIENTATION_NONE ::
* The orientation cannot be determined. That is, different parts of * The orientation cannot be determined. That is, different parts of
* the glyph have different orientation. * the glyph have different orientation.
* *
*/ */
typedef enum FT_Orientation_ typedef enum FT_Orientation_
{ {
FT_ORIENTATION_TRUETYPE = 0, FT_ORIENTATION_TRUETYPE = 0,
@ -567,33 +567,34 @@ FT_BEGIN_HEADER
} FT_Orientation; } FT_Orientation;
/************************************************************************** /**************************************************************************
* *
* @function: * @function:
* FT_Outline_Get_Orientation * FT_Outline_Get_Orientation
* *
* @description: * @description:
* This function analyzes a glyph outline and tries to compute its * This function analyzes a glyph outline and tries to compute its
* fill orientation (see @FT_Orientation). This is done by integrating * fill orientation (see @FT_Orientation). This is done by integrating
* the total area covered by the outline. The positive integral * the total area covered by the outline. The positive integral
* corresponds to the clockwise orientation and @FT_ORIENTATION_POSTSCRIPT * corresponds to the clockwise orientation and @FT_ORIENTATION_POSTSCRIPT
* is returned. The negative integral corresponds to the counter-clockwise * is returned. The negative integral corresponds to the counter-clockwise
* orientation and @FT_ORIENTATION_TRUETYPE is returned. * orientation and @FT_ORIENTATION_TRUETYPE is returned.
* *
* Note that this will return @FT_ORIENTATION_TRUETYPE for empty * Note that this will return @FT_ORIENTATION_TRUETYPE for empty
* outlines. * outlines.
* *
* @input: * @input:
* outline :: * outline ::
* A handle to the source outline. * A handle to the source outline.
* *
* @return: * @return:
* The orientation. * The orientation.
* *
*/ */
FT_EXPORT( FT_Orientation ) FT_EXPORT( FT_Orientation )
FT_Outline_Get_Orientation( FT_Outline* outline ); FT_Outline_Get_Orientation( FT_Outline* outline );
/* */ /* */

View File

@ -53,7 +53,7 @@ FT_BEGIN_HEADER
/*************************************************************************** /***************************************************************************
* *
* @constant: * @enum:
* FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY * FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY
* *
* @description: * @description:
@ -77,7 +77,7 @@ FT_BEGIN_HEADER
/*************************************************************************** /***************************************************************************
* *
* @constant: * @enum:
* FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY * FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY
* *
* @description: * @description:
@ -101,7 +101,7 @@ FT_BEGIN_HEADER
/*************************************************************************** /***************************************************************************
* *
* @constant: * @enum:
* FT_PARAM_TAG_INCREMENTAL * FT_PARAM_TAG_INCREMENTAL
* *
* @description: * @description:
@ -115,7 +115,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @constant: * @enum:
* FT_PARAM_TAG_LCD_FILTER_WEIGHTS * FT_PARAM_TAG_LCD_FILTER_WEIGHTS
* *
* @description: * @description:
@ -135,7 +135,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @constant: * @enum:
* FT_PARAM_TAG_RANDOM_SEED * FT_PARAM_TAG_RANDOM_SEED
* *
* @description: * @description:
@ -154,7 +154,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @constant: * @enum:
* FT_PARAM_TAG_STEM_DARKENING * FT_PARAM_TAG_STEM_DARKENING
* *
* @description: * @description:
@ -176,19 +176,19 @@ FT_BEGIN_HEADER
FT_MAKE_TAG( 'd', 'a', 'r', 'k' ) FT_MAKE_TAG( 'd', 'a', 'r', 'k' )
/*************************************************************************** /***************************************************************************
* *
* @constant: * @enum:
* FT_PARAM_TAG_UNPATENTED_HINTING * FT_PARAM_TAG_UNPATENTED_HINTING
* *
* @description: * @description:
* Deprecated, no effect. * Deprecated, no effect.
* *
* Previously: A constant used as the tag of an @FT_Parameter structure to * Previously: A constant used as the tag of an @FT_Parameter structure to
* indicate that unpatented methods only should be used by the TrueType * indicate that unpatented methods only should be used by the TrueType
* bytecode interpreter for a typeface opened by @FT_Open_Face. * bytecode interpreter for a typeface opened by @FT_Open_Face.
* *
*/ */
#define FT_PARAM_TAG_UNPATENTED_HINTING \ #define FT_PARAM_TAG_UNPATENTED_HINTING \
FT_MAKE_TAG( 'u', 'n', 'p', 'a' ) FT_MAKE_TAG( 'u', 'n', 'p', 'a' )

View File

@ -49,44 +49,44 @@ FT_BEGIN_HEADER
*/ */
/********************************************************************** /**********************************************************************
* *
* @function: * @function:
* FT_Get_PFR_Metrics * FT_Get_PFR_Metrics
* *
* @description: * @description:
* Return the outline and metrics resolutions of a given PFR face. * Return the outline and metrics resolutions of a given PFR face.
* *
* @input: * @input:
* face :: * face ::
* Handle to the input face. It can be a non-PFR face. * Handle to the input face. It can be a non-PFR face.
* *
* @output: * @output:
* aoutline_resolution :: * aoutline_resolution ::
* Outline resolution. This is equivalent to `face->units_per_EM' * Outline resolution. This is equivalent to `face->units_per_EM'
* for non-PFR fonts. Optional (parameter can be NULL). * for non-PFR fonts. Optional (parameter can be NULL).
* *
* ametrics_resolution :: * ametrics_resolution ::
* Metrics resolution. This is equivalent to `outline_resolution' * Metrics resolution. This is equivalent to `outline_resolution'
* for non-PFR fonts. Optional (parameter can be NULL). * for non-PFR fonts. Optional (parameter can be NULL).
* *
* ametrics_x_scale :: * ametrics_x_scale ::
* A 16.16 fixed-point number used to scale distance expressed * A 16.16 fixed-point number used to scale distance expressed
* in metrics units to device subpixels. This is equivalent to * in metrics units to device subpixels. This is equivalent to
* `face->size->x_scale', but for metrics only. Optional (parameter * `face->size->x_scale', but for metrics only. Optional (parameter
* can be NULL). * can be NULL).
* *
* ametrics_y_scale :: * ametrics_y_scale ::
* Same as `ametrics_x_scale' but for the vertical direction. * Same as `ametrics_x_scale' but for the vertical direction.
* optional (parameter can be NULL). * optional (parameter can be NULL).
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* If the input face is not a PFR, this function will return an error. * If the input face is not a PFR, this function will return an error.
* However, in all cases, it will return valid values. * However, in all cases, it will return valid values.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Get_PFR_Metrics( FT_Face face, FT_Get_PFR_Metrics( FT_Face face,
FT_UInt *aoutline_resolution, FT_UInt *aoutline_resolution,
@ -95,41 +95,41 @@ FT_BEGIN_HEADER
FT_Fixed *ametrics_y_scale ); FT_Fixed *ametrics_y_scale );
/********************************************************************** /**********************************************************************
* *
* @function: * @function:
* FT_Get_PFR_Kerning * FT_Get_PFR_Kerning
* *
* @description: * @description:
* Return the kerning pair corresponding to two glyphs in a PFR face. * Return the kerning pair corresponding to two glyphs in a PFR face.
* The distance is expressed in metrics units, unlike the result of * The distance is expressed in metrics units, unlike the result of
* @FT_Get_Kerning. * @FT_Get_Kerning.
* *
* @input: * @input:
* face :: * face ::
* A handle to the input face. * A handle to the input face.
* *
* left :: * left ::
* Index of the left glyph. * Index of the left glyph.
* *
* right :: * right ::
* Index of the right glyph. * Index of the right glyph.
* *
* @output: * @output:
* avector :: * avector ::
* A kerning vector. * A kerning vector.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* This function always return distances in original PFR metrics * This function always return distances in original PFR metrics
* units. This is unlike @FT_Get_Kerning with the @FT_KERNING_UNSCALED * units. This is unlike @FT_Get_Kerning with the @FT_KERNING_UNSCALED
* mode, which always returns distances converted to outline units. * mode, which always returns distances converted to outline units.
* *
* You can use the value of the `x_scale' and `y_scale' parameters * You can use the value of the `x_scale' and `y_scale' parameters
* returned by @FT_Get_PFR_Metrics to scale these to device subpixels. * returned by @FT_Get_PFR_Metrics to scale these to device subpixels.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Get_PFR_Kerning( FT_Face face, FT_Get_PFR_Kerning( FT_Face face,
FT_UInt left, FT_UInt left,
@ -137,33 +137,33 @@ FT_BEGIN_HEADER
FT_Vector *avector ); FT_Vector *avector );
/********************************************************************** /**********************************************************************
* *
* @function: * @function:
* FT_Get_PFR_Advance * FT_Get_PFR_Advance
* *
* @description: * @description:
* Return a given glyph advance, expressed in original metrics units, * Return a given glyph advance, expressed in original metrics units,
* from a PFR font. * from a PFR font.
* *
* @input: * @input:
* face :: * face ::
* A handle to the input face. * A handle to the input face.
* *
* gindex :: * gindex ::
* The glyph index. * The glyph index.
* *
* @output: * @output:
* aadvance :: * aadvance ::
* The glyph advance in metrics units. * The glyph advance in metrics units.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* You can use the `x_scale' or `y_scale' results of @FT_Get_PFR_Metrics * You can use the `x_scale' or `y_scale' results of @FT_Get_PFR_Metrics
* to convert the advance to device subpixels (i.e., 1/64th of pixels). * to convert the advance to device subpixels (i.e., 1/64th of pixels).
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Get_PFR_Advance( FT_Face face, FT_Get_PFR_Advance( FT_Face face,
FT_UInt gindex, FT_UInt gindex,

View File

@ -27,68 +27,68 @@
FT_BEGIN_HEADER FT_BEGIN_HEADER
/************************************************************************ /************************************************************************
* *
* @section: * @section:
* glyph_stroker * glyph_stroker
* *
* @title: * @title:
* Glyph Stroker * Glyph Stroker
* *
* @abstract: * @abstract:
* Generating bordered and stroked glyphs. * Generating bordered and stroked glyphs.
* *
* @description: * @description:
* This component generates stroked outlines of a given vectorial * This component generates stroked outlines of a given vectorial
* glyph. It also allows you to retrieve the `outside' and/or the * glyph. It also allows you to retrieve the `outside' and/or the
* `inside' borders of the stroke. * `inside' borders of the stroke.
* *
* This can be useful to generate `bordered' glyph, i.e., glyphs * This can be useful to generate `bordered' glyph, i.e., glyphs
* displayed with a coloured (and anti-aliased) border around their * displayed with a coloured (and anti-aliased) border around their
* shape. * shape.
* *
* @order: * @order:
* FT_Stroker * FT_Stroker
* *
* FT_Stroker_LineJoin * FT_Stroker_LineJoin
* FT_Stroker_LineCap * FT_Stroker_LineCap
* FT_StrokerBorder * FT_StrokerBorder
* *
* FT_Outline_GetInsideBorder * FT_Outline_GetInsideBorder
* FT_Outline_GetOutsideBorder * FT_Outline_GetOutsideBorder
* *
* FT_Glyph_Stroke * FT_Glyph_Stroke
* FT_Glyph_StrokeBorder * FT_Glyph_StrokeBorder
* *
* FT_Stroker_New * FT_Stroker_New
* FT_Stroker_Set * FT_Stroker_Set
* FT_Stroker_Rewind * FT_Stroker_Rewind
* FT_Stroker_ParseOutline * FT_Stroker_ParseOutline
* FT_Stroker_Done * FT_Stroker_Done
* *
* FT_Stroker_BeginSubPath * FT_Stroker_BeginSubPath
* FT_Stroker_EndSubPath * FT_Stroker_EndSubPath
* *
* FT_Stroker_LineTo * FT_Stroker_LineTo
* FT_Stroker_ConicTo * FT_Stroker_ConicTo
* FT_Stroker_CubicTo * FT_Stroker_CubicTo
* *
* FT_Stroker_GetBorderCounts * FT_Stroker_GetBorderCounts
* FT_Stroker_ExportBorder * FT_Stroker_ExportBorder
* FT_Stroker_GetCounts * FT_Stroker_GetCounts
* FT_Stroker_Export * FT_Stroker_Export
* *
*/ */
/************************************************************** /**************************************************************
* *
* @type: * @type:
* FT_Stroker * FT_Stroker
* *
* @description: * @description:
* Opaque handle to a path stroker object. * Opaque handle to a path stroker object.
*/ */
typedef struct FT_StrokerRec_* FT_Stroker; typedef struct FT_StrokerRec_* FT_Stroker;

View File

@ -792,22 +792,22 @@ FT_BEGIN_HEADER
* The root font driver class. A font driver is responsible for * The root font driver class. A font driver is responsible for
* managing and loading font files of a given format. * managing and loading font files of a given format.
* *
* @Fields: * @Fields:
* root :: * root ::
* Contains the fields of the root module class. * Contains the fields of the root module class.
* *
* clazz :: * clazz ::
* A pointer to the font driver's class. Note that * A pointer to the font driver's class. Note that
* this is NOT root.clazz. `class' wasn't used * this is NOT root.clazz. `class' wasn't used
* as it is a reserved word in C++. * as it is a reserved word in C++.
* *
* faces_list :: * faces_list ::
* The list of faces currently opened by this * The list of faces currently opened by this
* driver. * driver.
* *
* glyph_loader :: * glyph_loader ::
* Unused. Used to be glyph loader for all faces * Unused. Used to be glyph loader for all faces
* managed by this driver. * managed by this driver.
*/ */
typedef struct FT_DriverRec_ typedef struct FT_DriverRec_
{ {

View File

@ -506,7 +506,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @Structure: * @Struct:
* PS_Builder * PS_Builder
* *
* @Description: * @Description:
@ -768,7 +768,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @Structure: * @Struct:
* T1_BuilderRec * T1_BuilderRec
* *
* @Description: * @Description:
@ -1050,7 +1050,7 @@ FT_BEGIN_HEADER
/************************************************************************** /**************************************************************************
* *
* @Structure: * @Struct:
* CFF_Builder * CFF_Builder
* *
* @Description: * @Description:

View File

@ -308,7 +308,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0 means success. Returns an error if no * FreeType error code. 0 means success. Returns an error if no
* glyph sbit exists for the index. * glyph sbit exists for the index.
* *
* @Note: * @Note:
* The `map.buffer' field is always freed before the glyph is loaded. * The `map.buffer' field is always freed before the glyph is loaded.
*/ */
typedef FT_Error typedef FT_Error
@ -617,7 +617,7 @@ FT_BEGIN_HEADER
* nameid :: * nameid ::
* The name id of the name record to return. * The name id of the name record to return.
* *
* @Out: * @Output:
* win :: * win ::
* If non-negative, an index into the `name' table with * If non-negative, an index into the `name' table with
* the corresponding (3,1) or (3,0) Windows entry. * the corresponding (3,1) or (3,0) Windows entry.

View File

@ -1794,41 +1794,41 @@ FT_BEGIN_HEADER
* @Struct: * @Struct:
* TT_GlyphZoneRec * TT_GlyphZoneRec
* *
* @Description: * @Description:
* A glyph zone is used to load, scale and hint glyph outline * A glyph zone is used to load, scale and hint glyph outline
* coordinates. * coordinates.
* *
* @Fields: * @Fields:
* memory :: * memory ::
* A handle to the memory manager. * A handle to the memory manager.
* *
* max_points :: * max_points ::
* The maximum size in points of the zone. * The maximum size in points of the zone.
* *
* max_contours :: * max_contours ::
* Max size in links contours of the zone. * Max size in links contours of the zone.
* *
* n_points :: * n_points ::
* The current number of points in the zone. * The current number of points in the zone.
* *
* n_contours :: * n_contours ::
* The current number of contours in the zone. * The current number of contours in the zone.
* *
* org :: * org ::
* The original glyph coordinates (font * The original glyph coordinates (font
* units/scaled). * units/scaled).
* *
* cur :: * cur ::
* The current glyph coordinates (scaled/hinted). * The current glyph coordinates (scaled/hinted).
* *
* tags :: * tags ::
* The point control tags. * The point control tags.
* *
* contours :: * contours ::
* The contours end points. * The contours end points.
* *
* first_point :: * first_point ::
* Offset of the current subglyph's first point. * Offset of the current subglyph's first point.
*/ */
typedef struct TT_GlyphZoneRec_ typedef struct TT_GlyphZoneRec_
{ {