summaryrefslogtreecommitdiff
path: root/include/freetype
diff options
context:
space:
mode:
authorWerner Lemberg <wl@gnu.org>2001-01-11 09:27:49 +0000
committerWerner Lemberg <wl@gnu.org>2001-01-11 09:27:49 +0000
commit38208a6e6b07c8d3e144632c33833e16023b410b (patch)
tree9e607ee7d93d9d3ebd921a74c8f61e0d82c13f92 /include/freetype
parent0f5616a801e9401bf2e7abab3c709ada557ea6cf (diff)
downloadfreetype2-38208a6e6b07c8d3e144632c33833e16023b410b.tar.gz
* docs/docmaker.py: Minor improvements to reduce unwanted spaces
and empty lines in output. * docs/docmaker.py: Improved script to generate table of contents and index pages. It also supports wildcards on non Unix systems. * include/freetype/*.h, include/freetype/cache/*.h: Updated comments to include section definitions/delimitations for the API Reference generator. * include/freetype/freetype.h: Moved declaration of `FT_Generic_Finalizer' and the `FT_Generic' structure to... * include/freetype/fttypes.h: here.
Diffstat (limited to 'include/freetype')
-rw-r--r--include/freetype/cache/ftcimage.h12
-rw-r--r--include/freetype/cache/ftcmanag.h12
-rw-r--r--include/freetype/cache/ftcsbits.h206
-rw-r--r--include/freetype/freetype.h30
-rw-r--r--include/freetype/ftbbox.h10
-rw-r--r--include/freetype/ftcache.h34
-rw-r--r--include/freetype/ftglyph.h29
-rw-r--r--include/freetype/ftimage.h124
-rw-r--r--include/freetype/ftlist.h34
-rw-r--r--include/freetype/ftmac.h34
-rw-r--r--include/freetype/ftmm.h36
-rw-r--r--include/freetype/ftmodule.h33
-rw-r--r--include/freetype/ftnames.h44
-rw-r--r--include/freetype/ftoutln.h21
-rw-r--r--include/freetype/ftrender.h12
-rw-r--r--include/freetype/ftsystem.h2
-rw-r--r--include/freetype/fttypes.h29
-rw-r--r--include/freetype/t1tables.h31
-rw-r--r--include/freetype/tttables.h13
19 files changed, 450 insertions, 296 deletions
diff --git a/include/freetype/cache/ftcimage.h b/include/freetype/cache/ftcimage.h
index 7c10ef51b..2746db529 100644
--- a/include/freetype/cache/ftcimage.h
+++ b/include/freetype/cache/ftcimage.h
@@ -35,9 +35,13 @@
FT_BEGIN_HEADER
- /***
- * <Section> cache_subsystem
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* cache_subsystem */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/*************************************************************************/
@@ -163,8 +167,10 @@ FT_BEGIN_HEADER
FT_UInt gindex,
FT_Glyph *aglyph );
+
/* */
+
FT_END_HEADER
#endif /* __FTCIMAGE_H__ */
diff --git a/include/freetype/cache/ftcmanag.h b/include/freetype/cache/ftcmanag.h
index 40d107bdd..a8b8a8620 100644
--- a/include/freetype/cache/ftcmanag.h
+++ b/include/freetype/cache/ftcmanag.h
@@ -70,9 +70,14 @@
FT_BEGIN_HEADER
- /***
- * <Section> cache_subsystem
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* cache_subsystem */
+ /* */
+ /*************************************************************************/
+
#define FTC_MAX_FACES_DEFAULT 2
#define FTC_MAX_SIZES_DEFAULT 4
@@ -363,6 +368,7 @@ FT_BEGIN_HEADER
} FTC_CacheRec;
+
/* */
diff --git a/include/freetype/cache/ftcsbits.h b/include/freetype/cache/ftcsbits.h
index e86ea9d37..a5555d965 100644
--- a/include/freetype/cache/ftcsbits.h
+++ b/include/freetype/cache/ftcsbits.h
@@ -26,63 +26,76 @@
#include FT_CACHE_IMAGE_H
-
FT_BEGIN_HEADER
- /***
- * <Section> cache_subsystem
- */
-
- /***********************************************************************
- *
- * <Type> FTC_SBit
- *
- * <Description>
- * handle to a small bitmap descriptor. see the FTC_SBitRec
- * structure for details..
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* cache_subsystem */
+ /* */
+ /*************************************************************************/
+
+
+ /*************************************************************************/
+ /* */
+ /* <Type> */
+ /* FTC_SBit */
+ /* */
+ /* <Description> */
+ /* A handle to a small bitmap descriptor. See the FTC_SBitRec */
+ /* structure for details. */
+ /* */
typedef struct FTC_SBitRec_* FTC_SBit;
- /***********************************************************************
- *
- * <Type> FTC_SBit_Cache
- *
- * <Description>
- * handle to a small bitmap cache. These are special cache objects
- * used to store small glyph bitmaps (and anti-aliased pixmaps) in
- * a much more efficient way than the traditional glyph image cache
- * implemented by FTC_Image_Cache
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Type> */
+ /* FTC_SBit_Cache */
+ /* */
+ /* <Description> */
+ /* A handle to a small bitmap cache. These are special cache objects */
+ /* used to store small glyph bitmaps (and anti-aliased pixmaps) in a */
+ /* much more efficient way than the traditional glyph image cache */
+ /* implemented by FTC_Image_Cache. */
+ /* */
typedef struct FTC_SBit_CacheRec_* FTC_SBit_Cache;
- /***********************************************************************
- *
- * <Struct> FTC_SBitRec
- *
- * <Description>
- * a very compact structure used to describe a small glyph bitmap
- *
- * <Fields>
- * width :: bitmap width in pixels
- * height :: bitmap height in pixels
- *
- * left :: horizontal distance from pen position to left bitmap
- * border (a.k.a. "left side bearing", or "lsb")
- *
- * top :: vertical distance from pen position (on the baseline)
- * to the upper bitmap border (a.k.a. "top side bearing")
- * the distance is positive for upwards Y coordinates.
- *
- * format :: format of glyph bitmap (mono or gray)
- *
- * pitch :: number of bytes per bitmap lines. may be positive or
- * negative
- *
- * xadvance :: horizontal advance width in pixels
- * yadvance :: vertical advance height in pixels
- *
- * buffer :: pointer to bitmap pixels
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Struct> */
+ /* FTC_SBitRec */
+ /* */
+ /* <Description> */
+ /* A very compact structure used to describe a small glyph bitmap. */
+ /* */
+ /* <Fields> */
+ /* width :: The bitmap width in pixels. */
+ /* */
+ /* height :: The bitmap height in pixels. */
+ /* */
+ /* left :: The horizontal distance from the pen position to the */
+ /* left bitmap border (a.k.a. `left side bearing', or */
+ /* `lsb'). */
+ /* */
+ /* top :: The vertical distance from the pen position (on the */
+ /* baseline) to the upper bitmap border (a.k.a. `top side */
+ /* bearing'). The distance is positive for upwards */
+ /* Y coordinates. */
+ /* */
+ /* format :: The format of the glyph bitmap (monochrome or gray). */
+ /* */
+ /* pitch :: The number of bytes per bitmap line. May be positive */
+ /* or negative. */
+ /* */
+ /* xadvance :: The horizontal advance width in pixels. */
+ /* */
+ /* yadvance :: The vertical advance height in pixels. */
+ /* */
+ /* buffer :: A pointer to the bitmap pixels. */
+ /* */
typedef struct FTC_SBitRec_
{
FT_Byte width;
@@ -100,59 +113,64 @@ FT_BEGIN_HEADER
} FTC_SBitRec;
- /*************************************************************************
- *
- * <Section> FTC_SBit_Cache_New
- *
- * <Description>
- * Create a new cache to store small glyph bitmaps
- *
- * <Input>
- * manager :: handle to source cache manager
- *
- * <Output>
- * acache :: handle to new sbit cache. NULL in case of error
- *
- * <Return>
- * error code. 0 means success
- */
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FTC_SBit_Cache_New */
+ /* */
+ /* <Description> */
+ /* Creates a new cache to store small glyph bitmaps. */
+ /* */
+ /* <Input> */
+ /* manager :: A handle to the source cache manager. */
+ /* */
+ /* <Output> */
+ /* acache :: A handle to the new sbit cache. NULL in case of error. */
+ /* */
+ /* <Return> */
+ /* FreeType error code. 0 means success. */
+ /* */
FT_EXPORT( FT_Error ) FTC_SBit_Cache_New( FTC_Manager manager,
FTC_SBit_Cache *acache );
- /*************************************************************************
- *
- * <Section> FTC_SBit_Cache_Lookup
- *
- * <Description>
- * Lookup a given small glyph bitmap in a given sbit cache
- *
- * <Input>
- * cache :: handle to source sbit cache
- * desc :: pointer to glyph image descriptor
- * gindex :: glyph index
- *
- * <Output>
- * sbit :: handle to a small bitmap descriptor
- *
- * <Return>
- * error code. 0 means success
- *
- * <Note>
- * the small bitmap descriptor, and its bit buffer are owned by the
- * cache and should never be freed by the application. They might
- * as well disappear from memory on the next cache lookup, so don't
- * treat them like persistent data..
- *
- * the descriptor's "buffer" field is set to 0 to indicate a missing
- * glyph bitmap.
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FTC_SBit_Cache_Lookup */
+ /* */
+ /* <Description> */
+ /* Looks up a given small glyph bitmap in a given sbit cache. */
+ /* */
+ /* <Input> */
+ /* cache :: A handle to the source sbit cache. */
+ /* desc :: A pointer to the glyph image descriptor. */
+ /* gindex :: The glyph index. */
+ /* */
+ /* <Output> */
+ /* sbit :: A handle to a small bitmap descriptor. */
+ /* */
+ /* <Return> */
+ /* FreeType error code. 0 means success. */
+ /* */
+ /* <Note> */
+ /* The small bitmap descriptor and its bit buffer are owned by the */
+ /* cache and should never be freed by the application. They might */
+ /* as well disappear from memory on the next cache lookup, so don't */
+ /* treat them as persistent data. */
+ /* */
+ /* The descriptor's `buffer' field is set to 0 to indicate a missing */
+ /* glyph bitmap. */
+ /* */
FT_EXPORT( FT_Error ) FTC_SBit_Cache_Lookup( FTC_SBit_Cache cache,
FTC_Image_Desc* desc,
FT_UInt gindex,
FTC_SBit *sbit );
+
/* */
+
FT_END_HEADER
#endif /* __FTCSBITS_H__ */
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index 17ec70761..6f98776e3 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -55,18 +55,23 @@ FT_BEGIN_HEADER
/*************************************************************************/
/*************************************************************************/
- /*************************************************************************
- *
- * <Section> base_interface
- *
- * <Title> Base Interface
- *
- * <Abstract>
- * The FreeType 2 base font interface
- *
- * <Description>
- * This sections details the public high-level API of FreeType 2
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* base_interface */
+ /* */
+ /* <Title> */
+ /* Base Interface */
+ /* */
+ /* <Abstract> */
+ /* The FreeType 2 base font interface. */
+ /* */
+ /* <Description> */
+ /* This section describes the public high-level API of FreeType 2. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -2243,6 +2248,7 @@ FT_BEGIN_HEADER
FT_EXPORT( void ) FT_Vector_Transform( FT_Vector* vec,
FT_Matrix* matrix );
+
/* */
diff --git a/include/freetype/ftbbox.h b/include/freetype/ftbbox.h
index 9d9252f25..ddc506c1f 100644
--- a/include/freetype/ftbbox.h
+++ b/include/freetype/ftbbox.h
@@ -38,9 +38,13 @@
FT_BEGIN_HEADER
- /********************************
- * <Section> outline_processing
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* outline_processing */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
diff --git a/include/freetype/ftcache.h b/include/freetype/ftcache.h
index 81b8d4906..cedf6d906 100644
--- a/include/freetype/ftcache.h
+++ b/include/freetype/ftcache.h
@@ -50,19 +50,24 @@ FT_BEGIN_HEADER
#define FT_CACHE_INTERNAL_GLYPH_H FT2_PUBLIC_FILE(cache/ftcglyph.h)
#define FT_CACHE_INTERNAL_CHUNK_H FT2_PUBLIC_FILE(cache/ftcchunk.h)
- /**************************************************************************
- *
- * <Section> cache_subsystem
- *
- * <Title> Cache Sub-System
- *
- * <Abstract>
- * How to cache face, size and glyph data with FreeType 2
- *
- * <Description>
- * This section details the FreeType 2 cache sub-system which is still
- * in beta.
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* cache_subsystem */
+ /* */
+ /* <Title> */
+ /* Cache Sub-System */
+ /* */
+ /* <Abstract> */
+ /* How to cache face, size, and glyph data with FreeType 2. */
+ /* */
+ /* <Description> */
+ /* This section describes the FreeType 2 cache sub-system which is */
+ /* stile in beta. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/*************************************************************************/
@@ -345,6 +350,9 @@ FT_BEGIN_HEADER
FTC_Cache *acache );
+ /* */
+
+
FT_END_HEADER
#endif /* __FTCACHE_H__ */
diff --git a/include/freetype/ftglyph.h b/include/freetype/ftglyph.h
index 7824b8134..60dcf3592 100644
--- a/include/freetype/ftglyph.h
+++ b/include/freetype/ftglyph.h
@@ -39,20 +39,25 @@
FT_BEGIN_HEADER
+
/*************************************************************************/
/* */
- /* <Section> glyph_management */
+ /* <Section> */
+ /* glyph_management */
/* */
- /* <Title> Glyph Management */
+ /* <Title> */
+ /* Glyph Management */
/* */
/* <Abstract> */
- /* Generic interface to manage individual glyph data */
+ /* Generic interface to manage individual glyph data. */
/* */
/* <Description> */
/* This section contains definitions used to manage glyph data */
- /* through generic FT_Glyph objects. Each one of them can contain */
- /* a bitmap, a vector outline, or even images in other formats. */
+ /* through generic FT_Glyph objects. Each of them can contain a */
+ /* bitmap, a vector outline, or even images in other formats. */
/* */
+ /*************************************************************************/
+
/* forward declaration to a private type */
typedef struct FT_Glyph_Class_ FT_Glyph_Class;
@@ -296,7 +301,6 @@ FT_BEGIN_HEADER
/* */
/* The default value for `bbox_mode' is `ft_glyph_bbox_pixels'. */
/* */
-
enum
{
ft_glyph_bbox_unscaled = 0, /* return unscaled font units */
@@ -405,9 +409,13 @@ FT_BEGIN_HEADER
/* other helpful functions */
- /*****
- * <Section> base_interface
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* base_interface */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -448,6 +456,9 @@ FT_BEGIN_HEADER
FT_EXPORT( FT_Error ) FT_Matrix_Invert( FT_Matrix* matrix );
+ /* */
+
+
FT_END_HEADER
#endif /* __FTGLYPH_H__ */
diff --git a/include/freetype/ftimage.h b/include/freetype/ftimage.h
index 19e2b9b7e..8db53395f 100644
--- a/include/freetype/ftimage.h
+++ b/include/freetype/ftimage.h
@@ -33,11 +33,14 @@
FT_BEGIN_HEADER
- /***********************************************************************
- *
- * <Section> basic_types
- *
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* basic_types */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -231,11 +234,13 @@ FT_BEGIN_HEADER
} FT_Bitmap;
- /***********************************************************************
- *
- * <Section> outline_processing
- *
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* outline_processing */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -528,11 +533,13 @@ FT_BEGIN_HEADER
} FT_Outline_Funcs;
- /***********************************************************************
- *
- * <Section> Basic_Types
- *
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* basic_types */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -612,18 +619,23 @@ FT_BEGIN_HEADER
/* */
/*************************************************************************/
- /************************************************************************
- *
- * <Section> Raster
- *
- * <Title> Scanline converter
- *
- * <Abstract>
- * How vectorial outlines are converted into bitmaps and pixmaps
- *
- * <Description>
- * This section contains technical definitions
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* Raster */
+ /* */
+ /* <Title> */
+ /* Scanline converter */
+ /* */
+ /* <Abstract> */
+ /* How vectorial outlines are converted into bitmaps and pixmaps. */
+ /* */
+ /* <Description> */
+ /* This section contains technical definitions. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -692,9 +704,9 @@ FT_BEGIN_HEADER
/* */
typedef struct FT_Span_
{
- short x;
- unsigned short len;
- unsigned char coverage;
+ short x;
+ unsigned short len;
+ unsigned char coverage;
} FT_Span;
@@ -804,28 +816,33 @@ FT_BEGIN_HEADER
/* <Fields> */
/* ft_raster_flag_default :: This value is 0. */
/* */
- /* ft_raster_flag_aa :: */
- /* this flag is set to indicate that a anti-aliased glyph image */
- /* should be generated. Otherwise, it will be monochrome (1-bit) */
- /* */
- /* ft_raster_flag_direct :: */
- /* this flag is set to indicate direct rendering. In this mode, */
- /* client applications must provide their own span callback. */
- /* this let them direct drawing or composition over an existing */
- /* bitmap. If this bit is not set, the target pixmap's buffer */
- /* _must_ be zeroed before rendering. */
- /* */
- /* note that for now, direct rendering is only possible with */
- /* anti-aliased glyphs only.. */
- /* */
- /* ft_raster_flag_clip :: */
- /* this flag is only used in direct rendering mode. When set, */
- /* the output will be clipped to a box specified in the "clip_box" */
- /* field of the FT_Raster_Params structure. */
- /* */
- /* note that by default, the glyph bitmap is clipped to the */
- /* target pixmap, except in direct rendering mode where all */
- /* spans are generated if no clipping box is set. */
+ /* ft_raster_flag_aa :: This flag is set to indicate that an */
+ /* anti-aliased glyph image should be */
+ /* generated. Otherwise, it will be */
+ /* monochrome (1-bit) */
+ /* */
+ /* ft_raster_flag_direct :: This flag is set to indicate direct */
+ /* rendering. In this mode, client */
+ /* applications must provide their own span */
+ /* callback. This lets them directly */
+ /* draw or compose over an existing bitmap. */
+ /* If this bit is not set, the target */
+ /* pixmap's buffer _must_ be zeroed before */
+ /* rendering. */
+ /* */
+ /* Note that for now, direct rendering is */
+ /* only possible with anti-aliased glyphs. */
+ /* */
+ /* ft_raster_flag_clip :: This flag is only used in direct */
+ /* rendering mode. If set, the output will */
+ /* be clipped to a box specified in the */
+ /* "clip_box" field of the FT_Raster_Params */
+ /* structure. */
+ /* */
+ /* Note that by default, the glyph bitmap */
+ /* is clipped to the target pixmap, except */
+ /* in direct rendering mode where all spans */
+ /* are generated if no clipping box is set. */
/* */
typedef enum
{
@@ -1066,6 +1083,9 @@ FT_BEGIN_HEADER
} FT_Raster_Funcs;
+ /* */
+
+
FT_END_HEADER
#endif /* __FTIMAGE_H__ */
diff --git a/include/freetype/ftlist.h b/include/freetype/ftlist.h
index 4d4397c9e..d0b96df4d 100644
--- a/include/freetype/ftlist.h
+++ b/include/freetype/ftlist.h
@@ -34,20 +34,24 @@
FT_BEGIN_HEADER
- /**************************************************************************
- *
- * <Section> list_processing
- *
- * <Title> List Processing
- *
- * <Abstract>
- * simple management of lists
- *
- * <Description>
- * This section contains various definitions related to list processing
- * using doubly-linked nodes.
- *
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* list_processing */
+ /* */
+ /* <Title> */
+ /* List Processing */
+ /* */
+ /* <Abstract> */
+ /* Simple management of lists. */
+ /* */
+ /* <Description> */
+ /* This section contains various definitions related to list */
+ /* processing using doubly-linked nodes. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -227,7 +231,9 @@ FT_BEGIN_HEADER
FT_Memory memory,
void* user );
+
/* */
+
FT_END_HEADER
diff --git a/include/freetype/ftmac.h b/include/freetype/ftmac.h
index 99654c742..442a27c7c 100644
--- a/include/freetype/ftmac.h
+++ b/include/freetype/ftmac.h
@@ -34,19 +34,24 @@
FT_BEGIN_HEADER
- /*******************************************************************
- *
- * <Section> Mac_Specific
- *
- * <Title> Mac-Specific Interface
- *
- * <Abstract>
- * Only available on the Macintosh
- *
- * <Description>
- * The following definitions are only available when FreeType
- * is compiled on a Macintosh.
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* Mac_Specific */
+ /* */
+ /* <Title> */
+ /* Mac-Specific Interface */
+ /* */
+ /* <Abstract> */
+ /* Only available on the Macintosh. */
+ /* */
+ /* <Description> */
+ /* The following definitions are only available if FreeType is */
+ /* compiled on a Macintosh. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -78,7 +83,6 @@ FT_BEGIN_HEADER
/* { */
/* fond = GetResource( 'FOND', fontName ); */
/* error = FT_New_Face_From_FOND( library, fond, 0, &face ); */
- /* */
/* } */
/* */
FT_EXPORT( FT_Error ) FT_New_Face_From_FOND( FT_Library library,
@@ -86,8 +90,10 @@ FT_BEGIN_HEADER
FT_Long face_index,
FT_Face *aface );
+
/* */
+
FT_END_HEADER
diff --git a/include/freetype/ftmm.h b/include/freetype/ftmm.h
index bf4a1e6ea..33d1a0abd 100644
--- a/include/freetype/ftmm.h
+++ b/include/freetype/ftmm.h
@@ -26,20 +26,25 @@
FT_BEGIN_HEADER
- /**********************************************************************
- *
- * <Section> Multiple_Masters
- *
- * <Title> Multiple Masters
- *
- * <Abstract>
- * How to manage multiple masters fonts
- *
- * <Description>
- * The following types and functions are used to manage multiple
- * master fonts, i.e. choose specific design instances by setting
- * design axis coordinates.
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* multiple_masters */
+ /* */
+ /* <Title> */
+ /* Multiple Masters */
+ /* */
+ /* <Abstract> */
+ /* How to manage Multiple Masters fonts. */
+ /* */
+ /* <Description> */
+ /* The following types and functions are used to manage Multiple */
+ /* Master fonts, i.e. the selection of specific design instances by */
+ /* setting design axis coordinates. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -182,6 +187,9 @@ FT_BEGIN_HEADER
FT_Fixed* coords );
+ /* */
+
+
FT_END_HEADER
#endif /* __FTMM_H__ */
diff --git a/include/freetype/ftmodule.h b/include/freetype/ftmodule.h
index 0416c648f..3fcc95e8f 100644
--- a/include/freetype/ftmodule.h
+++ b/include/freetype/ftmodule.h
@@ -26,18 +26,24 @@
FT_BEGIN_HEADER
- /**************************************************************************
- *
- * <Section> Module_Management
- *
- * <Title> Module Management
- *
- * <Abstract> How to add, upgrade and remove modules from FreeType
- *
- * <Description>
- * The definitions below are used to manage modules within FreeType.
- * Modules can be added, upgraded and removed at runtime.
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* module_management */
+ /* */
+ /* <Title> */
+ /* Module Management */
+ /* */
+ /* <Abstract> */
+ /* How to add, upgrade, and remove modules from FreeType. */
+ /* */
+ /* <Description> */
+ /* The definitions below are used to manage modules within FreeType. */
+ /* Modules can be added, upgraded, and removed at runtime. */
+ /* */
+ /*************************************************************************/
+
/* module bit flags */
typedef enum FT_Module_Flags_
@@ -278,6 +284,9 @@ FT_BEGIN_HEADER
FT_EXPORT( void ) FT_Add_Default_Modules( FT_Library library );
+ /* */
+
+
FT_END_HEADER
#endif /* __FTMODULE_H__ */
diff --git a/include/freetype/ftnames.h b/include/freetype/ftnames.h
index a82406577..61ffd85f8 100644
--- a/include/freetype/ftnames.h
+++ b/include/freetype/ftnames.h
@@ -30,24 +30,29 @@
FT_BEGIN_HEADER
- /**************************************************************************
- *
- * <Section> SFNT_Names
- *
- * <Title> SFNT Names
- *
- * <Abstract> Access the names embedded in TrueType and OpenType files
- *
- * <Description>
- * The TrueType and OpenType specification allow the inclusion of
- * a special "names table" in font files. This table contains textual
- * (and internationalised) information regarding the font, like
- * family name, copyright, version, etc..
- *
- * the definitions below are used to access them when available
- *
- * note that this has nothing to do with "glyph names" !!
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* sfnt_names */
+ /* */
+ /* <Title> */
+ /* SFNT Names */
+ /* */
+ /* <Abstract> */
+ /* Access the names embedded in TrueType and OpenType files. */
+ /* */
+ /* <Description> */
+ /* The TrueType and OpenType specification allow the inclusion of */
+ /* a special `names table' in font files. This table contains */
+ /* textual (and internationalized) information regarding the font, */
+ /* like family name, copyright, version, etc. */
+ /* */
+ /* The definitions below are used to access them if available. */
+ /* */
+ /* Note that this has nothing to do with glyph names! */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -137,8 +142,11 @@ FT_BEGIN_HEADER
FT_EXPORT( FT_Error ) FT_Get_Sfnt_Name( FT_Face face,
FT_UInt index,
FT_SfntName *aname );
+
+
/* */
+
FT_END_HEADER
#endif /* __FTNAMES_H__ */
diff --git a/include/freetype/ftoutln.h b/include/freetype/ftoutln.h
index 9c16ca1d1..52b2d57a0 100644
--- a/include/freetype/ftoutln.h
+++ b/include/freetype/ftoutln.h
@@ -27,21 +27,25 @@
FT_BEGIN_HEADER
+
/*************************************************************************/
/* */
- /* <Section> outline_processing */
+ /* <Section> */
+ /* outline_processing */
/* */
- /* <Title> Outline Processing */
+ /* <Title> */
+ /* Outline Processing */
/* */
/* <Abstract> */
- /* Functions to create, transform and render vectorial glyph images */
+ /* Functions to create, transform, and render vectorial glyph images. */
/* */
/* <Description> */
- /* This sections contains routines used to create and destroy */
- /* scalable glyph images known as "outlines". These can also be */
- /* measured, transformed and converted into bitmaps, pixmaps and */
- /* */
+ /* This section contains routines used to create and destroy scalable */
+ /* glyph images known as `outlines'. These can also be measured, */
+ /* transformed, and converted into bitmaps and pixmaps. */
/* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -331,6 +335,9 @@ FT_BEGIN_HEADER
FT_Raster_Params* params );
+ /* */
+
+
FT_END_HEADER
#endif /* __FTOUTLN_H__ */
diff --git a/include/freetype/ftrender.h b/include/freetype/ftrender.h
index fa4d1f908..c6a0d2e77 100644
--- a/include/freetype/ftrender.h
+++ b/include/freetype/ftrender.h
@@ -27,9 +27,14 @@
FT_BEGIN_HEADER
- /****
- * <Section> Module_Management
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* module_management */
+ /* */
+ /*************************************************************************/
+
/* create a new glyph object */
typedef FT_Error (*FT_Glyph_Init_Func) ( FT_Glyph glyph,
@@ -183,6 +188,7 @@ FT_BEGIN_HEADER
FT_UInt num_params,
FT_Parameter* parameters );
+
/* */
diff --git a/include/freetype/ftsystem.h b/include/freetype/ftsystem.h
index 802a61ea5..f355421d2 100644
--- a/include/freetype/ftsystem.h
+++ b/include/freetype/ftsystem.h
@@ -264,8 +264,10 @@ FT_BEGIN_HEADER
unsigned char* limit;
};
+
/* */
+
FT_END_HEADER
#endif /* __FTSYSTEM_H__ */
diff --git a/include/freetype/fttypes.h b/include/freetype/fttypes.h
index 4f03c8b9d..a31c00f2b 100644
--- a/include/freetype/fttypes.h
+++ b/include/freetype/fttypes.h
@@ -29,19 +29,24 @@
FT_BEGIN_HEADER
+
/*************************************************************************/
/* */
- /* <Section> basic_types */
+ /* <Section> */
+ /* basic_types */
/* */
- /* <Title> Basic Data Types */
+ /* <Title> */
+ /* Basic Data Types */
/* */
/* <Abstract> */
- /* The basic data types defined by the library */
+ /* The basic data types defined by the library. */
/* */
/* <Description> */
- /* This sections contains the basic data types defined by FreeType 2, */
- /* rangine from simple scalar types to font specific ones */
+ /* This section contains the basic data types defined by FreeType 2, */
+ /* ranging from simple scalar types to font specific ones. */
/* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -341,7 +346,6 @@ FT_BEGIN_HEADER
} FT_Generic;
-
/*************************************************************************/
/* */
/* <Macro> */
@@ -366,10 +370,14 @@ FT_BEGIN_HEADER
/*************************************************************************/
/*************************************************************************/
- /**************************************************************************
- *
- * <Section> list_processing
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* list_processing */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -440,6 +448,7 @@ FT_BEGIN_HEADER
} FT_ListRec;
+
/* */
#define FT_IS_EMPTY( list ) ( (list).head == 0 )
diff --git a/include/freetype/t1tables.h b/include/freetype/t1tables.h
index 696c4cb6d..cc23ddeb5 100644
--- a/include/freetype/t1tables.h
+++ b/include/freetype/t1tables.h
@@ -28,18 +28,24 @@
FT_BEGIN_HEADER
- /********************************************************************
- *
- * <Section> Type1_Tables
- *
- * <Title> Type 1 Tables
- *
- * <Abstract> Type 1 (Postscript) specific font tables
- *
- * <Description>
- * This section ....
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* type1_tables */
+ /* */
+ /* <Title> */
+ /* Type 1 Tables */
+ /* */
+ /* <Abstract> */
+ /* Type 1 (PostScript) specific font tables. */
+ /* */
+ /* <Description> */
+ /* This section contains the definition of Type 1-specific tables, */
+ /* including structures related to other PostScript font formats. */
+ /* */
+ /*************************************************************************/
+
/* Note that we separate font data in T1_FontInfo and T1_Private */
/* structures in order to support Multiple Master fonts. */
@@ -246,6 +252,9 @@ FT_BEGIN_HEADER
} CID_Info;
+ /* */
+
+
FT_END_HEADER
#endif /* __T1TABLES_H__ */
diff --git a/include/freetype/tttables.h b/include/freetype/tttables.h
index 557fd2ca6..e2caaf84f 100644
--- a/include/freetype/tttables.h
+++ b/include/freetype/tttables.h
@@ -29,17 +29,21 @@ FT_BEGIN_HEADER
/*************************************************************************/
/* */
- /* <Section> TrueType_Tables */
+ /* <Section> */
+ /* truetype_tables */
/* */
- /* <Title> TrueType Tables */
+ /* <Title> */
+ /* TrueType Tables */
/* */
/* <Abstract> */
- /* TrueType-specific table types and functions */
+ /* TrueType-specific table types and functions. */
/* */
/* <Description> */
- /* This sections contains the definition of TrueType-specific tables */
+ /* This section contains the definition of TrueType-specific tables */
/* as well as some routines used to access and process them. */
/* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -586,6 +590,7 @@ FT_BEGIN_HEADER
/* */
+
FT_END_HEADER
#endif /* __TTTABLES_H__ */