Commit e899991b5e729b48ed219e15727c6fbb39c7e18f
2008-05-31T07:03:30
More doc fixes to improve HTML version.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
diff --git a/include/freetype/config/ftconfig.h b/include/freetype/config/ftconfig.h
index 1547f5a..09b2cf9 100644
--- a/include/freetype/config/ftconfig.h
+++ b/include/freetype/config/ftconfig.h
@@ -139,13 +139,65 @@ FT_BEGIN_HEADER
/*************************************************************************/
/* */
- /* IntN types */
+ /* <Section> */
+ /* basic_types */
/* */
- /* Used to guarantee the size of some specific integers. */
+ /*************************************************************************/
+
+
+ /*************************************************************************/
+ /* */
+ /* <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 signed short FT_Int16;
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)
typedef signed int FT_Int32;
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index f533cff..ec28d24 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -1250,7 +1250,7 @@ FT_BEGIN_HEADER
/* */
/* <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 @@ FT_BEGIN_HEADER
/* */
/* <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 @@ FT_BEGIN_HEADER
#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
/* */
diff --git a/include/freetype/ftgasp.h b/include/freetype/ftgasp.h
index 97cd330..2692c31 100644
--- 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:
diff --git a/include/freetype/ftimage.h b/include/freetype/ftimage.h
index 7bfc4c9..56acb17 100644
--- 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 @@ FT_BEGIN_HEADER
/* 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_BEGIN_HEADER
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 @@ FT_BEGIN_HEADER
#define FT_Outline_MoveTo_Func FT_Outline_MoveToFunc
+
/*************************************************************************/
/* */
/* <FuncType> */
@@ -517,6 +518,7 @@ FT_BEGIN_HEADER
#define FT_Outline_LineTo_Func FT_Outline_LineToFunc
+
/*************************************************************************/
/* */
/* <FuncType> */
@@ -548,6 +550,7 @@ FT_BEGIN_HEADER
#define FT_Outline_ConicTo_Func FT_Outline_ConicToFunc
+
/*************************************************************************/
/* */
/* <FuncType> */
@@ -869,7 +872,7 @@ FT_BEGIN_HEADER
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_BEGIN_HEADER
(*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 @@ FT_BEGIN_HEADER
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 @@ FT_BEGIN_HEADER
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_BEGIN_HEADER
(*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
/*************************************************************************/
diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h
index ca7b578..7d813eb 100644
--- a/include/freetype/ftmodapi.h
+++ b/include/freetype/ftmodapi.h
@@ -78,12 +78,50 @@ FT_BEGIN_HEADER
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 @@ FT_BEGIN_HEADER
/* 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_
{
diff --git a/include/freetype/ftrender.h b/include/freetype/ftrender.h
index 5b07f08..9ed828e 100644
--- a/include/freetype/ftrender.h
+++ b/include/freetype/ftrender.h
@@ -124,27 +124,32 @@ FT_BEGIN_HEADER
/* 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;
diff --git a/include/freetype/fttypes.h b/include/freetype/fttypes.h
index 2340bac..a60aa54 100644
--- 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_BEGIN_HEADER
/* FT_Char */
/* FT_Int */
/* FT_UInt */
+ /* FT_Int16 */
+ /* FT_UInt16 */
+ /* FT_Int32 */
+ /* FT_UInt32 */
/* FT_Short */
/* FT_UShort */
/* FT_Long */
diff --git a/include/freetype/t1tables.h b/include/freetype/t1tables.h
index 2a98c6b..bd11f33 100644
--- a/include/freetype/t1tables.h
+++ b/include/freetype/t1tables.h
@@ -294,6 +294,14 @@ FT_BEGIN_HEADER
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_BEGIN_HEADER
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 */
diff --git a/include/freetype/ttnameid.h b/include/freetype/ttnameid.h
index 7ee8655..907543f 100644
--- 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 @@ FT_BEGIN_HEADER
* 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