ref: e899991b5e729b48ed219e15727c6fbb39c7e18f
parent: 2b0b4221abba6497e05183d58c6a36821b9cce06
author: Werner Lemberg <[email protected]>
date: Sat May 31 03:03:30 EDT 2008
More doc fixes to improve HTML version.
--- a/include/freetype/config/ftconfig.h
+++ b/include/freetype/config/ftconfig.h
@@ -139,12 +139,64 @@
/*************************************************************************/
/* */
- /* IntN types */
+ /* <Section> */
+ /* basic_types */
/* */
- /* Used to guarantee the size of some specific integers. */
+ /*************************************************************************/
+
+
+ /*************************************************************************/
/* */
- typedef signed short FT_Int16;
+ /* <Type> */
+ /* FT_Int16 */
+ /* */
+ /* <Description> */
+ /* A typedef for a 16bit signed integer type. */
+ /* */
+ typedef signed short FT_Int16;
+
+
+ /*************************************************************************/
+ /* */
+ /* <Type> */
+ /* FT_UInt16 */
+ /* */
+ /* <Description> */
+ /* A typedef for a 16bit unsigned integer type. */
+ /* */
typedef unsigned short FT_UInt16;
+
+ /* */
+
+
+ /* this #if 0 ... #endif clause is for documentation purposes */
+#if 0
+
+ /*************************************************************************/
+ /* */
+ /* <Type> */
+ /* FT_Int32 */
+ /* */
+ /* <Description> */
+ /* A typedef for a 32bit signed integer type. The size depends on */
+ /* the configuration. */
+ /* */
+ typedef signed XXX FT_Int32;
+
+
+ /*************************************************************************/
+ /* */
+ /* <Type> */
+ /* FT_UInt32 */
+ /* */
+ /* A typedef for a 32bit unsigned integer type. The size depends on */
+ /* the configuration. */
+ /* */
+ typedef unsigned XXX FT_UInt32;
+
+ /* */
+
+#endif
#if FT_SIZEOF_INT == (32 / FT_CHAR_BIT)
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -1250,7 +1250,7 @@
/* */
/* <Description> */
/* An opaque handle to an `FT_Size_InternalRec' structure, used to */
- /* model private data of a given FT_Size object. */
+ /* model private data of a given @FT_Size object. */
/* */
typedef struct FT_Size_InternalRec_* FT_Size_Internal;
@@ -1381,7 +1381,7 @@
/* */
/* <Description> */
/* An opaque handle to an `FT_Slot_InternalRec' structure, used to */
- /* model private data of a given FT_GlyphSlot object. */
+ /* model private data of a given @FT_GlyphSlot object. */
/* */
typedef struct FT_Slot_InternalRec_* FT_Slot_Internal;
@@ -2419,9 +2419,7 @@
#define FT_LOAD_IGNORE_TRANSFORM 0x800
#define FT_LOAD_MONOCHROME 0x1000
#define FT_LOAD_LINEAR_DESIGN 0x2000
-
- /* temporary hack! */
-#define FT_LOAD_SBITS_ONLY 0x4000
+#define FT_LOAD_SBITS_ONLY 0x4000 /* temporary hack! */
#define FT_LOAD_NO_AUTOHINT 0x8000U
/* */
--- a/include/freetype/ftgasp.h
+++ b/include/freetype/ftgasp.h
@@ -4,7 +4,7 @@
/* */
/* Access of TrueType's `gasp' table (specification). */
/* */
-/* Copyright 2007 by */
+/* Copyright 2007, 2008 by */
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
/* */
/* This file is part of the FreeType project, and may only be used, */
@@ -95,7 +95,7 @@
* ppem :: The vertical character pixel size.
*
* @return:
- * Bit flags (see @FT_GASP_XXX), or @FT_GASP_NO_TABLE is there is no
+ * Bit flags (see @FT_GASP_XXX), or @FT_GASP_NO_TABLE if there is no
* `gasp' table in the face.
*
* @since:
--- a/include/freetype/ftimage.h
+++ b/include/freetype/ftimage.h
@@ -5,7 +5,7 @@
/* FreeType glyph image formats and default raster interface */
/* (specification). */
/* */
-/* Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006, 2007 by */
+/* Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by */
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
/* */
/* This file is part of the FreeType project, and may only be used, */
@@ -206,7 +206,7 @@
/* An enumeration type to describe the format of a bitmap palette, */
/* used with ft_pixel_mode_pal4 and ft_pixel_mode_pal8. */
/* */
- /* <Fields> */
+ /* <Values> */
/* ft_palette_mode_rgb :: The palette is an array of 3-bytes RGB */
/* records. */
/* */
@@ -222,7 +222,7 @@
ft_palette_mode_rgb = 0,
ft_palette_mode_rgba,
- ft_palettte_mode_max /* do not remove */
+ ft_palette_mode_max /* do not remove */
} FT_Palette_Mode;
@@ -491,6 +491,7 @@
#define FT_Outline_MoveTo_Func FT_Outline_MoveToFunc
+
/*************************************************************************/
/* */
/* <FuncType> */
@@ -517,6 +518,7 @@
#define FT_Outline_LineTo_Func FT_Outline_LineToFunc
+
/*************************************************************************/
/* */
/* <FuncType> */
@@ -548,6 +550,7 @@
#define FT_Outline_ConicTo_Func FT_Outline_ConicToFunc
+
/*************************************************************************/
/* */
/* <FuncType> */
@@ -869,7 +872,7 @@
const FT_Span* spans,
void* user );
-#define FT_Raster_Span_Func FT_SpanFunc
+#define FT_Raster_Span_Func FT_SpanFunc
/*************************************************************************/
@@ -1074,7 +1077,7 @@
(*FT_Raster_NewFunc)( void* memory,
FT_Raster* raster );
-#define FT_Raster_New_Func FT_Raster_NewFunc
+#define FT_Raster_New_Func FT_Raster_NewFunc
/*************************************************************************/
@@ -1091,7 +1094,7 @@
typedef void
(*FT_Raster_DoneFunc)( FT_Raster raster );
-#define FT_Raster_Done_Func FT_Raster_DoneFunc
+#define FT_Raster_Done_Func FT_Raster_DoneFunc
/*************************************************************************/
@@ -1126,7 +1129,7 @@
unsigned char* pool_base,
unsigned long pool_size );
-#define FT_Raster_Reset_Func FT_Raster_ResetFunc
+#define FT_Raster_Reset_Func FT_Raster_ResetFunc
/*************************************************************************/
@@ -1193,7 +1196,7 @@
(*FT_Raster_RenderFunc)( FT_Raster raster,
const FT_Raster_Params* params );
-#define FT_Raster_Render_Func FT_Raster_RenderFunc
+#define FT_Raster_Render_Func FT_Raster_RenderFunc
/*************************************************************************/
--- a/include/freetype/ftmodapi.h
+++ b/include/freetype/ftmodapi.h
@@ -78,12 +78,50 @@
typedef FT_Pointer FT_Module_Interface;
+
+ /*************************************************************************/
+ /* */
+ /* <FuncType> */
+ /* FT_Module_Constructor */
+ /* */
+ /* <Description> */
+ /* A function used to initialize (not create) a new module object. */
+ /* */
+ /* <Input> */
+ /* module :: The module to initialize. */
+ /* */
typedef FT_Error
(*FT_Module_Constructor)( FT_Module module );
+
+ /*************************************************************************/
+ /* */
+ /* <FuncType> */
+ /* FT_Module_Destructor */
+ /* */
+ /* <Description> */
+ /* A function used to finalize (not destroy) a given module object. */
+ /* */
+ /* <Input> */
+ /* module :: The module to finalize. */
+ /* */
typedef void
(*FT_Module_Destructor)( FT_Module module );
+
+ /*************************************************************************/
+ /* */
+ /* <FuncType> */
+ /* FT_Module_Requester */
+ /* */
+ /* <Description> */
+ /* A function used to query a given module for a specific interface. */
+ /* */
+ /* <Input> */
+ /* module :: The module to finalize. */
+ /* */
+ /* name :: The name of the interface in the module. */
+ /* */
typedef FT_Module_Interface
(*FT_Module_Requester)( FT_Module module,
const char* name );
@@ -112,14 +150,11 @@
/* as a 16.16 fixed number (major.minor). Starts */
/* at version 2.0, i.e., 0x20000. */
/* */
- /* module_init :: A function used to initialize (not create) a */
- /* new module object. */
+ /* module_init :: The initializing function. */
/* */
- /* module_done :: A function used to finalize (not destroy) a */
- /* given module object */
+ /* module_done :: The finalizing function. */
/* */
- /* get_interface :: Queries a given module for a specific */
- /* interface by name. */
+ /* get_interface :: The interface requesting function. */
/* */
typedef struct FT_Module_Class_
{--- a/include/freetype/ftrender.h
+++ b/include/freetype/ftrender.h
@@ -124,27 +124,32 @@
/* The renderer module class descriptor. */
/* */
/* <Fields> */
- /* root :: The root @FT_Module_Class fields. */
+ /* root :: The root @FT_Module_Class fields. */
/* */
- /* glyph_format :: The glyph image format this renderer handles. */
+ /* glyph_format :: The glyph image format this renderer handles. */
/* */
- /* render_glyph :: A method used to render the image that is in a */
- /* given glyph slot into a bitmap. */
+ /* render_glyph :: A method used to render the image that is in a */
+ /* given glyph slot into a bitmap. */
/* */
- /* set_mode :: A method used to pass additional parameters. */
+ /* transform_glyph :: A method used to transform the image that is in */
+ /* a given glyph slot. */
/* */
- /* raster_class :: For @FT_GLYPH_FORMAT_OUTLINE renderers only. This */
- /* is a pointer to its raster's class. */
+ /* get_glyph_cbox :: A method used to access the glyph's cbox. */
/* */
- /* raster :: For @FT_GLYPH_FORMAT_OUTLINE renderers only. This */
- /* is a pointer to the corresponding raster object, */
- /* if any. */
+ /* set_mode :: A method used to pass additional parameters. */
/* */
+ /* raster_class :: For @FT_GLYPH_FORMAT_OUTLINE renderers only. */
+ /* This is a pointer to its raster's class. */
+ /* */
+ /* raster :: For @FT_GLYPH_FORMAT_OUTLINE renderers only. */
+ /* This is a pointer to the corresponding raster */
+ /* object, if any. */
+ /* */
typedef struct FT_Renderer_Class_
{- FT_Module_Class root;
+ FT_Module_Class root;
- FT_Glyph_Format glyph_format;
+ FT_Glyph_Format glyph_format;
FT_Renderer_RenderFunc render_glyph;
FT_Renderer_TransformFunc transform_glyph;
--- a/include/freetype/fttypes.h
+++ b/include/freetype/fttypes.h
@@ -4,7 +4,7 @@
/* */
/* FreeType simple types definitions (specification only). */
/* */
-/* Copyright 1996-2001, 2002, 2004, 2006, 2007 by */
+/* Copyright 1996-2001, 2002, 2004, 2006, 2007, 2008 by */
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
/* */
/* This file is part of the FreeType project, and may only be used, */
@@ -53,6 +53,10 @@
/* FT_Char */
/* FT_Int */
/* FT_UInt */
+ /* FT_Int16 */
+ /* FT_UInt16 */
+ /* FT_Int32 */
+ /* FT_UInt32 */
/* FT_Short */
/* FT_UShort */
/* FT_Long */
--- a/include/freetype/t1tables.h
+++ b/include/freetype/t1tables.h
@@ -294,6 +294,14 @@
typedef PS_BlendRec T1_Blend;
+ /*************************************************************************/
+ /* */
+ /* <Struct> */
+ /* CID_FaceDictRec */
+ /* */
+ /* <Description> */
+ /* A structure used to represent data in a CID top-level dictionary. */
+ /* */
typedef struct CID_FaceDictRec_
{PS_PrivateRec private_dict;
@@ -312,7 +320,20 @@
FT_ULong subrmap_offset;
FT_Int sd_bytes;
- } CID_FaceDictRec, *CID_FaceDict;
+ } CID_FaceDictRec;
+
+
+ /*************************************************************************/
+ /* */
+ /* <Struct> */
+ /* CID_FaceDict */
+ /* */
+ /* <Description> */
+ /* A handle to a @CID_FaceDictRec structure. */
+ /* */
+ typedef struct CID_FaceDictRec_* CID_FaceDict;
+
+ /* */
/* backwards-compatible definition */
--- a/include/freetype/ttnameid.h
+++ b/include/freetype/ttnameid.h
@@ -4,7 +4,7 @@
/* */
/* TrueType name ID definitions (specification only). */
/* */
-/* Copyright 1996-2002, 2003, 2004, 2006, 2007 by */
+/* Copyright 1996-2002, 2003, 2004, 2006, 2007, 2008 by */
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
/* */
/* This file is part of the FreeType project, and may only be used, */
@@ -295,6 +295,8 @@
* Adobe expert encoding.
* TT_ADOBE_ID_CUSTOM ::
* Adobe custom encoding.
+ * TT_ADOBE_ID_LATIN_1 ::
+ * Adobe Latin 1 encoding.
*/
#define TT_ADOBE_ID_STANDARD 0