Commit 78d85b9c84f404025e287449695dc3e26d8c276c

Nikhil Ramakrishnan 2018-06-04T18:42:29

Restore missing comment lines and other minor fixes

diff --git a/devel/ftoption.h b/devel/ftoption.h
index c583029..3aff1f4 100644
--- a/devel/ftoption.h
+++ b/devel/ftoption.h
@@ -118,7 +118,6 @@ FT_BEGIN_HEADER
    * When this macro is not defined, FreeType offers alternative LCD
    * rendering technology that produces excellent output without LCD
    * filtering.
-   *
    */
 /* #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING */
 
@@ -212,7 +211,6 @@ FT_BEGIN_HEADER
    *
    *   Do not #undef this macro here since the build system might define
    *   it for certain configurations only.
-   *
    */
 /* #define FT_CONFIG_OPTION_SYSTEM_ZLIB */
 
@@ -240,7 +238,6 @@ FT_BEGIN_HEADER
    * systems that have multiple system libraries, some with or without
    * file stream support, in the cases where file stream support is not
    * necessary such as memory loading of font files.
-   *
    */
 /* #define FT_CONFIG_OPTION_DISABLE_STREAM_SUPPORT */
 
@@ -532,6 +529,7 @@ FT_BEGIN_HEADER
    * TrueType CMap support
    *
    *   Here you can fine-tune which TrueType CMap table format shall be
+   *   supported.
    */
 #define TT_CONFIG_CMAP_FORMAT_0
 #define TT_CONFIG_CMAP_FORMAT_2
@@ -612,7 +610,6 @@ FT_BEGIN_HEADER
    * defined.
    *
    * [1] https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx
-   *
    */
 /* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING  1     */
 /* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING  2     */
diff --git a/include/freetype/config/ftoption.h b/include/freetype/config/ftoption.h
index 66bb8f9..a5d883f 100644
--- a/include/freetype/config/ftoption.h
+++ b/include/freetype/config/ftoption.h
@@ -121,7 +121,6 @@ FT_BEGIN_HEADER
    * When this macro is not defined, FreeType offers alternative LCD
    * rendering technology that produces excellent output without LCD
    * filtering.
-   *
    */
 /* #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING */
 
@@ -219,7 +218,6 @@ FT_BEGIN_HEADER
    *   If you use a build system like cmake or the `configure' script,
    *   options set by those programs have precendence, overwriting the
    *   value here with the configured one.
-   *
    */
 /* #define FT_CONFIG_OPTION_SYSTEM_ZLIB */
 
@@ -240,7 +238,6 @@ FT_BEGIN_HEADER
    *   If you use a build system like cmake or the `configure' script,
    *   options set by those programs have precendence, overwriting the
    *   value here with the configured one.
-   *
    */
 /* #define FT_CONFIG_OPTION_USE_BZIP2 */
 
@@ -252,7 +249,6 @@ FT_BEGIN_HEADER
    * systems that have multiple system libraries, some with or without
    * file stream support, in the cases where file stream support is not
    * necessary such as memory loading of font files.
-   *
    */
 /* #define FT_CONFIG_OPTION_DISABLE_STREAM_SUPPORT */
 
@@ -271,7 +267,6 @@ FT_BEGIN_HEADER
    *   If you use a build system like cmake or the `configure' script,
    *   options set by those programs have precendence, overwriting the
    *   value here with the configured one.
-   *
    */
 /* #define FT_CONFIG_OPTION_USE_PNG */
 
@@ -289,7 +284,6 @@ FT_BEGIN_HEADER
    *   If you use a build system like cmake or the `configure' script,
    *   options set by those programs have precendence, overwriting the
    *   value here with the configured one.
-   *
    */
 /* #define FT_CONFIG_OPTION_USE_HARFBUZZ */
 
@@ -418,7 +412,6 @@ FT_BEGIN_HEADER
    *
    *   Do not #undef these macros here since the build system might define
    *   them for certain configurations only.
-   *
    */
 /* #define FT_DEBUG_LEVEL_ERROR */
 /* #define FT_DEBUG_LEVEL_TRACE */
@@ -455,7 +448,6 @@ FT_BEGIN_HEADER
    *
    *   Do not #undef these macros here since the build system might define
    *   them for certain configurations only.
-   *
    */
 /* #define FT_DEBUG_AUTOFIT */
 
