diff options
Diffstat (limited to 'include/freetype/ftgxval.h')
-rw-r--r-- | include/freetype/ftgxval.h | 68 |
1 files changed, 33 insertions, 35 deletions
diff --git a/include/freetype/ftgxval.h b/include/freetype/ftgxval.h index 532b48434..5a630edf1 100644 --- a/include/freetype/ftgxval.h +++ b/include/freetype/ftgxval.h @@ -53,9 +53,9 @@ FT_BEGIN_HEADER * An API to validate TrueTypeGX/AAT tables. * * @description: - * This section contains the declaration of functions to validate - * some TrueTypeGX tables (feat, mort, morx, bsln, just, kern, opbd, - * trak, prop, lcar). + * This section contains the declaration of functions to validate some + * TrueTypeGX tables (feat, mort, morx, bsln, just, kern, opbd, trak, + * prop, lcar). * * @order: * FT_TrueTypeGX_Validate @@ -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, @@ -189,8 +189,8 @@ FT_BEGIN_HEADER * @description: * Validate various TrueTypeGX tables to assure that all offsets and * indices are valid. The idea is that a higher-level library that - * actually does the text layout can access those tables without - * 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 :: @@ -201,13 +201,13 @@ 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: * tables :: - * The array where all validated sfnt tables are stored. - * The array itself must be allocated by a client. + * The array where all validated sfnt tables are stored. The array + * itself must be allocated by a client. * * @return: * FreeType error code. 0~means success. @@ -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. @@ -242,8 +242,7 @@ FT_BEGIN_HEADER * A handle to the input face. * * table :: - * The pointer to the buffer allocated by - * @FT_TrueTypeGX_Validate. + * The pointer to the buffer allocated by @FT_TrueTypeGX_Validate. * * @note: * This function must be used to free the buffer allocated by @@ -260,20 +259,19 @@ FT_BEGIN_HEADER * FT_VALIDATE_CKERNXXX * * @description: - * A list of bit-field constants used with @FT_ClassicKern_Validate - * to indicate the classic kern dialect or dialects. If the selected - * type doesn't fit, @FT_ClassicKern_Validate regards the table as - * invalid. + * A list of bit-field constants used with @FT_ClassicKern_Validate to + * indicate the classic kern dialect or dialects. If the selected type + * doesn't fit, @FT_ClassicKern_Validate regards the table as invalid. * * @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 ) @@ -287,12 +285,12 @@ FT_BEGIN_HEADER * FT_ClassicKern_Validate * * @description: - * 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 - * actually does the text layout can access those tables without error - * checking (which can be quite time consuming). + * 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 actually does the text layout can access those tables + * without error checking (which can be quite time consuming). * - * The `kern' table validator in @FT_TrueTypeGX_Validate deals with both + * The 'kern' table validator in @FT_TrueTypeGX_Validate deals with both * the new 32-bit format and the classic 16-bit format, while * FT_ClassicKern_Validate only supports the classic 16-bit format. * @@ -313,7 +311,7 @@ FT_BEGIN_HEADER * * @note: * After use, the application should deallocate the buffers pointed to by - * `ckern_table', by calling @FT_ClassicKern_Free. A NULL value + * `ckern_table`, by calling @FT_ClassicKern_Free. A NULL value * indicates that the table doesn't exist in the font. */ FT_EXPORT( FT_Error ) |