summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorWerner Lemberg <wl@gnu.org>2003-07-09 15:20:32 +0000
committerWerner Lemberg <wl@gnu.org>2003-07-09 15:20:32 +0000
commit6aa35cd5e836fb1ae7bf9b50ad7a53311f717265 (patch)
tree362adfa297648bc877107b4b6bb991e766003659 /include
parent8292815bb900d16082310b48484ff2fd34991866 (diff)
downloadfreetype2-6aa35cd5e836fb1ae7bf9b50ad7a53311f717265.tar.gz
* builds/freetype.mk (DOC_DIR): New variable.
(refdoc): Use *_DIR variables. (distclean): Remove documentation files. * builds/detect.mk (std_setup, dos_setup): Mention `make refdoc'. * configure: Set DOC_DIR variable. * builds/freetype.mk (refdoc): New target to build the documentation. (.PHONY): Updated. * include/freetype/freetype.h: Improve documentation of FT_CharMap. * include/freetype/ftimage,h: Fix documentation of FT_OUTLINE_FLAGS. * include/freetype/tttables.h: Document FT_Sfnt_Tag.
Diffstat (limited to 'include')
-rw-r--r--include/freetype/freetype.h4
-rw-r--r--include/freetype/ftimage.h8
-rw-r--r--include/freetype/ftoutln.h2
-rw-r--r--include/freetype/tttables.h16
4 files changed, 21 insertions, 9 deletions
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index f69475584..6c17c7154 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -433,6 +433,10 @@ FT_BEGIN_HEADER
/* @FT_Open_Face), the library looks for a Unicode charmap within */
/* the list and automatically activates it. */
/* */
+ /* <Also> */
+ /* The @FT_CharMapRec details the publicly accessible fields of a */
+ /* given character map. */
+ /* */
typedef struct FT_CharMapRec_* FT_CharMap;
diff --git a/include/freetype/ftimage.h b/include/freetype/ftimage.h
index b2a0a6871..e2e8025b7 100644
--- a/include/freetype/ftimage.h
+++ b/include/freetype/ftimage.h
@@ -358,11 +358,11 @@ FT_BEGIN_HEADER
/*************************************************************************/
/* */
/* <Enum> */
- /* FT_OUTLINE_XXX */
+ /* FT_OUTLINE_FLAGS */
/* */
/* <Description> */
/* A list of bit-field constants use for the flags in an outline's */
- /* `outline_flags' field. */
+ /* `flags' field. */
/* */
/* <Values> */
/* FT_OUTLINE_NONE :: Value 0 is reserved. */
@@ -428,11 +428,11 @@ FT_BEGIN_HEADER
/*************************************************************************
*
* @enum:
- * ft_outline_xxx
+ * ft_outline_flags
*
* @description:
* These constants are deprecated. Please use the corresponding
- * @FT_OUTLINE_XXX values.
+ * @FT_OUTLINE_FLAGS values.
*
* @values:
* ft_outline_none :: See @FT_OUTLINE_NONE.
diff --git a/include/freetype/ftoutln.h b/include/freetype/ftoutln.h
index fdf7ed298..19b5724a5 100644
--- a/include/freetype/ftoutln.h
+++ b/include/freetype/ftoutln.h
@@ -46,7 +46,7 @@ FT_BEGIN_HEADER
/* */
/* <Order> */
/* FT_Outline */
- /* FT_Outline_Flags */
+ /* FT_OUTLINE_FLAGS */
/* FT_Outline_New */
/* FT_Outline_Done */
/* FT_Outline_Copy */
diff --git a/include/freetype/tttables.h b/include/freetype/tttables.h
index 0a78ef968..2d2e63c90 100644
--- a/include/freetype/tttables.h
+++ b/include/freetype/tttables.h
@@ -541,8 +541,15 @@ FT_BEGIN_HEADER
} TT_MaxProfile;
- /* */
-
+ /*************************************************************************/
+ /* */
+ /* <Enum> */
+ /* FT_Sfnt_Tag */
+ /* */
+ /* <Description> */
+ /* An enumeration used to specify the index of an SFNT table. */
+ /* Used in the @FT_Get_Sfnt_Table API function. */
+ /* */
typedef enum
{
ft_sfnt_head = 0,
@@ -553,10 +560,11 @@ FT_BEGIN_HEADER
ft_sfnt_post = 5,
ft_sfnt_pclt = 6,
- sfnt_max /* don't remove */
+ sfnt_max /* internal end mark */
} FT_Sfnt_Tag;
+ /* */
/* internal use only */
typedef void*
@@ -586,7 +594,7 @@ FT_BEGIN_HEADER
/* The table is owned by the face object and disappears with it. */
/* */
/* This function is only useful to access SFNT tables that are loaded */
- /* by the sfnt/truetype/opentype drivers. See FT_Sfnt_Tag for a */
+ /* by the sfnt/truetype/opentype drivers. See @FT_Sfnt_Tag for a */
/* list. */
/* */
FT_EXPORT( void* )