Commit 8aed85292358a9e0f89931fa0d1f5ca72e591f31

David Turner 2000-10-23T18:33:30

- reformatting and tiny doc update

diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index dc22eb9..e84441e 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -599,13 +599,12 @@
     FT_Int           num_fixed_sizes;
     FT_Bitmap_Size*  available_sizes;
 
-    /* the face's table of available charmaps */
     FT_Int           num_charmaps;
     FT_CharMap*      charmaps;
 
     FT_Generic       generic;
 
-    /* the following are only relevant for scalable outlines */
+    /*# the following are only relevant for scalable outlines */
     FT_BBox          bbox;
 
     FT_UShort        units_per_EM;
@@ -622,9 +621,7 @@
     FT_GlyphSlot     glyph;
     FT_Size          size;
 
-    /************************************************************/
-    /* The following fields should be considered private and    */
-    /* rarely, if ever, used directly by client applications.   */
+    /*@private begin */
 
     FT_Driver        driver;
     FT_Memory        memory;
@@ -643,6 +640,8 @@
     FT_Vector        transform_delta;
     FT_Int           transform_flags;
 
+    /*@private end */
+
   } FT_FaceRec;
 
 
@@ -792,23 +791,32 @@
   /*                                                                       */
 #define FT_FACE_FLAG_EXTERNAL_STREAM   0x4000
 
+  /* */
 
 #define FT_HAS_HORIZONTAL( face ) \
           ( face->face_flags & FT_FACE_FLAG_HORIZONTAL )
+
 #define FT_HAS_VERTICAL( face ) \
           ( face->face_flags & FT_FACE_FLAG_VERTICAL )
+
 #define FT_HAS_KERNING( face ) \
           ( face->face_flags & FT_FACE_FLAG_KERNING )
+
 #define FT_IS_SCALABLE( face ) \
           ( face->face_flags & FT_FACE_FLAG_SCALABLE )
+
 #define FT_IS_SFNT( face ) \
           ( face->face_flags & FT_FACE_FLAG_SFNT )
+
 #define FT_IS_FIXED_WIDTH( face ) \
           ( face->face_flags & FT_FACE_FLAG_FIXED_WIDTH )
+
 #define FT_HAS_FIXED_SIZES( face ) \
           ( face->face_flags & FT_FACE_FLAG_FIXED_SIZES )
+
 #define FT_HAS_FAST_GLYPHS( face ) \
           ( face->face_flags & FT_FACE_FLAG_FAST_GLYPHS )
+
 #define FT_HAS_GLYPH_NAMES( face ) \
           ( face->face_flags & FT_FACE_FLAG_GLYPH_NAMES )
 
@@ -1141,8 +1149,9 @@
 
     void*             other;
 
-    /* private fields */
+    /*@private begin*/
     FT_GlyphLoader*   loader;
+    /*@private end*/
 
   } FT_GlyphSlotRec;
 
@@ -2272,7 +2281,7 @@
   FT_EXPORT_DEF( void )  FT_Vector_Transform( FT_Vector*  vec,
                                               FT_Matrix*  matrix );
 
-
+  /* */
 
 #ifdef __cplusplus
   }
diff --git a/include/freetype/ftrender.h b/include/freetype/ftrender.h
index cbdce39..b3db909 100644
--- a/include/freetype/ftrender.h
+++ b/include/freetype/ftrender.h
@@ -29,24 +29,24 @@
 
 
   /* create a new glyph object */
-  typedef FT_Error  (*FT_Glyph_Init_Func)( FT_Glyph      glyph,
-                                           FT_GlyphSlot  slot );
+  typedef FT_Error  (*FT_Glyph_Init_Func)     ( FT_Glyph      glyph,
+                                                FT_GlyphSlot  slot );
 
   /* destroys a given glyph object */
-  typedef void  (*FT_Glyph_Done_Func)( FT_Glyph  glyph );
+  typedef void      (*FT_Glyph_Done_Func)     ( FT_Glyph  glyph );
 
-  typedef void  (*FT_Glyph_Transform_Func)( FT_Glyph    glyph,
-                                            FT_Matrix*  matrix,
-                                            FT_Vector*  delta );
+  typedef void      (*FT_Glyph_Transform_Func)( FT_Glyph    glyph,
+                                                FT_Matrix*  matrix,
+                                                FT_Vector*  delta );
 
