Commit 9d3de385a6ac989223d3c179fd5c78b88a3783b7

Werner Lemberg 2005-10-26T20:08:45

Fix comment style.

diff --git a/include/freetype/ftstroke.h b/include/freetype/ftstroke.h
index c6c96de..f4c14bd 100644
--- a/include/freetype/ftstroke.h
+++ b/include/freetype/ftstroke.h
@@ -4,7 +4,7 @@
 /*                                                                         */
 /*    FreeType path stroker (specification).                               */
 /*                                                                         */
-/*  Copyright 2002, 2003, 2004 by                                          */
+/*  Copyright 2002, 2003, 2004, 2005 by                                    */
 /*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */
 /*                                                                         */
 /*  This file is part of the FreeType project, and may only be used,       */
@@ -29,16 +29,16 @@ FT_BEGIN_HEADER
 
  /************************************************************************
   *
-  * <Section>
+  * @section:
   *    glyph_stroker
   *
-  * <Title>
+  * @title:
   *    Glyph Stroker
   *
-  * <Abstract>
+  * @abstract:
   *    Generating bordered and stroked glyphs.
   *
-  * <Description>
+  * @description:
   *    This component generates stroked outlines of a given vectorial
   *    glyph.  It also allows you to retrieve the `outside' and/or the
   *    `inside' borders of the stroke.
diff --git a/include/freetype/tttables.h b/include/freetype/tttables.h
index 051c1ea..0a5f302 100644
--- a/include/freetype/tttables.h
+++ b/include/freetype/tttables.h
@@ -5,7 +5,7 @@
 /*    Basic SFNT/TrueType tables definitions and interface                 */
 /*    (specification only).                                                */
 /*                                                                         */
-/*  Copyright 1996-2001, 2002, 2003, 2004 by                               */
+/*  Copyright 1996-2001, 2002, 2003, 2004, 2005 by                         */
 /*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */
 /*                                                                         */
 /*  This file is part of the FreeType project, and may only be used,       */
@@ -604,56 +604,61 @@ FT_BEGIN_HEADER
 
  /**************************************************************************
   *
-  * <Function>
-  *    FT_Load_Sfnt_Table
+  * @function:
+  *   FT_Load_Sfnt_Table
   *
-  * <Description>
+  * @description:
   *   Loads any font table into client memory.
   *
-  * <Input>
-  *   face   :: A handle to the source face.
+  * @input:
+  *   face ::
+  *     A handle to the source face.
   *
-  *   tag    :: The 4-byte tag of the table to load.  Use the value 0 if
-  *             you want to access the whole font file.  Otherwise, you can
-  *             use one of the definitions found in the @FT_TRUETYPE_TAGS_H
-  *             file, or forge a new one with @FT_MAKE_TAG.
+  *   tag ::
+  *     The 4-byte tag of the table to load.  Use the value 0 if you want to
+  *     access the whole font file.  Otherwise, you can use one of the
+  *     definitions found in the @FT_TRUETYPE_TAGS_H file, or forge a new
+  *     one with @FT_MAKE_TAG.
   *              
-  *   offset :: The starting offset in the table (or file if tag == 0).
+  *   offset ::
+  *     The starting offset in the table (or file if tag == 0).
   *
-  * <Output>
-  *   buffer :: The target buffer address.  The client must ensure that
-  *             the memory array is big enough to hold the data.
+  * @output:
+  *   buffer ::
+  *     The target buffer address.  The client must ensure that the memory
+  *     array is big enough to hold the data.
   *
-  * <InOut>
-  *   length :: If the `length' parameter is NULL, then try to load the whole
-  *             table.  Return an error code if it fails.
+  * @inout:
+  *   length ::
+  *     If the `length' parameter is NULL, then try to load the whole table. 
+  *     Return an error code if it fails.
   *
-  *             Else, if `*length' is 0, exit immediately while returning
-  *             the table's (or file) full size in it.
+  *     Else, if `*length' is 0, exit immediately while returning the
+  *     table's (or file) full size in it.
   *
-  *             Else the number of bytes to read from the table or file,
-  *             from the starting offset.
+  *     Else the number of bytes to read from the table or file, from the
+  *     starting offset.
   *
-  * <Return>
+  * @return:
   *   FreeType error code.  0 means success.
   *
-  * <Note>
+  * @note:
   *   If you need to determine the table's length you should first call this
   *   function with `*length' set to 0, as in the following example:
   *
-  *   {
-  *     FT_ULong  length = 0;
+  *     {
+  *       FT_ULong  length = 0;
   *
   *
-  *     error = FT_Load_Sfnt_Table( face, tag, 0, NULL, &length );
-  *     if ( error ) { ... table does not exist ... }
+  *       error = FT_Load_Sfnt_Table( face, tag, 0, NULL, &length );
+  *       if ( error ) { ... table does not exist ... }
   *
-  *     buffer = malloc( length );
-  *     if ( buffer == NULL ) { ... not enough memory ... }
+  *       buffer = malloc( length );
+  *       if ( buffer == NULL ) { ... not enough memory ... }
   *
-  *     error = FT_Load_Sfnt_Table( face, tag, 0, buffer, &length );
-  *     if ( error ) { ... could not load table ... }
-  *   }
+  *       error = FT_Load_Sfnt_Table( face, tag, 0, buffer, &length );
+  *       if ( error ) { ... could not load table ... }
+  *     }
   */
   FT_EXPORT( FT_Error )
   FT_Load_Sfnt_Table( FT_Face    face,
@@ -665,13 +670,13 @@ FT_BEGIN_HEADER
 
  /**************************************************************************
   *
-  * <Function>
-  *    FT_Sfnt_Table_Info
+  * @function:
+  *   FT_Sfnt_Table_Info
   *
-  * <Description>
+  * @description:
   *   Returns information on an SFNT table.
   *
-  * <Input>
+  * @input:
   *   face ::
   *     A handle to the source face.
   *
@@ -679,17 +684,17 @@ FT_BEGIN_HEADER
   *     The index of an SFNT table.  The function returns
   *     FT_Err_Table_Missing for an invalid value.
   *
-  * <Output>
+  * @output:
   *   tag ::
   *     The name tag of the SFNT table.
   *
   *   length ::
   *     The length of the SFNT table.
   *
-  * <Return>
+  * @return:
   *   FreeType error code.  0 means success.
   *
-  * <Note>
+  * @note:
   *   SFNT tables with length zero are treated as missing by Windows.
   *
   */