ref: 319c8b339b7b4fd504cc2b9e0f873291c6c1c42a
parent: b2d025306e3d0b3a4a14f63ac171d496d94eaee6
author: Werner Lemberg <[email protected]>
date: Fri Nov 4 06:33:32 EST 2005
Improve documentation. From Ville Syrj�l� <[email protected]>.
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -1842,7 +1842,9 @@
/* first face has index 0. */
/* */
/* <Output> */
- /* aface :: A handle to a new face object. */
+ /* aface :: A handle to a new face object. If `face_index' is */
+ /* greater than or equal to zero, it must be non-NULL. */
+ /* See note below. */
/* */
/* <Return> */
/* FreeType error code. 0 means success. */
@@ -1852,11 +1854,15 @@
/* slot for the face object which can be accessed directly through */
/* `face->glyph'. */
/* */
- /* @FT_New_Face can be used to determine and/or check the font format */
- /* of a given font resource. If the `face_index' field is negative, */
- /* the function does _not_ return any face handle in `aface'; the */
- /* return value is 0 if the font format is recognized, or non-zero */
- /* otherwise. */
+ /* @FT_New_Face can be used to quickly check whether the font */
+ /* format of a given font resource is supported by FreeType. If the */
+ /* `face_index' field is negative, the function's return value is 0 */
+ /* if the font format is recognized, or non-zero otherwise; */
+ /* the function returns a more or less empty face handle in `*aface' */
+ /* (if `aface' isn't NULL). The only useful field in this special */
+ /* case is `face->num_faces' which gives the number of faces within */
+ /* the font file. After examination, the returned @FT_Face structure */
+ /* should be deallocated with a call to @FT_Done_Face. */
/* */
/* Each new face object created with this function also owns a */
/* default @FT_Size object, accessible as `face->size'. */
@@ -1889,7 +1895,9 @@
/* first face has index 0. */
/* */
/* <Output> */
- /* aface :: A handle to a new face object. */
+ /* aface :: A handle to a new face object. If `face_index' is */
+ /* greater than or equal to zero, it must be non-NULL. */
+ /* See note below. */
/* */
/* <Return> */
/* FreeType error code. 0 means success. */
@@ -1904,11 +1912,15 @@
/* slot for the face object which can be accessed directly through */
/* `face->glyph'. */
/* */
- /* @FT_New_Memory_Face can be used to determine and/or check the font */
- /* format of a given font resource. If the `face_index' field is */
- /* negative, the function does _not_ return any face handle in */
- /* `aface'; the return value is 0 if the font format is recognized, */
- /* or non-zero otherwise. */
+ /* @FT_New_Memory_Face can be used to quickly check whether the font */
+ /* format of a given font resource is supported by FreeType. If the */
+ /* `face_index' field is negative, the function's return value is 0 */
+ /* if the font format is recognized, or non-zero otherwise; */
+ /* the function returns a more or less empty face handle in `*aface' */
+ /* (if `aface' isn't NULL). The only useful field in this special */
+ /* case is `face->num_faces' which gives the number of faces within */
+ /* the font file. After examination, the returned @FT_Face structure */
+ /* should be deallocated with a call to @FT_Done_Face. */
/* */
FT_EXPORT( FT_Error )
FT_New_Memory_Face( FT_Library library,
@@ -1951,15 +1963,15 @@
/* slot for the face object which can be accessed directly through */
/* `face->glyph'. */
/* */
- /* @FT_Open_Face can be used to quickly check whether the font format */
- /* of a given font resource is supported by FreeType. If the */
- /* `face_index' field is negative, the function returns a more or */
- /* less empty face handle in `*aface' (if `aface' isn't NULL); the */
- /* function's return value is 0 if the font format is recognized, or */
- /* non-zero otherwise. The only useful field in this special case is */
- /* `face->num_faces' which gives the number of faces within the font */
- /* file. After examination, the returned @FT_Face structure should */
- /* be deallocated with a call to @FT_Done_Face. */
+ /* @FT_Open_Face can be used to quickly check whether the font */
+ /* format of a given font resource is supported by FreeType. If the */
+ /* `face_index' field is negative, the function's return value is 0 */
+ /* if the font format is recognized, or non-zero otherwise; */
+ /* the function returns a more or less empty face handle in `*aface' */
+ /* (if `aface' isn't NULL). The only useful field in this special */
+ /* case is `face->num_faces' which gives the number of faces within */
+ /* the font file. After examination, the returned @FT_Face structure */
+ /* should be deallocated with a call to @FT_Done_Face. */
/* */
FT_EXPORT( FT_Error )
FT_Open_Face( FT_Library library,