Documentation formatting improvement.

This commit is contained in:
Moazin Khatti 2019-07-11 15:52:31 +05:00
parent 6e05128713
commit 41a1572f33
4 changed files with 36 additions and 39 deletions

View File

@ -254,8 +254,7 @@ FT_BEGIN_HEADER
* The length of the svg_document.
*
* glyph_index ::
* The index of the glyph to be rendered. I think it's necessary
* because one document can contain multiple glyphs.
* The index of the glyph to be rendered.
*
* metrics ::
* A metrics object storing the size information.
@ -270,14 +269,14 @@ FT_BEGIN_HEADER
* The ending glyph ID for the glyph range that this document has.
*
* @note:
* `metrics' and `units_per_EM' might look like repetitions since both
* `metrics` and `units_per_EM` might look like repetitions since both
* fields are stored in face objects. However, the Glyph Management API
* requires an `FT_Glyph' to store all the information that completely
* requires an `FT_Glyph` to store all the information that completely
* describes a glyph. Outline glyphs are themselves scaled thus they
* don't need this information. However, SVG documents do. The field of
* `units_per_EM' is needed because the SVG is to be scaled in case its
* viewbox size differs from `units_per_EM'. For more info, refer to
* the section `Coordinate Systems and Glyph Metrics' of the OpenType
* `units_per_EM` is needed because the SVG is to be scaled in case its
* viewbox size differs from `units_per_EM`. For more info, refer to
* the section _Coordinate Systems and Glyph Metrics_ of the OpenType
* SVG specs.
*/
typedef struct FT_SvgGlyphRec_

View File

@ -319,7 +319,7 @@ FT_BEGIN_HEADER
*
* @description:
* Scans the SVG documents list to find the document containing the glyph
* that has the id `glyph<glyph_index>'
* that has the id "glyph<glyph_index>".
*
* @input:
* glyph ::

View File

@ -40,9 +40,8 @@ FT_BEGIN_HEADER
*
* @input:
* library ::
* A instance of library. This is required to initialize the renderer's
* state which will be held in the library.
*
* A instance of library. This is required to initialize the
* renderer's state which will be held in the library.
*
* @return:
* FreeType error code. 0 means success.
@ -63,8 +62,8 @@ FT_BEGIN_HEADER
*
* @input:
* library ::
* A instance of library. This is required to free the renderer's state
* which will be held in the library.
* A instance of library. This is required to free the renderer's
* state which will be held in the library.
*/
typedef void
@ -102,7 +101,7 @@ FT_BEGIN_HEADER
*
* @description:
* A callback which is called to get the size of the image buffer needed.
* This buffer will ultimately be populated by `SVG_Lib_Render_Func'
* This buffer will ultimately be populated by `SVG_Lib_Render_Func`
* hook.
*
* @input:
@ -116,7 +115,6 @@ FT_BEGIN_HEADER
*
* @return:
* Size of the state structure in bytes.
*
*/
typedef FT_ULong
@ -135,23 +133,23 @@ FT_BEGIN_HEADER
*
* @input:
* module ::
* FT_Module instance.
* `FT_Module` instance.
*
* init_svg ::
* A function pointer of the type `SVG_Lib_Init_Func'. Read the
* documentation of `SVG_Lib_Init_Func'
* A function pointer of the type `SVG_Lib_Init_Func`. Read the
* documentation of `SVG_Lib_Init_Func`.
*
* free_svg ::
* A function pointer of the type `SVG_Lib_Free_Func'. Read the
* documentation of `SVG_Lib_Free_Func'.
* A function pointer of the type `SVG_Lib_Free_Func`. Read the
* documentation of `SVG_Lib_Free_Func`.
*
* render_svg ::
* A function pointer of the type `SVG_Lib_Render_Func'. Read the
* documentation of `SVG_Lib_Render_Func'.
* A function pointer of the type `SVG_Lib_Render_Func`. Read the
* documentation of `SVG_Lib_Render_Func`.
*
* get_buffer_size ::
* A function pointer of the type `SVG_Lib_Get_Buffer_Size_Func'. Read
* the documentation of `SVG_Lib_Get_Buffer_Size_Func'.
* A function pointer of the type `SVG_Lib_Get_Buffer_Size_Func`.
* Read the documentation of `SVG_Lib_Get_Buffer_Size_Func`.
*
* @return:
* FreeType error code. 0 means success.
@ -223,14 +221,14 @@ FT_BEGIN_HEADER
* The ending glyph ID for the glyph range that this document has.
*
* @note:
* `metrics' and `units_per_EM' might look like repetitions since both
* `metrics` and `units_per_EM` might look like repetitions since both
* fields are stored in face objects. However, the Glyph Management API
* requires an `FT_Glyph' to store all the information that completely
* requires an `FT_Glyph` to store all the information that completely
* describes a glyph. Outline glyphs are themselves scaled thus they
* don't need this information. However, SVG documents do. The field of
* `units_per_EM' is needed because the SVG is to be scaled in case its
* viewbox size differs from `units_per_EM'. For more info, refer to
* the section `Coordinate Systems and Glyph Metrics' of the OpenType
* don`t need this information. However, SVG documents do. The field
* of `units_per_EM` is needed because the SVG is to be scaled in case
* its viewbox size differs from `units_per_EM`. For more info, refer
* to the section `Coordinate Systems and Glyph Metrics` of the OpenType
* SVG specs.
*/