Commit a854699b41a6d43d220e2be50088b974499c26b7

Werner Lemberg 2003-04-21T20:39:42

Small documentation improvements.

diff --git a/ChangeLog b/ChangeLog
index 718b045..ebbf9ea 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -251,9 +251,9 @@
 	* src/gzip/ftgzip.c: Bugfix: couldn't read certain gzip-ed font
 	files.
 
-2003-01-15  Huw D M Davies <h.davies1@physics.ox.ac.uk>
+2003-01-15  Huw D M Davies  <h.davies1@physics.ox.ac.uk>
 
-	* include/freetype/config/ftheader.h,
+	* include/freetype/config/ftheader.h (FT_WINFONTS_H),
 	include/freetype/internal/fnttypes.h, include/freetype/ftwinfnt.h,
 	src/base/winfnt.c, src/winfonts/winfnt.c, src/base/Jamfile,
 	src/base/rules.mk, src/base/descrip.mms: Added a Windows .FNT
@@ -278,18 +278,25 @@
 
 2003-01-11  David Chester  <davidchester@qmx.net>
 
-	* include/freetype/config/ftoption.h, src/autohint/ahglobal.h,
-	src/autohint/ahglobal.c, src/autohint/ahglyph.c,
-	src/autohint/ahtypes.h: Patches to the auto-hinter in order to
-	slightly improve the output.  Note that everything is controlled
-	through the new FT_CONFIG_OPTION_CHESTER_HINTS defined at the end of
-	"ftoption.h".  There are also individual FT_CONFIG_CHESTER_XXX
-	macros to control individual "features".
+	Patches to the auto-hinter in order to slightly improve the output. 
+	Note that everything is controlled through the new
+	FT_CONFIG_OPTION_CHESTER_HINTS defined in "ftoption.h".  There are
+	also individual FT_CONFIG_CHESTER_XXX macros to control individual
+	"features".
 
 	Note that all improvements are enabled by default, but can be
 	tweaked for optimization and testing purposes.  The configuration
 	macros will most likely disappear in the short future.
 
+	* include/freetype/config/ftoption.h
+	(FT_CONFIG_OPTION_CHESTER_HINTS): New macro.
+	(FT_CONFIG_CHESTER_{SMALL_F,ASCENDER,SERIF,STEM,BLUE_SCALE})
+	[FT_CONFIG_OPTION_CHESTER_HINTS]: New macros to control individual
+	features.
+
+	* src/autohint/ahglobal.h, src/autohint/ahglobal.c,
+	src/autohint/ahglyph.c, src/autohint/ahtypes.h:
+
 2003-01-11  David Turner  <david@freetype.org>
 
 	* include/freetype/internal/fnttypes.h: Fixed a structure field
@@ -432,7 +439,7 @@
 	the use of system-wide zlib.
 
 	Note that this macro, as well as
-	FT_CONFIG_OPTION_BYTECODE_INTERPRETER, is not #undef-ed anymore.
+	FT_CONFIG_OPTION_BYTECODE_INTERPRETER, is not #undef-ed anymore. 
 	This allows the build system to define them depending on the
 	configuration (typically by adding -D flags at compile time).
 
@@ -464,10 +471,22 @@
 
 	* include/freetype/ftgzip.h, src/gzip/ftgzip.c: Adding support for
 	gzip compressed streams.
