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
*
* @Description:
@ -4118,7 +4118,7 @@ FT_BEGIN_HEADER
/*************************************************************************
*
* @func:
* @function:
* FT_Get_SubGlyph_Info
*
* @description:
@ -4200,7 +4200,7 @@ FT_BEGIN_HEADER
/*************************************************************************
*
* @func:
* @function:
* FT_Get_Color_Glyph_Layer
*
* @description:

View File

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

View File

@ -6,7 +6,7 @@
*/
/****************************************************************************
/****************************************************************************
*
* @Chapter:
* general_remarks
@ -21,7 +21,7 @@
*/
/****************************************************************************
/****************************************************************************
*
* @Chapter:
* core_api
@ -42,7 +42,7 @@
*/
/****************************************************************************
/****************************************************************************
*
* @Chapter:
* format_specific
@ -65,7 +65,7 @@
*/
/****************************************************************************
/****************************************************************************
*
* @Chapter:
* module_specific
@ -86,7 +86,7 @@
*/
/****************************************************************************
/****************************************************************************
*
* @Chapter:
* cache_subsystem
@ -100,7 +100,7 @@
*/
/****************************************************************************
/****************************************************************************
*
* @Chapter:
* support_api
@ -124,7 +124,8 @@
*
*/
/****************************************************************************
/****************************************************************************
*
* @Chapter:
* error_codes
@ -137,3 +138,6 @@
* error_code_values
*
*/
/* END */

View File

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

View File

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

View File

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

View File

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

View File

@ -706,7 +706,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @func:
* @function:
* FT_Get_TrueType_Engine_Type
*
* @description:

View File

@ -113,6 +113,7 @@ FT_BEGIN_HEADER
FT_VALIDATE_JSTF | \
FT_VALIDATE_MATH )
/**********************************************************************
*
* @function:
@ -169,6 +170,7 @@ FT_BEGIN_HEADER
FT_Bytes *GSUB_table,
FT_Bytes *JSTF_table );
/**********************************************************************
*
* @function:
@ -193,6 +195,7 @@ FT_BEGIN_HEADER
FT_OpenType_Free( FT_Face face,
FT_Bytes table );
/* */

View File

@ -594,6 +594,7 @@ FT_BEGIN_HEADER
FT_EXPORT( FT_Orientation )
FT_Outline_Get_Orientation( FT_Outline* outline );
/* */

View File

@ -53,7 +53,7 @@ FT_BEGIN_HEADER
/***************************************************************************
*
* @constant:
* @enum:
* FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY
*
* @description:
@ -77,7 +77,7 @@ FT_BEGIN_HEADER
/***************************************************************************
*
* @constant:
* @enum:
* FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY
*
* @description:
@ -101,7 +101,7 @@ FT_BEGIN_HEADER
/***************************************************************************
*
* @constant:
* @enum:
* FT_PARAM_TAG_INCREMENTAL
*
* @description:
@ -115,7 +115,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @constant:
* @enum:
* FT_PARAM_TAG_LCD_FILTER_WEIGHTS
*
* @description:
@ -135,7 +135,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @constant:
* @enum:
* FT_PARAM_TAG_RANDOM_SEED
*
* @description:
@ -154,7 +154,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @constant:
* @enum:
* FT_PARAM_TAG_STEM_DARKENING
*
* @description:
@ -178,7 +178,7 @@ FT_BEGIN_HEADER
/***************************************************************************
*
* @constant:
* @enum:
* FT_PARAM_TAG_UNPATENTED_HINTING
*
* @description:

View File

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

View File

@ -617,7 +617,7 @@ FT_BEGIN_HEADER
* nameid ::
* The name id of the name record to return.
*
* @Out:
* @Output:
* win ::
* If non-negative, an index into the `name' table with
* the corresponding (3,1) or (3,0) Windows entry.