Formatting, copyright years, documentation.

This commit is contained in:
Werner Lemberg 2006-04-22 12:24:52 +00:00
parent 7aa2010216
commit 8a8c6022bf
8 changed files with 152 additions and 112 deletions

View File

@ -1,16 +1,25 @@
2006-04-21 David Turner <david@freetype.org> 2006-04-21 David Turner <david@freetype.org>
* include/freetype/ftincrem.h, include/freetype/ftmodapi.h, * include/freetype/ftincrem.h: Documentation updates.
include/freetype/freetype.h: Documentation update (FT_Incremental_Interface): New typedef.
* src/sfnt/ttcmap.c: removed compiler warnings (gcc-4.0.2) * include/freetype/ftmodapi.h, include/freetype/ftglyph.h:
Documentation updates.
* include/freetype/freetype.h: Documentation update.
(FT_HAS_FAST_GLYPHS): Always set to 0.
* include/freetype/ftstroke.h, src/base/ftstroke.c (FT_Stroker_New):
Take an FT_Library argument instead of FT_Memory.
* src/sfnt/ttcmap.c: Remove compiler warnings (gcc-4.0.2).
2006-04-13 David Turner <david@freetype.org> 2006-04-13 David Turner <david@freetype.org>
* src/autofit/afloader.c: removing superfluous code in the auto-fitter's * src/autofit/afloader.c (af_loader_init, af_loader_load_g): Remove
loader superfluous code in the auto-fitter's loader.
2006-04-05 Detlef Wrkner <TetiSoft@apg.lahn.de> 2006-04-05 Detlef Würkner <TetiSoft@apg.lahn.de>
* builds/amiga/makefile, builds/amiga/makefile.os4, * builds/amiga/makefile, builds/amiga/makefile.os4,
builds/amiga/smakefile: Added FT2_BUILD_LIBRARY define. builds/amiga/smakefile: Added FT2_BUILD_LIBRARY define.
@ -43,7 +52,7 @@
* builds/unix/install.mk (uninstall): Don't handle `cache' * builds/unix/install.mk (uninstall): Don't handle `cache'
directory which no longer exists. directory which no longer exists.
2006-03-29 Detlef Wrkner <TetiSoft@apg.lahn.de> 2006-03-29 Detlef Würkner <TetiSoft@apg.lahn.de>
* src/psaux/psconv.c: Changed some variables which are expected to * src/psaux/psconv.c: Changed some variables which are expected to
hold negative values from `char' to `FT_Char' to allow building with hold negative values from `char' to `FT_Char' to allow building with
@ -1622,7 +1631,7 @@
(tt_face_build_cmaps): Check table and offset correctly (equality is (tt_face_build_cmaps): Check table and offset correctly (equality is
missing). missing).
2005-11-15 Detlef Wrkner <TetiSoft@apg.lahn.de> 2005-11-15 Detlef Würkner <TetiSoft@apg.lahn.de>
* builds/amiga/smakefile: Adjusted the compiler options * builds/amiga/smakefile: Adjusted the compiler options
to the current sources, now really builds the gxvalid, gzip to the current sources, now really builds the gxvalid, gzip
@ -1640,7 +1649,7 @@
builds/mac/FreeType.ppc_carbon.make.txt: builds/mac/FreeType.ppc_carbon.make.txt:
Updated for MPW to build all available modules. Updated for MPW to build all available modules.
2005-11-21 H<EFBFBD>ard Wall <haavardw@ifi.uio.no> 2005-11-21 Håvard Wall <haavardw@ifi.uio.no>
* src/bdf/bdfdrivr.c (bdf_interpret_style, BDF_Face_Done): Fix small * src/bdf/bdfdrivr.c (bdf_interpret_style, BDF_Face_Done): Fix small
memory leak. memory leak.
@ -1699,14 +1708,14 @@
FT_Done_Memory), builds/win32/ftdebug.c (FT_Message, FT_Panic): FT_Done_Memory), builds/win32/ftdebug.c (FT_Message, FT_Panic):
s/FT_EXPORT/FT_BASE/. s/FT_EXPORT/FT_BASE/.
2005-11-17 Detlef Wrkner <TetiSoft@apg.lahn.de> 2005-11-17 Detlef Würkner <TetiSoft@apg.lahn.de>
* builds/amiga/src/base/ftdebug.c (FT_Trace_Get_Count, * builds/amiga/src/base/ftdebug.c (FT_Trace_Get_Count,
FT_Trace_Get_Name, FT_Message, FT_Panic), FT_Trace_Get_Name, FT_Message, FT_Panic),
builds/amiga/src/base/ftsystem.c (FT_New_Memory, FT_Done_Memory, builds/amiga/src/base/ftsystem.c (FT_New_Memory, FT_Done_Memory,
FT_Stream_Open): s/FT_EXPORT/FT_BASE/. FT_Stream_Open): s/FT_EXPORT/FT_BASE/.
2005-11-17 Detlef Wrkner <TetiSoft@apg.lahn.de> 2005-11-17 Detlef Würkner <TetiSoft@apg.lahn.de>
* builds/amiga/makefile, builds/amiga/makefile.os4, * builds/amiga/makefile, builds/amiga/makefile.os4,
builds/amiga/smakefile, builds/amiga/smakefile,
@ -1790,7 +1799,7 @@
* src/type1/t1afm.c (T1_Read_PFM): Zero offset means `no kerning * src/type1/t1afm.c (T1_Read_PFM): Zero offset means `no kerning
table available'. From Sergey Tolstov <stolstov@esri.com>. table available'. From Sergey Tolstov <stolstov@esri.com>.
2005-11-03 Ville Syrj<EFBFBD><EFBFBD> <syrjala@sci.fi> 2005-11-03 Ville Syrjälä <syrjala@sci.fi>
* src/base/ftobjs.c (FT_Open_Face): Avoid possible memory leak. * src/base/ftobjs.c (FT_Open_Face): Avoid possible memory leak.

View File

@ -211,8 +211,8 @@ FT_BEGIN_HEADER
/* <Description> */ /* <Description> */
/* A structure used to model the metrics of a single glyph. The */ /* A structure used to model the metrics of a single glyph. The */
/* values are expressed in 26.6 fractional pixel format; if the flag */ /* values are expressed in 26.6 fractional pixel format; if the flag */
/* @FT_LOAD_NO_SCALE was used when loading the glyph, values are */ /* @FT_LOAD_NO_SCALE has been used while loading the glyph, values */
/* expressed in font units instead. */ /* are expressed in font units instead. */
/* */ /* */
/* <Fields> */ /* <Fields> */
/* width :: */ /* width :: */
@ -412,16 +412,16 @@ FT_BEGIN_HEADER
/* */ /* */
/* <Note> */ /* <Note> */
/* Each @FT_Face has an _active_ @FT_Size object that is used by */ /* Each @FT_Face has an _active_ @FT_Size object that is used by */
/* functions like @FT_Load_Glyph to determine the scaling transform */ /* functions like @FT_Load_Glyph to determine the scaling */
/* used to load and hint glyph and metrics. */ /* transformation which is used to load and hint glyphs and metrics. */
/* */ /* */
/* You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, */ /* You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, */
/* @FT_Request_Size or even @FT_Select_Size to change the content */ /* @FT_Request_Size or even @FT_Select_Size to change the content */
/* (i.e. scale) of the active @FT_Size. */ /* (i.e., the scaling values) of the active @FT_Size. */
/* */ /* */
/* You can use @FT_New_Size to create additionnal size objects for a */ /* You can use @FT_New_Size to create additional size objects for a */
/* given @FT_Face, but they won't be used by other functions until */ /* given @FT_Face, but they won't be used by other functions until */
/* you activate it through @FT_Activate_Size. Only one size can be */ /* you activate it through @FT_Activate_Size. Only one size can be */
/* activated at any given time per face. */ /* activated at any given time per face. */
/* */ /* */
/* <Also> */ /* <Also> */
@ -520,12 +520,12 @@ FT_BEGIN_HEADER
/* */ /* */
/* <Description> */ /* <Description> */
/* An enumeration used to specify character sets supported by */ /* An enumeration used to specify character sets supported by */
/* charmaps. Used in the @FT_Select_Charmap API function. */ /* charmaps. Used in the @FT_Select_Charmap API function. */
/* */ /* */
/* <Note> */ /* <Note> */
/* Despite the name, this enum lists specific character repertories */ /* Despite the name, this enumeration lists specific character */
/* (i.e. charsets), and not text encoding methods (e.g. UTF-8, */ /* repertories (i.e., charsets), and not text encoding methods (e.g., */
/* UTF-16, GB2312_EUC, etc...) */ /* UTF-8, UTF-16, GB2312_EUC, etc.). */
/* */ /* */
/* Because of 32-bit charcodes defined in Unicode (i.e., surrogates), */ /* Because of 32-bit charcodes defined in Unicode (i.e., surrogates), */
/* all character codes must be expressed as FT_Longs. */ /* all character codes must be expressed as FT_Longs. */
@ -1156,10 +1156,10 @@ FT_BEGIN_HEADER
* FT_HAS_FAST_GLYPHS( face ) * FT_HAS_FAST_GLYPHS( face )
* *
* @description: * @description:
* Deprecated; * Deprecated.
* *
*/ */
#define FT_HAS_FAST_GLYPHS( face ) 0 #define FT_HAS_FAST_GLYPHS( face ) 0
/************************************************************************* /*************************************************************************
@ -1334,7 +1334,7 @@ FT_BEGIN_HEADER
/* hence the forward structure declaration. */ /* hence the forward structure declaration. */
/* */ /* */
/* You can however retrieve subglyph information with */ /* You can however retrieve subglyph information with */
/* @FT_Get_SubGlyph_Info */ /* @FT_Get_SubGlyph_Info. */
/* */ /* */
typedef struct FT_SubGlyphRec_* FT_SubGlyph; typedef struct FT_SubGlyphRec_* FT_SubGlyph;
@ -1945,7 +1945,7 @@ FT_BEGIN_HEADER
/* depends on the font format (and thus the font driver). */ /* depends on the font format (and thus the font driver). */
/* */ /* */
/* Client applications are expected to know what they are doing */ /* Client applications are expected to know what they are doing */
/* when invoking this function. Most drivers simply do not implement */ /* when invoking this function. Most drivers simply do not implement */
/* file attachments. */ /* file attachments. */
/* */ /* */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -2912,11 +2912,11 @@ FT_BEGIN_HEADER
/* The glyph index. 0 means `undefined character code'. */ /* The glyph index. 0 means `undefined character code'. */
/* */ /* */
/* <Note> */ /* <Note> */
/* If you use FreeType to manipulate the content of font files */ /* If you use FreeType to manipulate the contents of font files */
/* directly, be aware that the glyph index returned by this function */ /* directly, be aware that the glyph index returned by this function */
/* doesn't always correspond to the internal indices used within */ /* doesn't always correspond to the internal indices used within */
/* the file. This is done to ensure that value 0 always correspond */ /* the file. This is done to ensure that value 0 always corresponds */
/* to 'missing glyph' */ /* to the `missing glyph'. */
/* */ /* */
FT_EXPORT( FT_UInt ) FT_EXPORT( FT_UInt )
FT_Get_Char_Index( FT_Face face, FT_Get_Char_Index( FT_Face face,

View File

@ -285,10 +285,10 @@ FT_BEGIN_HEADER
/* library :: The parent FreeType library handle to use. */ /* library :: The parent FreeType library handle to use. */
/* */ /* */
/* max_faces :: Maximum number of opened @FT_Face objects managed by */ /* max_faces :: Maximum number of opened @FT_Face objects managed by */
/* this cache instance. Use 0 for defaults */ /* this cache instance. Use 0 for defaults. */
/* */ /* */
/* max_sizes :: Maximum number of opened @FT_Size objects managed by */ /* max_sizes :: Maximum number of opened @FT_Size objects managed by */
/* this cache instance. Use 0 for defaults */ /* this cache instance. Use 0 for defaults. */
/* */ /* */
/* max_bytes :: Maximum number of bytes to use for cached data nodes. */ /* max_bytes :: Maximum number of bytes to use for cached data nodes. */
/* Use 0 for defaults. Note that this value does not */ /* Use 0 for defaults. Note that this value does not */
@ -500,27 +500,33 @@ FT_BEGIN_HEADER
FTC_Manager manager ); FTC_Manager manager );
/** /*************************************************************************
* @function: FTC_Manager_RemoveFaceID *
* * @function:
* @description: * FTC_Manager_RemoveFaceID
* a special function used to indicate to the cache manager that *
* a given @FTC_FaceID is no longer valid, either because it * @description:
* content changed, or because it was deallocated/uninstalled * A special function used to indicate to the cache manager that
* * a given @FTC_FaceID is no longer valid, either because its
* @input: * content changed, or because it was deallocated or uninstalled.
* manager :: cache manager handle *
* face_id :: the @FTC_FaceID to be removed * @input:
* * manager ::
* @note: * The cache manager handle.
* this function will flush all nodes from the cache corresponding *
* to this face_id, with the exception of nodes with a non-0 reference * face_id ::
* count. * The @FTC_FaceID to be removed.
* *
* these nodes are however modified internally so as to never appear * @note:
* in later lookups with the same face_id value, and to be immediately * This function flushes all nodes from the cache corresponding to this
* destroyed when released by all their users. * `face_id', with the exception of nodes with a non-null reference
*/ * count.
*
* Such nodes are however modified internally so as to never appear
* in later lookups with the same `face_id' value, and to be immediately
* destroyed when released by all their users.
*
*/
FT_EXPORT( void ) FT_EXPORT( void )
FTC_Manager_RemoveFaceID( FTC_Manager manager, FTC_Manager_RemoveFaceID( FTC_Manager manager,
FTC_FaceID face_id ); FTC_FaceID face_id );
@ -626,18 +632,29 @@ FT_BEGIN_HEADER
/*************************************************************************/ /*************************************************************************/
/*************************************************************************/ /*************************************************************************/
/**
* @struct: FTC_ImageTypeRec /*************************************************************************
* *
* @description: * @struct:
* a structure used to model the type of images in a glyph cache * FTC_ImageTypeRec
* *
* @fields: * @description:
* face_id :: the face id * A structure used to model the type of images in a glyph cache.
* width :: width in pixels *
* height :: height in pixels * @fields:
* flags :: load flags, as in @FT_Load_Glyph * face_id ::
*/ * The face ID.
*
* width ::
* The width in pixels.
*
* height ::
* The height in pixels.
*
* flags ::
* The load flags, as in @FT_Load_Glyph.
*
*/
typedef struct FTC_ImageTypeRec_ typedef struct FTC_ImageTypeRec_
{ {
FTC_FaceID face_id; FTC_FaceID face_id;
@ -647,12 +664,16 @@ FT_BEGIN_HEADER
} FTC_ImageTypeRec; } FTC_ImageTypeRec;
/**
* @type: FTC_ImageType /*************************************************************************
* *
* @description: * @type:
* handle to an @FTC_ImageTypeRec structure * FTC_ImageType
*/ *
* @description:
* A handle to an @FTC_ImageTypeRec structure.
*
*/
typedef struct FTC_ImageTypeRec_* FTC_ImageType; typedef struct FTC_ImageTypeRec_* FTC_ImageType;

View File

@ -4,7 +4,7 @@
/* */ /* */
/* FreeType convenience functions to handle glyphs (specification). */ /* FreeType convenience functions to handle glyphs (specification). */
/* */ /* */
/* Copyright 1996-2001, 2002, 2003 by */ /* Copyright 1996-2001, 2002, 2003, 2006 by */
/* David Turner, Robert Wilhelm, and Werner Lemberg. */ /* David Turner, Robert Wilhelm, and Werner Lemberg. */
/* */ /* */
/* This file is part of the FreeType project, and may only be used, */ /* This file is part of the FreeType project, and may only be used, */
@ -151,7 +151,7 @@ FT_BEGIN_HEADER
/* */ /* */
/* <Note> */ /* <Note> */
/* You can typecast a @FT_Glyph to @FT_BitmapGlyph if you have */ /* You can typecast a @FT_Glyph to @FT_BitmapGlyph if you have */
/* 'glyph->format == FT_GLYPH_FORMAT_BITMAP'. This lets you access */ /* `glyph->format == FT_GLYPH_FORMAT_BITMAP'. This lets you access */
/* the bitmap's contents easily. */ /* the bitmap's contents easily. */
/* */ /* */
/* The corresponding pixel buffer is always owned by the BitmapGlyph */ /* The corresponding pixel buffer is always owned by the BitmapGlyph */
@ -195,7 +195,7 @@ FT_BEGIN_HEADER
/* */ /* */
/* <Note> */ /* <Note> */
/* You can typecast a @FT_Glyph to @FT_OutlineGlyph if you have */ /* You can typecast a @FT_Glyph to @FT_OutlineGlyph if you have */
/* 'glyph->format == FT_GLYPH_FORMAT_OUTLINE'. This lets you access */ /* `glyph->format == FT_GLYPH_FORMAT_OUTLINE'. This lets you access */
/* the outline's content easily. */ /* the outline's content easily. */
/* */ /* */
/* As the outline is extracted from a glyph slot, its coordinates are */ /* As the outline is extracted from a glyph slot, its coordinates are */
@ -277,7 +277,7 @@ FT_BEGIN_HEADER
/* expressed in 1/64th of a pixel. */ /* expressed in 1/64th of a pixel. */
/* */ /* */
/* <Return> */ /* <Return> */
/* FreeType error code (if not 0, the glyph format is not scalable) */ /* FreeType error code (if not 0, the glyph format is not scalable). */
/* */ /* */
/* <Note> */ /* <Note> */
/* The 2x2 transformation matrix is also applied to the glyph's */ /* The 2x2 transformation matrix is also applied to the glyph's */