+	* include/freetype/config/ftheader.h (FT_GZIP_H): New macro for
+	`ftgzip.h'.
 
 	* src/pcf/pcfdriver.c: Adding automatic support for gzip-compressed
 	PCF files.
 
+	* include/freetype/config/ftoption.h (FT_CONFIG_OPTION_USE_ZLIB):
+	New macro.
+	(T1_CONFIG_OPTION_DISABLE_HINTER, FT_CONFIG_OPTION_USE_CMAPS
+	FT_CONFIG_OPTION_NO_CONVENIENCE_FUNCS,
+	FT_CONFIG_OPTION_ALTERNATE_GLYPH_FORMATS): Removed.
+
+	(FT_EXPORT, FT_EXPORT_DEF, FT_DEBUG_LEVEL_ERROR,
+	FT_DEBUG_LEVEL_TRACE, FT_DEBUG_MEMORY): Comment out definitions so
+	that platform specific configuration file can override.
+
 2002-10-30  David Turner  <david@freetype.org>
 
 	* FreeType 2.1.3rc3 released
diff --git a/include/freetype/config/ftoption.h b/include/freetype/config/ftoption.h
index 44117cd..13e70ee 100644
--- a/include/freetype/config/ftoption.h
+++ b/include/freetype/config/ftoption.h
@@ -81,16 +81,16 @@ FT_BEGIN_HEADER
   /* by FreeType to speed up some computations.  However, this will create */
   /* some problems when compiling the library in strict ANSI mode.         */
   /*                                                                       */
-  /* For this reason, the use of 64-bit ints is normally disabled when     */
+  /* For this reason, the use of 64-bit integers is normally disabled when */
   /* the __STDC__ macro is defined.  You can however disable this by       */
-  /* defining here the macro FT_CONFIG_OPTION_FORCE_INT64.                 */
+  /* defining the macro FT_CONFIG_OPTION_FORCE_INT64 here.                 */
   /*                                                                       */
-  /* For most compilers, this will only create compilation warnings        */
-  /* when building the library.                                            */
+  /* For most compilers, this will only create compilation warnings when   */
+  /* building the library.                                                 */
   /*                                                                       */
   /* ObNote: The compiler-specific 64-bit integers are detected in the     */
-  /*         file "ftconfig.h" either statically, or through Autoconf      */
-  /*         on platforms that support it.                                 */
+  /*         file "ftconfig.h" either statically or through the            */
+  /*         `configure' script on supported platforms.                    */
   /*                                                                       */
 #undef  FT_CONFIG_OPTION_FORCE_INT64
 
@@ -100,11 +100,11 @@ FT_BEGIN_HEADER
   /* Gzip-compressed file support.                                         */
   /*                                                                       */
   /*   FreeType now handles font files that have been compressed with the  */
-  /*   'gzip' program. This is mostly used to parse many of the PCF files  */
-  /*   that come with XFree86. The implementation uses 'zlib' to           */
+  /*   'gzip' program.  This is mostly used to parse many of the PCF files */
+  /*   that come with XFree86.  The implementation uses `zlib' to          */
   /*   partially uncompress the file on the fly (see src/base/ftgzip.c).   */
   /*                                                                       */
-  /*   Define this macro if you want to enable this "feature". Note that   */
+  /*   Define this macro if you want to enable this "feature".  Note that  */
   /*   this will however force you to link the zlib to any program that    */
   /*   also uses FreeType.                                                 */
   /*                                                                       */
@@ -117,17 +117,17 @@ FT_BEGIN_HEADER
   /*                                                                       */
   /*   This macro is only used when FT_CONFIG_OPTION_USE_ZLIB is defined.  */
   /*   It allows FreeType's "ftgzip" component to link to the system's     */
-  /*   installation of the ZLib library. This is useful on systems like    */
+  /*   installation of the ZLib library.  This is useful on systems like   */
   /*   Unix or VMS where it generally is already available.                */
   /*                                                                       */
   /*   If you let it undefined, the component will use its own copy        */
-  /*   of the zlib sources instead. These have been modified to be         */
+  /*   of the zlib sources instead.  These have been modified to be        */
   /*   included directly within the component and *not* export external    */
-  /*   function names. This allows you to link any program with FreeType   */
+  /*   function names.  This allows you to link any program with FreeType  */
   /*   _and_ ZLib without linking conflicts.                               */
   /*                                                                       */
-  /*   do not #undef this macro here, since the build system might         */
-  /*   define for certain configurations                                   */
+  /*   Do not #undef this macro here since the build system might define   */
+  /*   it for certain configurations only.                                 */
   /*                                                                       */
 /* #define  FT_CONFIG_OPTION_SYSTEM_ZLIB */
 
@@ -167,6 +167,9 @@ FT_BEGIN_HEADER
   /*   will be later automatically defined as `extern return_type' to      */
   /*   allow normal compilation.                                           */
   /*                                                                       */
