freetype-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[freetype2] master 95f7341: More minor doc fixes.


From: Werner LEMBERG
Subject: [freetype2] master 95f7341: More minor doc fixes.
Date: Mon, 18 Jun 2018 05:10:28 -0400 (EDT)

branch: master
commit 95f7341d818ff43639f857bea03a2089289f33d8
Author: Werner Lemberg <address@hidden>
Commit: Werner Lemberg <address@hidden>

    More minor doc fixes.
---
 include/freetype/freetype.h   | 28 ++++++++++++++++++++++++++--
 include/freetype/ftcache.h    |  1 +
 include/freetype/ftchapters.h |  2 ++
 include/freetype/ftcolor.h    |  2 +-
 include/freetype/ftglyph.h    | 21 ++++++++++++---------
 5 files changed, 42 insertions(+), 12 deletions(-)

diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index fd5228a..a159ae9 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -4098,6 +4098,8 @@ FT_BEGIN_HEADER
    *   meaning of the various flags (which get synthesized for
    *   non-OpenType subglyphs).
    *
+   *     
https://docs.microsoft.com/en-us/typography/opentype/spec/glyf#composite-glyph-description
+   *
    * @values:
    *   FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS ::
    *   FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES ::
@@ -4170,6 +4172,23 @@ FT_BEGIN_HEADER
                         FT_Matrix    *p_transform );
 
 
+  /**************************************************************************
+   *
+   * @section:
+   *   layer_management
+   *
+   * @title:
+   *   Glyph Layer Management
+   *
+   * @abstract:
+   *   Retrieving and manipulating OpenType's `COLR' table data.
+   *
+   * @description:
+   *   The functions described here allow access of colored glyph layer data
+   *   in OpenType's `COLR' tables.
+   *
+
+
   /**********************************************************************
    *
    * @struct:
@@ -4304,6 +4323,13 @@ FT_BEGIN_HEADER
 
   /**************************************************************************
    *
+   * @section:
+   *   base_interface
+   *
+   */
+
+  /**************************************************************************
+   *
    * @enum:
    *   FT_FSTYPE_XXX
    *
@@ -4859,8 +4885,6 @@ FT_BEGIN_HEADER
    *   FT_Face_CheckTrueTypePatents
    *   FT_Face_SetUnpatentedHinting
    *
-   *   FREETYPE_XXX
-   *
    */
 
 
diff --git a/include/freetype/ftcache.h b/include/freetype/ftcache.h
index 7ec9b68..03233eb 100644
--- a/include/freetype/ftcache.h
+++ b/include/freetype/ftcache.h
@@ -145,6 +145,7 @@ FT_BEGIN_HEADER
   /*************************************************************************
    *
    * @type:
+   *   FTC_FaceID
    *
    * @description:
    *   An opaque pointer type that is used to identity face objects.  The
diff --git a/include/freetype/ftchapters.h b/include/freetype/ftchapters.h
index 2efbb0a..f4297d3 100644
--- a/include/freetype/ftchapters.h
+++ b/include/freetype/ftchapters.h
@@ -34,6 +34,8 @@
    *   basic_types
    *   base_interface
    *   glyph_variants
+   *   color_management
+   *   layer_management
    *   glyph_management
    *   mac_specific
    *   sizes_management
diff --git a/include/freetype/ftcolor.h b/include/freetype/ftcolor.h
index e7ee31f..90015e3 100644
--- a/include/freetype/ftcolor.h
+++ b/include/freetype/ftcolor.h
@@ -45,7 +45,7 @@ FT_BEGIN_HEADER
    *
    * @description:
    *   The functions described here allow access and manipulation of color
-   *   palette entries in OpenType's `CPAL' table.
+   *   palette entries in OpenType's `CPAL' tables.
    */
 
 
diff --git a/include/freetype/ftglyph.h b/include/freetype/ftglyph.h
index e1f72a9..3841930 100644
--- a/include/freetype/ftglyph.h
+++ b/include/freetype/ftglyph.h
@@ -226,25 +226,28 @@ FT_BEGIN_HEADER
   /**************************************************************************
    *
    * @function:
-   *    FT_New_Glyph
+   *   FT_New_Glyph
    *
    * @description:
-   *    A function used to create a new empty glyph image.  Note that
-   *    the created @FT_Glyph object must be released with @FT_Done_Glyph.
+   *   A function used to create a new empty glyph image.  Note that the
+   *   created @FT_Glyph object must be released with @FT_Done_Glyph.
    *
    * @input:
-   *    library :: A handle to the FreeType library object.
+   *   library ::
+   *     A handle to the FreeType library object.
    *
-   *    format  :: The format of the glyph's image.
+   *   format ::
+   *     The format of the glyph's image.
    *
    * @output:
-   *    aglyph :: A handle to the glyph object.
+   *   aglyph ::
+   *     A handle to the glyph object.
    *
    * @return:
-   *    FreeType error code.  0~means success.
+   *   FreeType error code.  0~means success.
    *
-   * @since
-   *    2.10
+   * @since:
+   *   2.10
    */
   FT_EXPORT( FT_Error )
   FT_New_Glyph( FT_Library       library,



reply via email to

[Prev in Thread] Current Thread [Next in Thread]