-  typedef void  (*FT_Glyph_BBox_Func)( FT_Glyph  glyph,
-                                       FT_BBox*  abbox );
+  typedef void      (*FT_Glyph_BBox_Func)     ( FT_Glyph  glyph,
+                                                FT_BBox*  abbox );
 
-  typedef FT_Error  (*FT_Glyph_Copy_Func)( FT_Glyph   source,
-                                           FT_Glyph   target );
+  typedef FT_Error  (*FT_Glyph_Copy_Func)     ( FT_Glyph   source,
+                                                FT_Glyph   target );
 
-  typedef FT_Error  (*FT_Glyph_Prepare_Func)( FT_Glyph      glyph,
-                                              FT_GlyphSlot  slot );
+  typedef FT_Error  (*FT_Glyph_Prepare_Func)  ( FT_Glyph      glyph,
+                                                FT_GlyphSlot  slot );
 
   struct  FT_Glyph_Class_
   {
@@ -61,23 +61,23 @@
   };
 
 
-  typedef FT_Error  (*FTRenderer_render)( FT_Renderer   renderer,
-                                          FT_GlyphSlot  slot,
-                                          FT_UInt       mode,
-                                          FT_Vector*    origin );
+  typedef FT_Error  (*FTRenderer_render)   ( FT_Renderer   renderer,
+                                             FT_GlyphSlot  slot,
+                                             FT_UInt       mode,
+                                             FT_Vector*    origin );
 
   typedef FT_Error  (*FTRenderer_transform)( FT_Renderer   renderer,
                                              FT_GlyphSlot  slot,
                                              FT_Matrix*    matrix,
                                              FT_Vector*    delta );
 
-  typedef void  (*FTRenderer_getCBox)( FT_Renderer   renderer,
-                                       FT_GlyphSlot  slot,
-                                       FT_BBox*      cbox );
+  typedef void      (*FTRenderer_getCBox)  ( FT_Renderer   renderer,
+                                             FT_GlyphSlot  slot,
+                                             FT_BBox*      cbox );
 
-  typedef FT_Error  (*FTRenderer_setMode)( FT_Renderer  renderer,
-                                           FT_ULong     mode_tag,
-                                           FT_Pointer   mode_ptr );
+  typedef FT_Error  (*FTRenderer_setMode)  ( FT_Renderer  renderer,
+                                             FT_ULong     mode_tag,
+                                             FT_Pointer   mode_ptr );
 
 
   /*************************************************************************/
diff --git a/include/freetype/internal/ftdriver.h b/include/freetype/internal/ftdriver.h
index e239fd9..bdf580a 100644
--- a/include/freetype/internal/ftdriver.h
+++ b/include/freetype/internal/ftdriver.h
@@ -29,59 +29,59 @@
 #endif
 
 
-  typedef FT_Error  (*FTDriver_initFace)( FT_Stream      stream,
-                                          FT_Face        face,
-                                          FT_Int         typeface_index,
-                                          FT_Int         num_params,
-                                          FT_Parameter*  parameters );
+  typedef FT_Error  (*FTDriver_initFace)     ( FT_Stream      stream,
+                                               FT_Face        face,
+                                               FT_Int         typeface_index,
+                                               FT_Int         num_params,
+                                               FT_Parameter*  parameters );
 
-  typedef void  (*FTDriver_doneFace)( FT_Face  face );
+  typedef void      (*FTDriver_doneFace)     ( FT_Face  face );
 
 
-  typedef FT_Error  (*FTDriver_initSize)( FT_Size  size );
+  typedef FT_Error  (*FTDriver_initSize)     ( FT_Size  size );
 
-  typedef void  (*FTDriver_doneSize)( FT_Size  size );
+  typedef void      (*FTDriver_doneSize)     ( FT_Size  size );
 
 
   typedef FT_Error  (*FTDriver_initGlyphSlot)( FT_GlyphSlot  slot );
 
-  typedef void  (*FTDriver_doneGlyphSlot)( FT_GlyphSlot  slot );
+  typedef void      (*FTDriver_doneGlyphSlot)( FT_GlyphSlot  slot );
 
 
-  typedef FT_Error  (*FTDriver_setCharSizes)( FT_Size     size,
-                                              FT_F26Dot6  char_width,
-                                              FT_F26Dot6  char_height,
-                                              FT_UInt     horz_resolution,
-                                              FT_UInt     vert_resolution );
+  typedef FT_Error  (*FTDriver_setCharSizes) ( FT_Size     size,
+                                               FT_F26Dot6  char_width,
+                                               FT_F26Dot6  char_height,
+                                               FT_UInt     horz_resolution,
+                                               FT_UInt     vert_resolution );
 
   typedef FT_Error  (*FTDriver_setPixelSizes)( FT_Size  size,
                                                FT_UInt  pixel_width,
                                                FT_UInt  pixel_height );
 
