ReceiveTempSMS
/
Al-Qurtas-Islamic-bank-The-Best-Bank-in-Iraq
forked from minhngoc25a/freetype2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
include/freetype/ftglyph.h
View File

@ -254,8 +254,7 @@ FT_BEGIN_HEADER
* The length of the svg_document. * The length of the svg_document.
* *
* glyph_index :: * glyph_index ::
* The index of the glyph to be rendered. I think it's necessary * The index of the glyph to be rendered.
* because one document can contain multiple glyphs.
* *
* metrics :: * metrics ::
* A metrics object storing the size information. * 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. * The ending glyph ID for the glyph range that this document has.
* *
* @note: * @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 * 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 * describes a glyph. Outline glyphs are themselves scaled thus they
* don't need this information. However, SVG documents do. The field of * 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 * `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 * viewbox size differs from `units_per_EM`. For more info, refer to
* the section `Coordinate Systems and Glyph Metrics' of the OpenType * the section _Coordinate Systems and Glyph Metrics_ of the OpenType
* SVG specs. * SVG specs.
*/ */
typedef struct FT_SvgGlyphRec_ typedef struct FT_SvgGlyphRec_

2
include/freetype/internal/ftobjs.h
View File

@ -893,7 +893,7 @@ FT_BEGIN_HEADER
* *
* svg_renderer_state :: * svg_renderer_state ::
* A pointer to a state object that will have the state of the SVG * A pointer to a state object that will have the state of the SVG
* Renderer. This will be totally managed by the renderer. * Renderer. This will be totally managed by the renderer.
*/ */
typedef struct FT_LibraryRec_ typedef struct FT_LibraryRec_
{ {

4
include/freetype/internal/sfnt.h
View File

@ -319,12 +319,12 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Scans the SVG documents list to find the document containing the glyph * 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: * @input:
* glyph :: * glyph ::
* The glyph slot from which pointers to SVG documents list will be * The glyph slot from which pointers to SVG documents list will be
* grabbed. The results will be stored back in the slot too. * grabbed. The results will be stored back in the slot too.
* *
* glyph_index :: * glyph_index ::
* The index of the glyph that is to be looked up. * The index of the glyph that is to be looked up.

54
include/freetype/svgrender.h
View File

@ -40,9 +40,8 @@ FT_BEGIN_HEADER
* *
* @input: * @input:
* library :: * library ::
* A instance of library. This is required to initialize the renderer's * A instance of library. This is required to initialize the
* state which will be held in the library. * renderer's state which will be held in the library.
*
* *
* @return: * @return:
* FreeType error code. 0 means success. * FreeType error code. 0 means success.
@ -58,13 +57,13 @@ FT_BEGIN_HEADER
* SVG_Lib_Free_Func * SVG_Lib_Free_Func
* *
* @description: * @description:
* A callback used to free the SVG Rendering port. Calling this callback * A callback used to free the SVG Rendering port. Calling this callback
* shall do all cleanups that the SVG Rendering port wants to do. * shall do all cleanups that the SVG Rendering port wants to do.
* *
* @input: * @input:
* library :: * library ::
* A instance of library. This is required to free the renderer's state * A instance of library. This is required to free the renderer's
* which will be held in the library. * state which will be held in the library.
*/ */
typedef void typedef void
@ -84,7 +83,7 @@ FT_BEGIN_HEADER
* The whole glyph slot object. * The whole glyph slot object.
* *
* outline_bbox :: * outline_bbox ::
* The bounding box of the glyph in font units. So that the renderer * The bounding box of the glyph in font units. So that the renderer
* may not need to calculate it again. * may not need to calculate it again.
* *
* @return: * @return:
@ -93,7 +92,7 @@ FT_BEGIN_HEADER
typedef FT_Error typedef FT_Error
(*SVG_Lib_Render_Func)( FT_GlyphSlot slot, (*SVG_Lib_Render_Func)( FT_GlyphSlot slot,
FT_BBox outline_bbox); FT_BBox outline_bbox);
/************************************************************************** /**************************************************************************
* *
@ -102,7 +101,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A callback which is called to get the size of the image buffer needed. * 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. * hook.
* *
* @input: * @input:
@ -116,7 +115,6 @@ FT_BEGIN_HEADER
* *
* @return: * @return:
* Size of the state structure in bytes. * Size of the state structure in bytes.
*
*/ */
typedef FT_ULong typedef FT_ULong
@ -130,28 +128,28 @@ FT_BEGIN_HEADER
* SVG_Set_Hooks_Func * SVG_Set_Hooks_Func
* *
* @description: * @description:
* A function that is used set SVG Hooks. Part of the SVG Renderer * A function that is used set SVG Hooks. Part of the SVG Renderer
* Interface. * Interface.
* *
* @input: * @input:
* module :: * module ::
* FT_Module instance. * `FT_Module` instance.
* *
* init_svg :: * init_svg ::
* A function pointer of the type `SVG_Lib_Init_Func'. Read the * A function pointer of the type `SVG_Lib_Init_Func`. Read the
* documentation of `SVG_Lib_Init_Func' * documentation of `SVG_Lib_Init_Func`.
* *
* free_svg :: * free_svg ::
* A function pointer of the type `SVG_Lib_Free_Func'. Read the * A function pointer of the type `SVG_Lib_Free_Func`. Read the
* documentation of `SVG_Lib_Free_Func'. * documentation of `SVG_Lib_Free_Func`.
* *
* render_svg :: * render_svg ::
* A function pointer of the type `SVG_Lib_Render_Func'. Read the * A function pointer of the type `SVG_Lib_Render_Func`. Read the
* documentation of `SVG_Lib_Render_Func'. * documentation of `SVG_Lib_Render_Func`.
* *
* get_buffer_size :: * get_buffer_size ::
* A function pointer of the type `SVG_Lib_Get_Buffer_Size_Func'. Read * A function pointer of the type `SVG_Lib_Get_Buffer_Size_Func`.
* the documentation of `SVG_Lib_Get_Buffer_Size_Func'. * Read the documentation of `SVG_Lib_Get_Buffer_Size_Func`.
* *
* @return: * @return:
* FreeType error code. 0 means success. * 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. * The ending glyph ID for the glyph range that this document has.
* *
* @note: * @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 * 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 * describes a glyph. Outline glyphs are themselves scaled thus they
* don't need this information. However, SVG documents do. The field of * don`t need this information. However, SVG documents do. The field
* `units_per_EM' is needed because the SVG is to be scaled in case its * of `units_per_EM` is needed because the SVG is to be scaled in case
* viewbox size differs from `units_per_EM'. For more info, refer to * its viewbox size differs from `units_per_EM`. For more info, refer
* the section `Coordinate Systems and Glyph Metrics' of the OpenType * to the section `Coordinate Systems and Glyph Metrics` of the OpenType
* SVG specs. * SVG specs.
*/ */