summaryrefslogtreecommitdiff
path: root/include/freetype/ftmodapi.h
diff options
context:
space:
mode:
authorWerner Lemberg <wl@gnu.org>2006-05-12 13:55:04 +0000
committerWerner Lemberg <wl@gnu.org>2006-05-12 13:55:04 +0000
commit2ee71f1f01d1a148a5fed9712e20c628ac9b4671 (patch)
tree2d1d10aed21fa6fc8fe002ace1783db1d6342a34 /include/freetype/ftmodapi.h
parent6756dc15ba424186394ca3f295ba8d125b0f047e (diff)
downloadfreetype2-2ee71f1f01d1a148a5fed9712e20c628ac9b4671.tar.gz
More minor fixes. Move `version' section to the end of freetype.h so that
the library compiles actually.
Diffstat (limited to 'include/freetype/ftmodapi.h')
-rw-r--r--include/freetype/ftmodapi.h22
1 files changed, 14 insertions, 8 deletions
diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h
index ab9082f8f..4628bdf83 100644
--- a/include/freetype/ftmodapi.h
+++ b/include/freetype/ftmodapi.h
@@ -108,8 +108,9 @@ FT_BEGIN_HEADER
/* module_version :: The version, as a 16.16 fixed number */
/* (major.minor). */
/* */
- /* module_requires :: The version of FreeType this module requires */
- /* (starts at version 2.0, i.e., 0x20000) */
+ /* module_requires :: The version of FreeType this module requires, */
+ /* 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. */
@@ -180,8 +181,8 @@ FT_BEGIN_HEADER
/* A module handle. 0 if none was found. */
/* */
/* <Note> */
- /* You should better be familiar with FreeType internals to know */
- /* which module to look for :-) */
+ /* FreeType's internal modules aren't documented very well, and you */
+ /* should look up the source code for details. */
/* */
FT_EXPORT( FT_Module )
FT_Get_Module( FT_Library library,
@@ -275,8 +276,8 @@ FT_BEGIN_HEADER
/* */
/* <Input> */
/* hook_index :: The index of the debug hook. You should use the */
- /* values defined in ftobjs.h, e.g. */
- /* FT_DEBUG_HOOK_TRUETYPE. */
+ /* values defined in `ftobjs.h', e.g., */
+ /* `FT_DEBUG_HOOK_TRUETYPE'. */
/* */
/* debug_hook :: The function used to debug the interpreter. */
/* */
@@ -284,6 +285,10 @@ FT_BEGIN_HEADER
/* Currently, four debug hook slots are available, but only two (for */
/* the TrueType and the Type 1 interpreter) are defined. */
/* */
+ /* Since the internal headers of FreeType are no longer installed, */
+ /* the symbol `FT_DEBUG_HOOK_TRUETYPE' isn't available publicly. */
+ /* This is a bug and will be fixed in a forthcoming release. */
+ /* */
FT_EXPORT( void )
FT_Set_Debug_Hook( FT_Library library,
FT_UInt hook_index,
@@ -298,7 +303,7 @@ FT_BEGIN_HEADER
/* <Description> */
/* Adds the set of default drivers to a given library object. */
/* This is only useful when you create a library object with */
- /* FT_New_Library() (usually to plug a custom memory manager). */
+ /* @FT_New_Library (usually to plug a custom memory manager). */
/* */
/* <InOut> */
/* library :: A handle to a new library object. */
@@ -307,6 +312,7 @@ FT_BEGIN_HEADER
FT_Add_Default_Modules( FT_Library library );
+
/**************************************************************************
*
* @section:
@@ -331,7 +337,7 @@ FT_BEGIN_HEADER
* FT_TrueTypeEngineType
*
* @description:
- * A list of values describing which kind of truetype bytecode
+ * A list of values describing which kind of TrueType bytecode
* engine is implemented in a given FT_Library instance. It is used
* by the @FT_Get_TrueType_Engine_Type function.
*