-  typedef FT_Error  (*FTDriver_loadGlyph)( FT_GlyphSlot  slot,
-                                           FT_Size       size,
-                                           FT_UInt       glyph_index,
-                                           FT_Int        load_flags );
+  typedef FT_Error  (*FTDriver_loadGlyph)    ( FT_GlyphSlot  slot,
+                                               FT_Size       size,
+                                               FT_UInt       glyph_index,
+                                               FT_Int        load_flags );
 
 
-  typedef FT_UInt  (*FTDriver_getCharIndex)( FT_CharMap  charmap,
-                                             FT_Long     charcode );
+  typedef FT_UInt  (*FTDriver_getCharIndex)  ( FT_CharMap  charmap,
+                                               FT_Long     charcode );
 
-  typedef FT_Error  (*FTDriver_getKerning)( FT_Face      face,
-                                            FT_UInt      left_glyph,
-                                            FT_UInt      right_glyph,
-                                            FT_Vector*   kerning );
+  typedef FT_Error  (*FTDriver_getKerning)   ( FT_Face      face,
+                                               FT_UInt      left_glyph,
+                                               FT_UInt      right_glyph,
+                                               FT_Vector*   kerning );
 
 
-  typedef FT_Error  (*FTDriver_attachFile)( FT_Face    face,
-                                            FT_Stream  stream );
+  typedef FT_Error  (*FTDriver_attachFile)   ( FT_Face    face,
+                                               FT_Stream  stream );
 
 
-  typedef FT_Error  (*FTDriver_getAdvances)( FT_Face     face,
-                                             FT_UInt     first,
-                                             FT_UInt     count,
-                                             FT_Bool     vertical,
-                                             FT_UShort*  advances );
+  typedef FT_Error  (*FTDriver_getAdvances)  ( FT_Face     face,
+                                               FT_UInt     first,
+                                               FT_UInt     count,
+                                               FT_Bool     vertical,
+                                               FT_UShort*  advances );
 
 
   /*************************************************************************/
diff --git a/include/freetype/internal/ftobjs.h b/include/freetype/internal/ftobjs.h
index ca60560..a2577b0 100644
--- a/include/freetype/internal/ftobjs.h
+++ b/include/freetype/internal/ftobjs.h
@@ -284,11 +284,11 @@
   BASE_DEF( FT_Error )  FT_GlyphLoader_Create_Extra(
                           FT_GlyphLoader*  loader );                                        
   
-  BASE_DEF( void )  FT_GlyphLoader_Done( FT_GlyphLoader*  loader );
+  BASE_DEF( void )      FT_GlyphLoader_Done( FT_GlyphLoader*  loader );
   
-  BASE_DEF( void )  FT_GlyphLoader_Reset( FT_GlyphLoader*  loader );
+  BASE_DEF( void )      FT_GlyphLoader_Reset( FT_GlyphLoader*  loader );
   
-  BASE_DEF( void )  FT_GlyphLoader_Rewind( FT_GlyphLoader*  loader );
+  BASE_DEF( void )      FT_GlyphLoader_Rewind( FT_GlyphLoader*  loader );
   
   BASE_DEF( FT_Error )  FT_GlyphLoader_Check_Points(
                           FT_GlyphLoader*  loader,
@@ -299,9 +299,9 @@
                           FT_GlyphLoader*  loader,
                           FT_UInt          n_subs );
 
-  BASE_DEF( void )  FT_GlyphLoader_Prepare( FT_GlyphLoader*  loader );
+  BASE_DEF( void )      FT_GlyphLoader_Prepare( FT_GlyphLoader*  loader );
 
-  BASE_DEF( void )  FT_GlyphLoader_Add( FT_GlyphLoader*  loader );
+  BASE_DEF( void )      FT_GlyphLoader_Add( FT_GlyphLoader*  loader );
 
   BASE_DEF( FT_Error )  FT_GlyphLoader_Copy_Points( FT_GlyphLoader*  target,
                                                     FT_GlyphLoader*  source );