@@ -474,7 +466,6 @@ FT_BEGIN_HEADER
    *
    *   Do not #undef this macro here since the build system might define
    *   it for certain configurations only.
-   *
    */
 /* #define FT_DEBUG_MEMORY */
 
@@ -557,6 +548,7 @@ FT_BEGIN_HEADER
    * TrueType CMap support
    *
    *   Here you can fine-tune which TrueType CMap table format shall be
+   *   supported.
    */
 #define TT_CONFIG_CMAP_FORMAT_0
 #define TT_CONFIG_CMAP_FORMAT_2
@@ -646,7 +638,6 @@ FT_BEGIN_HEADER
    * defined.
    *
    * [1] https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx
-   *
    */
 /* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING  1         */
 #define TT_CONFIG_OPTION_SUBPIXEL_HINTING  2
@@ -769,7 +760,6 @@ FT_BEGIN_HEADER
    * engine gets compiled into FreeType.  If defined, it is possible to
    * switch between the two engines using the `hinting-engine' property of
    * the type1 driver module.
-   *
    */
 /* #define T1_CONFIG_OPTION_OLD_ENGINE */
 
@@ -813,7 +803,6 @@ FT_BEGIN_HEADER
    * engine gets compiled into FreeType.  If defined, it is possible to
    * switch between the two engines using the `hinting-engine' property of
    * the cff driver module.
-   *
    */
 /* #define CFF_CONFIG_OPTION_OLD_ENGINE */
 
@@ -841,7 +830,6 @@ FT_BEGIN_HEADER
    *
    * If this option is activated, it can be controlled with the
    * `no-long-family-names' property of the pcf driver module.
-   *
    */
 /* #define PCF_CONFIG_OPTION_LONG_FAMILY_NAMES */
 
@@ -902,7 +890,6 @@ FT_BEGIN_HEADER
    *     [truetype] Fix metrics on size request for scalable fonts.
    *
    * This problematic commit is now reverted (more or less).
-   *
    */
 /* #define AF_CONFIG_OPTION_TT_SIZE_METRICS */
 
diff --git a/src/base/ftmac.c b/src/base/ftmac.c
index 878dd3c..79e3fe4 100644
--- a/src/base/ftmac.c
+++ b/src/base/ftmac.c
@@ -1005,6 +1005,7 @@
    *   accepts an FSRef instead of a path.
    *
    * This function is deprecated because Carbon data types (FSRef)
+   * are not cross-platform, and thus not suitable for the FreeType API.
    */
   FT_EXPORT_DEF( FT_Error )
   FT_New_Face_From_FSRef( FT_Library    library,
@@ -1049,6 +1050,7 @@
    *   FT_New_Face_From_FSSpec is identical to FT_New_Face except it
    *   accepts an FSSpec instead of a path.
    *
+   * This function is deprecated because FSSpec is deprecated in Mac OS X
    */
   FT_EXPORT_DEF( FT_Error )
   FT_New_Face_From_FSSpec( FT_Library     library,
diff --git a/src/psaux/cffdecode.c b/src/psaux/cffdecode.c
index 5bcb59b..024eb9c 100644
--- a/src/psaux/cffdecode.c
+++ b/src/psaux/cffdecode.c
@@ -396,6 +396,7 @@
    *     The number of glyph subroutines.
    *
    * @Return:
+   *   The bias value.
    */
   static FT_Int
   cff_compute_bias( FT_Int   in_charstring_type,
diff --git a/src/psaux/psintrp.c b/src/psaux/psintrp.c
index 09c9802..8436145 100644
--- a/src/psaux/psintrp.c
+++ b/src/psaux/psintrp.c
@@ -1653,6 +1653,7 @@
                      * known_othersubr_result_cnt
                      *
                      * for unhandled othersubrs the following pops adjust
+                     * the stack pointer as necessary
                      */
 
                     count = cf2_stack_count( opStack );
diff --git a/src/psaux/t1decode.c b/src/psaux/t1decode.c
index d05c9e2..6bbce4d 100644
--- a/src/psaux/t1decode.c
+++ b/src/psaux/t1decode.c
@@ -774,6 +774,7 @@
          * known_othersubr_result_cnt
          *
          * for unhandled othersubrs the following pops adjust the
+         * stack pointer as necessary
          */
 
         if ( arg_cnt > top - decoder->stack )
diff --git a/src/raster/ftraster.h b/src/raster/ftraster.h
index f01bfcf..3f13793 100644
--- a/src/raster/ftraster.h
+++ b/src/raster/ftraster.h
@@ -32,7 +32,6 @@ FT_BEGIN_HEADER
    *
    * Uncomment the following line if you are using ftraster.c as a
    * standalone module, fully independent of FreeType.
-   *
    */
 /* #define STANDALONE_ */
 
diff --git a/src/sfnt/ttcmap.c b/src/sfnt/ttcmap.c
index 24bf2ad..a3a8c52 100644
--- a/src/sfnt/ttcmap.c
+++ b/src/sfnt/ttcmap.c
@@ -2941,6 +2941,7 @@
    *                                this range
    *   GID            3     USHORT  and its GID
    *
+   * Ranges are sorted by `uniStart'.
    */
 
 #ifdef TT_CONFIG_CMAP_FORMAT_14
