rgraves
/
freetype2
forked from minhngoc25a/freetype2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve documentation. From Ville Syrjl <syrjala@sci.fi>.

This commit is contained in:
Werner Lemberg 2005-11-04 11:33:32 +00:00
parent b2d025306e
commit 319c8b339b
1 changed files with 33 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
include/freetype/freetype.h
View File

@ -1842,7 +1842,9 @@ FT_BEGIN_HEADER
/* 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 @@ FT_BEGIN_HEADER
/* 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 @@ FT_BEGIN_HEADER
/* 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 @@ FT_BEGIN_HEADER
/* 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 @@ FT_BEGIN_HEADER
/* 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,