+  /*   Do not #undef these macros here since the build system might define */
+  /*   them for certain configurations only.                               */
+  /*                                                                       */
 /* #define  FT_EXPORT(x)       extern x */
 /* #define  FT_EXPORT_DEF(x)   x */
 
@@ -221,7 +224,7 @@ FT_BEGIN_HEADER
   /* This allows FreeType to be used with the PostScript language, using   */
   /* the GhostScript interpreter.                                          */
   /*                                                                       */
-/* #define  FT_CONFIG_OPTION_INCREMENTAL */
+/* #define FT_CONFIG_OPTION_INCREMENTAL */
 
 
   /*************************************************************************/
@@ -229,7 +232,7 @@ FT_BEGIN_HEADER
   /* The size in bytes of the render pool used by the scan-line converter  */
   /* to do all of its work.                                                */
   /*                                                                       */
-  /* This must be greater than 4kByte.                                     */
+  /* This must be greater than 4KByte.                                     */
   /*                                                                       */
 #define FT_RENDER_POOL_SIZE  16384L
 
@@ -258,8 +261,11 @@ FT_BEGIN_HEADER
   /*                                                                       */
   /*   Don't define any of these macros to compile in `release' mode!      */
   /*                                                                       */
-/* #define  FT_DEBUG_LEVEL_ERROR */
-/* #define  FT_DEBUG_LEVEL_TRACE */
+  /*   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 */
 
 
   /*************************************************************************/
@@ -274,8 +280,10 @@ FT_BEGIN_HEADER
   /*   Note that the memory debugger is only activated at runtime when     */
   /*   when the _environment_ variable "FT_DEBUG_MEMORY" is also defined!  */
   /*                                                                       */
-/* #define  FT_DEBUG_MEMORY */
-
+  /*   Do not #undef this macro here since the build system might define   */
+  /*   it for certain configurations only.                                 */
+  /*                                                                       */
+/* #define FT_DEBUG_MEMORY */
 
 
   /*************************************************************************/
@@ -375,8 +383,8 @@ FT_BEGIN_HEADER
   /* By undefining this, you will only compile the code necessary to load  */
   /* TrueType glyphs without hinting.                                      */
   /*                                                                       */
-  /*   do not #undef this macro here, since the build system might         */
-  /*   define for certain configurations                                   */
+  /*   Do not #undef this macro here, since the build system might         */
+  /*   define it for certain configurations only.                          */
   /*                                                                       */
 /* #define  TT_CONFIG_OPTION_BYTECODE_INTERPRETER */
 
@@ -470,21 +478,21 @@ FT_BEGIN_HEADER
  /* */
 
 /*
- * the FT_CONFIG_OPTION_CHESTER_XXXX macros are used to toggle some recent
- * improvements to the auto-hinter contributed by David Chester. They will
- * most likely disappear completely in the next release. For now, you should
- * always keep them defined
+ * The FT_CONFIG_OPTION_CHESTER_XXXX macros are used to toggle some recent
+ * improvements to the auto-hinter contributed by David Chester.  They will
+ * most likely disappear completely in the next release.  For now, you
+ * should always keep them defined.
  *
  */
 #define  FT_CONFIG_OPTION_CHESTER_HINTS
 
 #ifdef   FT_CONFIG_OPTION_CHESTER_HINTS
 
-#  define  FT_CONFIG_CHESTER_SMALL_F
-#  define  FT_CONFIG_CHESTER_ASCENDER
-#  define  FT_CONFIG_CHESTER_SERIF
-#  define  FT_CONFIG_CHESTER_STEM
-#  define  FT_CONFIG_CHESTER_BLUE_SCALE
+#define  FT_CONFIG_CHESTER_SMALL_F
+#define  FT_CONFIG_CHESTER_ASCENDER
+#define  FT_CONFIG_CHESTER_SERIF
+#define  FT_CONFIG_CHESTER_STEM
+#define  FT_CONFIG_CHESTER_BLUE_SCALE
 
 #endif /* FT_CONFIG_OPTION_CHESTER_HINTS */