[freetype2] GSoC-2019-moazin 41a1572: Documentation formatting improvement.

[Moazin Khatti]

branch: GSoC-2019-moazin
commit 41a1572f33688895dfd31ed0d1a60237853230b8
Author: Moazin Khatti <address@hidden>
Commit: Moazin Khatti <address@hidden>

    Documentation formatting improvement.
---
 include/freetype/ftglyph.h         | 15 +++++------
 include/freetype/internal/ftobjs.h |  2 +-
 include/freetype/internal/sfnt.h   |  4 +--
 include/freetype/svgrender.h       | 54 ++++++++++++++++++--------------------
 4 files changed, 36 insertions(+), 39 deletions(-)

diff --git a/include/freetype/ftglyph.h b/include/freetype/ftglyph.h
index fc503f9..8b1e3f6 100644
--- a/include/freetype/ftglyph.h
+++ b/include/freetype/ftglyph.h
@@ -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
-   *   fields are stored in face objects. However, the Glyph Management API
-   *   requires an `FT_Glyph' to store all the information that completely
+   *   `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
    *   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_
diff --git a/include/freetype/internal/ftobjs.h 
b/include/freetype/internal/ftobjs.h
index d5786d2..e6aa4d8 100644
--- a/include/freetype/internal/ftobjs.h
+++ b/include/freetype/internal/ftobjs.h
@@ -893,7 +893,7 @@ FT_BEGIN_HEADER
    *
    *   svg_renderer_state ::
    *     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_
   {
diff --git a/include/freetype/internal/sfnt.h b/include/freetype/internal/sfnt.h
index d478275..821ee1a 100644
--- a/include/freetype/internal/sfnt.h
+++ b/include/freetype/internal/sfnt.h
@@ -319,12 +319,12 @@ 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 ::
    *     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 ::
    *     The index of the glyph that is to be looked up.
diff --git a/include/freetype/svgrender.h b/include/freetype/svgrender.h
index e0af126..2180541 100644
--- a/include/freetype/svgrender.h
+++ b/include/freetype/svgrender.h
@@ -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.
@@ -58,13 +57,13 @@ FT_BEGIN_HEADER
    *   SVG_Lib_Free_Func
    *
    * @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.
    *
    * @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
@@ -84,7 +83,7 @@ FT_BEGIN_HEADER
    *     The whole glyph slot object.
    *
    *   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.
    *
    * @return:
@@ -93,7 +92,7 @@ FT_BEGIN_HEADER
 
   typedef FT_Error
   (*SVG_Lib_Render_Func)( FT_GlyphSlot  slot,
-                          FT_BBox  outline_bbox);
+                          FT_BBox       outline_bbox);
 
   /**************************************************************************
    *
@@ -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
@@ -130,28 +128,28 @@ FT_BEGIN_HEADER
    *   SVG_Set_Hooks_Func
    *
    * @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.
    *
    * @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
-   *   fields are stored in face objects. However, the Glyph Management API
-   *   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
+   *   `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
+   *   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
    *   SVG specs.
    */