Commit 8a9d58133b97a9c3c945152f2e157d6269843d00

David Turner 2002-03-30T16:09:24

updating comments for some TT_FaceRec fields

diff --git a/ChangeLog b/ChangeLog
index ab53fe2..2399828 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2002-03-30  David Turner  <david@freetype.org>
+
+        * include/freetype/internal/tttypes.h: adding comments to some of
+          the TT_FaceRec fields.
+
 2002-03-30  Werner Lemberg  <wl@gnu.org>
 
 	* include/freetype/t1tables.h (t1_blend_max): Fix typo.
diff --git a/include/freetype/internal/tttypes.h b/include/freetype/internal/tttypes.h
index 6ce2ff7..e6d8c1a 100644
--- a/include/freetype/internal/tttypes.h
+++ b/include/freetype/internal/tttypes.h
@@ -1333,9 +1333,11 @@ FT_BEGIN_HEADER
   /*                            not loaded by the driver on face opening.  */
   /*                            See the `ttpost' module for more details.  */
   /*                                                                       */
-  /*    cmap_table           :: XXX                                        */
+  /*    cmap_table           :: Address of the face's 'cmap' SFNT table    */
+  /*                            in memory (it's an extracted frame).       */
   /*                                                                       */
-  /*    cmap_size            :: XXX                                        */
+  /*    cmap_size            :: The size in bytes of the 'cmap_table'      */
+  /*                            described above..                          */
   /*                                                                       */
   /*    num_charmaps         :: The number of character mappings in the    */
   /*                            font.                                      */
@@ -1353,15 +1355,23 @@ FT_BEGIN_HEADER
   /*                            can be different for strange formats (e.g. */
   /*                            Type 42).                                  */
   /*                                                                       */
-  /*    access_glyph_frame   :: XXX                                        */
+  /*    access_glyph_frame   :: A function used to access the frame of a   */
+  /*                            given glyph within the face's font file.   */
   /*                                                                       */
-  /*    forget_glyph_frame   :: XXX                                        */
+  /*    forget_glyph_frame   :: A function used to forget the frame of a   */
+  /*                            given glyph when all data has been loaded  */
   /*                                                                       */
-  /*    read_glyph_header    :: XXX                                        */
+  /*    read_glyph_header    :: A function used to read a glyph header.    */
+  /*                            It must be called between an 'access' and  */
+  /*                            'forget'                                   */
   /*                                                                       */
-  /*    read_simple_glyph    :: XXX                                        */
+  /*    read_simple_glyph    :: A function used to read a simple glyph.    */
+  /*                            It must be called after the header was     */
+  /*                            read, and before the 'forget'              */
   /*                                                                       */
-  /*    read_composite_glyph :: XXX                                        */
+  /*    read_composite_glyph :: A function used to read a composite glyph. */
+  /*                            It must be called after the header was     */
+  /*                            read, and before the 'forget'              */
   /*                                                                       */
   /*    sfnt                 :: A pointer to the SFNT `driver' interface.  */
   /*                                                                       */
@@ -1376,7 +1386,7 @@ FT_BEGIN_HEADER
   /*                            table (`gasp').  This table is optional in */
   /*                            TrueType/OpenType fonts.                   */
   /*                                                                       */
-  /*    pclt                 :: XXX                                        */
+  /*    pclt                 :: The 'pclt' SFNT table                      */
   /*                                                                       */
   /*    num_sbit_strikes     :: The number of sbit strikes, i.e., bitmap   */
   /*                            sizes, embedded in this font.              */
@@ -1444,7 +1454,7 @@ FT_BEGIN_HEADER
   /*                            interpreters field is also used to hook    */
   /*                            the debugger in `ttdebug'.                 */
   /*                                                                       */
-  /*    extra                :: XXX                                        */
+  /*    extra                :: reserved for third-party font drivers..    */
   /*                                                                       */
   typedef struct  TT_FaceRec_
   {