View File

@ -31,7 +31,7 @@
FT_BEGIN_HEADER FT_BEGIN_HEADER
/*************************************************************** /***************************************************************************
* *
* @section: * @section:
* incremental * incremental
@ -43,21 +43,22 @@ FT_BEGIN_HEADER
* Custom Glyph Loading * Custom Glyph Loading
* *
* @description: * @description:
* This section contains various functions used to perform * This section contains various functions used to perform so-called
* so-called "incremental" glyph loading. This is a mode where * `incremental' glyph loading. This is a mode where all glyphs loaded
* all glyphs loaded from a given FT_Face are provided by the * from a given @FT_Face are provided by the client application,
* client application,
* *
* Apart from that, all other tables are loaded normally from * Apart from that, all other tables are loaded normally from the font
* the font file. This mode is useful when FreeType is used * file. This mode is useful when FreeType is used within another
* within another engine, e.g. a Postscript Imaging Processor. * engine, e.g., a Postscript Imaging Processor.
*
* To enable this mode, you must use @FT_Open_Face, passing an
* @FT_Parameter with the @FT_PARAM_TAG_INCREMENTAL tag and an
* @FT_Incremental_Interface value. See the comments for
* @FT_Incremental_InterfaceRec for an example.
* *
* to enable this mode, you must use @FT_Open_Face, passing
* an @FT_Parameter with the @FT_PARAM_TAG_INCREMENTAL tag
* and a @FT_Incremental_Interface value. See the comments
* for @FT_Incremental_InterfaceRec for an example.
*/ */
/*************************************************************************** /***************************************************************************
* *
* @type: * @type:
@ -295,11 +296,15 @@ FT_BEGIN_HEADER
} FT_Incremental_InterfaceRec; } FT_Incremental_InterfaceRec;
/***
* @type: FT_Incremental_Interface /***************************************************************************
*
* @type:
* FT_Incremental_Interface
* *
* @description: * @description:
* a pointer to a @FT_Incremental_InterfaceRec structure * A pointer to an @FT_Incremental_InterfaceRec structure.
*
*/ */
typedef FT_Incremental_InterfaceRec* FT_Incremental_Interface; typedef FT_Incremental_InterfaceRec* FT_Incremental_Interface;