diff --git a/src/truetype/ttinterp.c b/src/truetype/ttinterp.c
index 9457297..da45c37 100644
--- a/src/truetype/ttinterp.c
+++ b/src/truetype/ttinterp.c
@@ -7446,6 +7446,7 @@
      * Selector Bit:  3
      * Return Bit(s): 10
      *
+     * XXX: UNDOCUMENTED!
      */
     if ( (args[0] & 8 ) != 0 && exc->face->blend )
       K |= 1 << 10;
@@ -7472,6 +7473,7 @@
        * Selector Bit:  6
        * Return Bit(s): 13
        *
+       * v40 does subpixel hinting by default.
        */
       if ( ( args[0] & 64 ) != 0 )
         K |= 1 << 13;
@@ -7489,6 +7491,7 @@
        * Selector Bit:  10
        * Return Bit(s): 17
        *
+       * XXX: FreeType supports it, dependent on what client does?
        */
       if ( ( args[0] & 1024 ) != 0 )
         K |= 1 << 17;
@@ -7499,6 +7502,7 @@
        * Return Bit(s): 18
        *
        * The only smoothing method FreeType supports unless someone sets
+       * FT_LOAD_TARGET_MONO.
        */
       if ( ( args[0] & 2048 ) != 0 && exc->subpixel_hinting_lean )
         K |= 1 << 18;
@@ -7510,6 +7514,7 @@
        * Return Bit(s): 19
        *
        * Grayscale rendering is what FreeType does anyway unless someone
+       * sets FT_LOAD_TARGET_MONO or FT_LOAD_TARGET_LCD(_V)
        */
       if ( ( args[0] & 4096 ) != 0 && exc->grayscale_cleartype )
         K |= 1 << 19;
@@ -7537,6 +7542,7 @@
          * Selector Bit:  7
          * Return Bit(s): 14
          *
+         * Functionality still needs to be added
          */
         if ( ( args[0] & 128 ) != 0 && exc->compatible_widths )
           K |= 1 << 14;
@@ -7546,6 +7552,7 @@
          * Selector Bit:  8
          * Return Bit(s): 15
          *
+         * Functionality still needs to be added
          */
         if ( ( args[0] & 256 ) != 0 && exc->vertical_lcd )
           K |= 1 << 15;
@@ -7555,6 +7562,7 @@
          * Selector Bit:  9
          * Return Bit(s): 16
          *
+         * Functionality still needs to be added
          */
         if ( ( args[0] & 512 ) != 0 && exc->bgr )
           K |= 1 << 16;
@@ -7566,6 +7574,7 @@
            * Selector Bit:  10
            * Return Bit(s): 17
            *
+           * Functionality still needs to be added
            */
           if ( ( args[0] & 1024 ) != 0 && exc->subpixel_positioned )
             K |= 1 << 17;
@@ -7575,6 +7584,7 @@
            * Selector Bit:  11
            * Return Bit(s): 18
            *
+           * Functionality still needs to be added
            */
           if ( ( args[0] & 2048 ) != 0 && exc->symmetrical_smoothing )
             K |= 1 << 18;
@@ -7584,6 +7594,7 @@
            * Selector Bit:  12
            * Return Bit(s): 19
            *
+           * Functionality still needs to be added
            */
           if ( ( args[0] & 4096 ) != 0 && exc->gray_cleartype )
             K |= 1 << 19;