[Git][freetype/freetype][master] * include/freetype/*: Fix documentation

Werner Lemberg pushed to branch master at FreeType / FreeType

Commits:

05e1b37e
by Ivan Panchenko at 2022-10-24T06:52:06+02:00
```
* include/freetype/*: Fix documentation typos.
```

3 changed files:

include/freetype/freetype.h
include/freetype/ftcolor.h
include/freetype/fterrors.h

Changes:

@@ -646,7 +646,7 @@ FT_BEGIN_HEADER
+    *
     * @note:
     *   Despite the name, this enumeration lists specific character
 -   *   repertories (i.e., charsets), and not text encoding methods (e.g.,
 +   *   repertoires (i.e., charsets), and not text encoding methods (e.g.,
     *   UTF-8, UTF-16, etc.).
+    *
     *   Other encodings might be defined in the future.
@@ -779,7 +779,7 @@ FT_BEGIN_HEADER
     *   `encoding_id`.  If, for example, `encoding_id` is `TT_MAC_ID_ROMAN`
     *   and the language ID (minus~1) is `TT_MAC_LANGID_GREEK`, it is the
     *   Greek encoding, not Roman.  `TT_MAC_ID_ARABIC` with
 -   *   `TT_MAC_LANGID_FARSI` means the Farsi variant the Arabic encoding.
 +   *   `TT_MAC_LANGID_FARSI` means the Farsi variant of the Arabic encoding.
     */
    typedef enum  FT_Encoding_
+   {
@@ -1167,9 +1167,9 @@ FT_BEGIN_HEADER
     *   FT_FACE_FLAG_KERNING ::
     *     The face contains kerning information.  If set, the kerning distance
     *     can be retrieved using the function @FT_Get_Kerning.  Otherwise the
 -   *     function always return the vector (0,0).  Note that FreeType doesn't
 -   *     handle kerning data from the SFNT 'GPOS' table (as present in many
 -   *     OpenType fonts).
 +   *     function always returns the vector (0,0).  Note that FreeType
 +   *     doesn't handle kerning data from the SFNT 'GPOS' table (as present
 +   *     in many OpenType fonts).
+    *
     *   FT_FACE_FLAG_FAST_GLYPHS ::
     *     THIS FLAG IS DEPRECATED.  DO NOT USE OR TEST IT.
@@ -3077,7 +3077,7 @@ FT_BEGIN_HEADER
+    *
     *   FT_LOAD_NO_HINTING ::
     *     Disable hinting.  This generally generates 'blurrier' bitmap glyphs
 -   *     when the glyph are rendered in any of the anti-aliased modes.  See
 +   *     when the glyphs are rendered in any of the anti-aliased modes.  See
     *     also the note below.
+    *
     *     This flag is implied by @FT_LOAD_NO_SCALE.
@@ -3434,7 +3434,7 @@ FT_BEGIN_HEADER
     *     are not interested in the value.
+    *
     *   delta ::
 -   *     A pointer a translation vector.  Set this to NULL if you are not
 +   *     A pointer to a translation vector.  Set this to NULL if you are not
     *     interested in the value.
+    *
     * @since:
@@ -3559,9 +3559,10 @@ FT_BEGIN_HEADER
+    *
     *   2. The `sdf` rasterizer has limited support for handling intersecting
     *      contours and *cannot* handle self-intersecting contours whatsoever.
 -   *      Self-intersection happens when a single connected contour intersect
 -   *      itself at some point; having these in your font definitely pose a
 -   *      problem to the rasterizer and cause artifacts, too.
 +   *      Self-intersection happens when a single connected contour
 +   *      intersects itself at some point; having these in your font
 +   *      definitely poses a problem to the rasterizer and cause artifacts,
 +   *      too.
+    *
     *   3. Generating SDF for really small glyphs may result in undesirable
     *      output; the pixel grid (which stores distance information) becomes

include/freetype/ftcolor.h

@@ -475,7 +475,7 @@ FT_BEGIN_HEADER
     *   extensions to the 'COLR' table, see
     *   'https://github.com/googlefonts/colr-gradients-spec'.
+    *
 -   *   The enumeration values losely correspond with the format numbers of
 +   *   The enumeration values loosely correspond with the format numbers of
     *   the specification: FreeType always returns a fully specified 'Paint'
     *   structure for the 'Transform', 'Translate', 'Scale', 'Rotate', and
     *   'Skew' table types even though the specification has different formats
@@ -916,8 +916,7 @@ FT_BEGIN_HEADER
     *   A structure representing a `PaintRadialGradient` value of the 'COLR'
     *   v1 extensions, see
     *   'https://github.com/googlefonts/colr-gradients-spec'.  The glyph
 -   *   layer filled with this paint is drawn filled filled with a radial
 -   *   gradient.
 +   *   layer filled with this paint is drawn filled with a radial gradient.
+    *
     * @fields:
     *   colorline ::
@@ -1202,7 +1201,7 @@ FT_BEGIN_HEADER
+    *
     *   center_x ::
     *     The x~coordinate of the pivot point of the rotation in font
 -   *     units) represented as a 16.16 fixed-point value.
 +   *     units represented as a 16.16 fixed-point value.
+    *
     *   center_y ::
     *     The y~coordinate of the pivot point of the rotation in font
@@ -1283,9 +1282,8 @@ FT_BEGIN_HEADER
     *   FT_PaintComposite
+    *
     * @description:
 -   *   A structure representing a 'COLR'v1 `PaintComposite` paint table.
 -   *   Used for compositing two paints in a 'COLR' v1 directed acycling
 -   *   graph.
 +   *   A structure representing a 'COLR' v1 `PaintComposite` paint table.
 +   *   Used for compositing two paints in a 'COLR' v1 directed acyclic graph.
+    *
     * @fields:
     *   source_paint ::

include/freetype/fterrors.h


    *
    * @description:
    *   The header file `fterrors.h` (which is automatically included by
-   *   `freetype.h` defines the handling of FreeType's enumeration
+   *   `freetype.h`) defines the handling of FreeType's enumeration
    *   constants.  It can also be used to generate error message strings
    *   with a small macro trick explained below.
    *

From:	Werner Lemberg (@wl)
Subject:	[Git][freetype/freetype][master] * include/freetype/*: Fix documentation typos.
Date:	Mon, 24 Oct 2022 04:52:32 +0000