View File

@ -307,22 +307,23 @@ FT_BEGIN_HEADER
FT_Add_Default_Modules( FT_Library library ); FT_Add_Default_Modules( FT_Library library );
/*************************************************************** /**************************************************************************
* *
* @section: * @section:
* ttengine * ttengine
* *
* @title: * @title:
* TrueType Engine * The TrueType Engine
* *
* @abstract: * @abstract:
* TrueType bytecode support * TrueType bytecode support
* *
* @description: * @description:
* This section contains a function used to query the level * This section contains a function used to query the level of TrueType
* of TrueType bytecode support compiled in this version of * bytecode support compiled in this version of the library.
* the library. *
*/ */
/************************************************************************** /**************************************************************************
* *

View File

@ -188,7 +188,8 @@ FT_BEGIN_HEADER
* `outside' borders of a given outline. * `outside' borders of a given outline.
* *
* @input: * @input:
* outline :: The source outline handle. * outline ::
* The source outline handle.
* *
* @return: * @return:
* The border index. @FT_STROKER_BORDER_LEFT for empty or invalid * The border index. @FT_STROKER_BORDER_LEFT for empty or invalid
@ -207,10 +208,12 @@ FT_BEGIN_HEADER
* Create a new stroker object. * Create a new stroker object.
* *
* @input: * @input:
* library :: FreeType library handle * library ::
* FreeType library handle
* *
* @output: * @output:
* astroker :: A new stroker object handle. NULL in case of error. * astroker ::
* A new stroker object handle. NULL in case of error.
* *
* @return: * @return:
* FreeType error code. 0 means success. * FreeType error code. 0 means success.
@ -638,8 +641,8 @@ FT_BEGIN_HEADER
* Stroke a given outline glyph object with a given stroker. * Stroke a given outline glyph object with a given stroker.
* *
* @inout: * @inout:
* pglyph :: Source glyph handle on input, new glyph handle * pglyph ::
* on output. * Source glyph handle on input, new glyph handle on output.
* *
* @input: * @input:
* stroker :: * stroker ::

View File

@ -4,7 +4,7 @@
/* */ /* */
/* FreeType path stroker (body). */ /* FreeType path stroker (body). */
/* */ /* */
/* Copyright 2002, 2003, 2004, 2005 by */ /* Copyright 2002, 2003, 2004, 2005, 2006 by */
/* David Turner, Robert Wilhelm, and Werner Lemberg. */ /* David Turner, Robert Wilhelm, and Werner Lemberg. */
/* */ /* */
/* This file is part of the FreeType project, and may only be used, */ /* This file is part of the FreeType project, and may only be used, */
@ -723,6 +723,7 @@
FT_Memory memory; FT_Memory memory;
FT_Stroker stroker; FT_Stroker stroker;
if ( !library ) if ( !library )
return FT_Err_Invalid_Argument; return FT_Err_Invalid_Argument;