Commit c43fd3a749d9659277568b6cce6539d6f5503883
2001-06-19T09:11:18
Formatting.
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
diff --git a/include/freetype/ftsystem.h b/include/freetype/ftsystem.h
index f355421..151a80f 100644
--- a/include/freetype/ftsystem.h
+++ b/include/freetype/ftsystem.h
@@ -25,22 +25,25 @@
FT_BEGIN_HEADER
- /**************************************************************************
- *
- * <Section> system_interface
- *
- * <Title> System Interface
- *
- * <Abstract>
- * How FreeType manages memory and i/o
- *
- * <Description>
- * This section contains various definitions related to memory
- * management and i/o access. You'll need to understand this
- * information if you want to use a custom memory manager or
- * you own input i/o streams
- *
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* system_interface */
+ /* */
+ /* <Title> */
+ /* System Interface */
+ /* */
+ /* <Abstract> */
+ /* How FreeType manages memory and i/o. */
+ /* */
+ /* <Description> */
+ /* This section contains various definitions related to memory */
+ /* management and i/o access. You need to understand this */
+ /* information if you want to use a custom memory manager or you own */
+ /* input i/o streams. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -48,89 +51,103 @@ FT_BEGIN_HEADER
/* */
/*************************************************************************/
- /**********************************************************************
- *
- * @type: FT_Memory
- *
- * @description:
- * a handle to a given memory manager object, defined with a
- * @FT_MemoryRec structure.
- */
+
+ /*************************************************************************/
+ /* */
+ /* @type: */
+ /* FT_Memory */
+ /* */
+ /* @description: */
+ /* A handle to a given memory manager object, defined with a */
+ /* @FT_MemoryRec structure. */
+ /* */
typedef struct FT_MemoryRec_* FT_Memory;
- /**********************************************************************
- *
- * @functype: FT_Alloc_Func
- *
- * @description:
- * a function used to allocate "size" bytes from "memory"
- *
- * @input:
- * memory :: handle to source memory manager
- * size :: size in bytes to allocate
- *
- * @return:
- * address of new memory block. 0 in case of failure
- */
+ /*************************************************************************/
+ /* */
+ /* @functype: */
+ /* FT_Alloc_Func */
+ /* */
+ /* @description: */
+ /* A function used to allocate `size' bytes from `memory'. */
+ /* */
+ /* @input: */
+ /* memory :: A handle to the source memory manager. */
+ /* */
+ /* size :: The size in bytes to allocate. */
+ /* */
+ /* @return: */
+ /* Address of new memory block. 0 in case of failure. */
+ /* */
typedef void* (*FT_Alloc_Func)( FT_Memory memory,
long size );
- /**********************************************************************
- *
- * @functype: FT_Free_Func
- *
- * @description:
- * a function used to release a given block of memory
- *
- * @input:
- * memory :: handle to source memory manager
- * block :: address of target memory block
- */
+ /*************************************************************************/
+ /* */
+ /* @functype: */
+ /* FT_Free_Func */
+ /* */
+ /* @description: */
+ /* A function used to release a given block of memory. */
+ /* */
+ /* @input: */
+ /* memory :: A handle to the source memory manager. */
+ /* */
+ /* block :: The address of the target memory block. */
+ /* */
typedef void (*FT_Free_Func)( FT_Memory memory,
void* block );
- /**********************************************************************
- *
- * @functype: FT_Realloc_Func
- *
- * @description:
- * a function used to re-allocate a given block of memory
- *
- * @input:
- * memory :: handle to source memory manager
- * cur_size :: the block's current size in bytes
- * new_size :: the block's requested new size
- * block :: the block's current address
- *
- * @return:
- * new block address. 0 in case of memory shortage.
- *
- * @note:
- * note that in case of error, the old block must still be available
- */
+
+ /*************************************************************************/
+ /* */
+ /* @functype: */
+ /* FT_Realloc_Func */
+ /* */
+ /* @description: */
+ /* a function used to re-allocate a given block of memory. */
+ /* */
+ /* @input: */
+ /* memory :: A handle to the source memory manager. */
+ /* */
+ /* cur_size :: The block's current size in bytes. */
+ /* */
+ /* new_size :: The block's requested new size. */
+ /* */
+ /* block :: The block's current address. */
+ /* */
+ /* @return: */
+ /* New block address. 0 in case of memory shortage. */
+ /* */
+ /* @note: */
+ /* In case of error, the old block must still be available. */
+ /* */
typedef void* (*FT_Realloc_Func)( FT_Memory memory,
long cur_size,
long new_size,
void* block );
- /**********************************************************************
- *
- * @struct: FT_MemoryRec
- *
- * @description:
- * a structure used to describe a given memory manager to FreeType 2
- *
- * @fields:
- * user ::
- * alloc ::
- * free ::
- * realloc ::
- *
- */
- struct FT_MemoryRec_
+ /*************************************************************************/
+ /* */
+ /* @struct: */
+ /* FT_MemoryRec */
+ /* */
+ /* @description: */
+ /* A structure used to describe a given memory manager to FreeType 2. */
+ /* */
+ /* @fields: */
+ /* user :: A generic typeless pointer for user data. */
+ /* */
+ /* alloc :: A pointer type to an allocation function. */
+ /* */
+ /* free :: A pointer type to an memory freeing function. */
+ /* */
+ /* realloc :: A pointer type to a reallocation function. */
+ /* */
+ struct FT_MemoryRec_
{
void* user;
FT_Alloc_Func alloc;
@@ -146,26 +163,26 @@ FT_BEGIN_HEADER
/*************************************************************************/
- /************************************************************************
- *
- * @type: FT_Stream
- *
- * @description:
- * a handle to an input stream.
- */
+ /*************************************************************************/
+ /* */
+ /* @type: */
+ /* FT_Stream */
+ /* */
+ /* @description: */
+ /* A handle to an input stream. */
+ /* */
typedef struct FT_StreamRec_* FT_Stream;
-
- /************************************************************************
- *
- * @struct: FT_StreamDesc
- *
- * @description:
- * a union type used to store either a long or a pointer. This is
- * used to store a file descriptor or a FILE* in an input stream
- *
- */
+ /*************************************************************************/
+ /* */
+ /* @struct: */
+ /* FT_StreamDesc */
+ /* */
+ /* @description: */
+ /* A union type used to store either a long or a pointer. This is */
+ /* used to store a file descriptor or a FILE* in an input stream. */
+ /* */
typedef union FT_StreamDesc_
{
long value;
@@ -174,80 +191,89 @@ FT_BEGIN_HEADER
} FT_StreamDesc;
- /************************************************************************
- *
- * @functype: FT_Stream_IO
- *
- * @description:
- * a function used to seek and read data from a given input stream
- *
- * @input:
- * stream :: handle to source stream
- * offset :: offset of read in stream (always from start)
- * buffer :: address of read buffer
- * count :: number of bytes to read from the stream
- *
- * @return:
- * number of bytes effectively read by the stream
- *
- * @note:
- * this function might be called to perform seek / skip with
- * a "count" of 0
- */
+ /*************************************************************************/
+ /* */
+ /* @functype: */
+ /* FT_Stream_IO */
+ /* */
+ /* @description: */
+ /* A function used to seek and read data from a given input stream. */
+ /* */
+ /* @input: */
+ /* stream :: A handle to the source stream. */
+ /* */
+ /* offset :: The offset of read in stream (always from start). */
+ /* */
+ /* buffer :: The address of the read buffer. */
+ /* */
+ /* count :: The number of bytes to read from the stream. */
+ /* */
+ /* @return: */
+ /* The number of bytes effectively read by the stream. */
+ /* */
+ /* @note: */
+ /* This function might be called to perform a seek or skip operation */
+ /* with a `count' of 0. */
+ /* */
typedef unsigned long (*FT_Stream_IO)( FT_Stream stream,
unsigned long offset,
unsigned char* buffer,
unsigned long count );
- /************************************************************************
- *
- * @functype: FT_Stream_Close
- *
- * @description:
- * a function used to close a given input stream
- *
- * @input:
- * stream :: handle to target stream
- */
+
+ /*************************************************************************/
+ /* */
+ /* @functype: */
+ /* FT_Stream_Close */
+ /* */
+ /* @description: */
+ /* A function used to close a given input stream. */
+ /* */
+ /* @input: */
+ /* stream :: A handle to the target stream. */
+ /* */
typedef void (*FT_Stream_Close)( FT_Stream stream );
- /************************************************************************
- *
- * @struct: FT_StreamRec
- *
- * @description:
- * a structure used to describe an input stream
- *
- * @input:
- * base :: for memory-based stream, this is the address of the first
- * stream byte in memory. this field should always be set to
- * NULL for disk-based streams.
- *
- * size :: the stream size in bytes
- * pos :: the current position within the stream
- *
- * descriptor :: this field is a union that can hold an integer or a pointer
- * it is used by stream implementations to store file
- * descriptors or FILE* pointers..
- *
- * pathname :: this field is completely ignored by FreeType, however,
- * it's often useful during debugging to use it to store
- * the stream's filename, where available
- *
- * read :: the stream's input function
- * close :: the stream close function
- *
- * memory :: memory manager to use to preload frames. this is set
- * internally by FreeType and shouldn't be touched by
- * stream implementations
- *
- * cursor :: this field is set and used internally by FreeType
- * when parsing frames.
- *
- * limit :: this field is set and used internally by FreeType
- * when parsing frames.
- */
+ /*************************************************************************/
+ /* */
+ /* @struct: */
+ /* FT_StreamRec */
+ /* */
+ /* @description: */
+ /* A structure used to describe an input stream. */
+ /* */
+ /* @input: */
+ /* base :: For memory-based streams, this is the address of the */
+ /* first stream byte in memory. This field should */
+ /* always be set to NULL for disk-based streams. */
+ /* */
+ /* size :: The stream size in bytes. */
+ /* */
+ /* pos :: The current position within the stream. */
+ /* */
+ /* descriptor :: This field is a union that can hold an integer or a */
+ /* pointer. It is used by stream implementations to */
+ /* store file descriptors or FILE* pointers. */
+ /* */
+ /* pathname :: This field is completely ignored by FreeType. */
+ /* However, it is often useful during debugging to use */
+ /* it to store the stream's filename (where available). */
+ /* */
+ /* read :: The stream's input function. */
+ /* */
+ /* close :: The stream;s close function. */
+ /* */
+ /* memory :: The memory manager to use to preload frames. This is */
+ /* set internally by FreeType and shouldn't be touched */
+ /* by stream implementations. */
+ /* */
+ /* cursor :: This field is set and used internally by FreeType */
+ /* when parsing frames. */
+ /* */
+ /* limit :: This field is set and used internally by FreeType */
+ /* when parsing frames. */
+ /* */
struct FT_StreamRec_
{
unsigned char* base;