[Devel] documentation patch

[Patrik Hagglund]

Hi, I had some minor problems with the documentation that I tried to fix 
in the patch below (diff from the current cvs tree).

* FT_Sfnt_Tag is not present in the documentation
* there is no link from FT_CharMap to FT_CharMapRec
* there is no make target for building the documentation
* the documentation doesn't build

/Patrik Hägglund

Index: builds/freetype.mk
===================================================================
RCS file: /cvs/freetype/freetype2/builds/freetype.mk,v
retrieving revision 1.17
diff -u -r1.17 freetype.mk
--- freetype.mk    2003/06/09 04:46:25    1.17
+++ freetype.mk    2003/07/05 16:04:48
@@ -71,7 +71,7 @@
# The targets `objects' and `library' are defined at the end of this
# Makefile after all other rules have been included.
#
-.PHONY: single multi objects library
+.PHONY: single multi objects library refdoc

# default target -- build single objects and library
#
@@ -240,6 +240,17 @@

.c.$O:
    $(FT_COMPILE) $T$(subst /,$(COMPILER_SEP),$@ $<)
+
+
+refdoc:
+    mkdir -p docs/reference
+    python src/tools/docmaker/docmaker.py \
+    --prefix=ft2 \
+    --title=FreeType-2.x.x \
+    --output=docs/reference \
+    include/freetype/*.h \
+    include/freetype/config/*.h \
+    include/freetype/cache/*.h


.PHONY: clean_project_std distclean_project_std
Index: include/freetype/freetype.h
===================================================================
RCS file: /cvs/freetype/freetype2/include/freetype/freetype.h,v
retrieving revision 1.123
diff -u -r1.123 freetype.h
--- freetype.h    2003/07/03 13:56:27    1.123
+++ freetype.h    2003/07/05 16:04:49
@@ -433,6 +433,10 @@
  /*    @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;


Index: include/freetype/ftimage.h
===================================================================
RCS file: /cvs/freetype/freetype2/include/freetype/ftimage.h,v
retrieving revision 1.35
diff -u -r1.35 ftimage.h
--- ftimage.h    2003/07/01 07:28:55    1.35
+++ ftimage.h    2003/07/05 16:04:49
@@ -358,11 +358,11 @@
  
/*************************************************************************/
  
/*                                                                       */
  /* 
<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 @@
 /*************************************************************************
  *
  * @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.
Index: include/freetype/ftoutln.h
===================================================================
RCS file: /cvs/freetype/freetype2/include/freetype/ftoutln.h,v
retrieving revision 1.23
diff -u -r1.23 ftoutln.h
--- ftoutln.h    2002/08/27 20:20:25    1.23
+++ ftoutln.h    2003/07/05 16:04:50
@@ -46,7 +46,7 @@
  
/*                                                                       */
  /* 
<Order>                                                               */
  /*    
FT_Outline                                                         */
-  /*    
FT_Outline_Flags                                                   */
+  /*    
FT_OUTLINE_FLAGS                                                   */
  /*    
FT_Outline_New                                                     */
  /*    
FT_Outline_Done                                                    */
  /*    
FT_Outline_Copy                                                    */
Index: include/freetype/tttables.h
===================================================================
RCS file: /cvs/freetype/freetype2/include/freetype/tttables.h,v
retrieving revision 1.24
diff -u -r1.24 tttables.h
--- tttables.h    2003/04/22 06:53:24    1.24
+++ tttables.h    2003/07/05 16:04:50
@@ -541,8 +541,15 @@
  } TT_MaxProfile;


-  /* */
-
+  
/*************************************************************************/
+  
/*                                                                       */
+  /* 
<Enum>                                                                */
+  /*    
FT_Sfnt_Tag                                                        */
+  
/*                                                                       */
+  /* 
<Description>                                                         */
+  /*    An enumeration used to specify the index of a SFNT 
table.          */
+  /*    Used in the @FT_Get_Sfnt_Table API 
function.                       */
+  
/*                                                                       */
  typedef enum
  {
    ft_sfnt_head = 0,
@@ -553,10 +560,11 @@
    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 @@
  /*    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* )