Commit 665f30d3aabc78fdee1d6926bdcb89c40b4ff8ff

David Turner 2002-05-28T20:14:28

* include/freetype/ftbdf.h: adding documentation comments for the API reference describing the new function FT_Get_BDF_Charset_ID.

diff --git a/ChangeLog b/ChangeLog
index 305c06f..560a685 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,9 @@
-2002-05-29  Werner Lemberg  <wl@gnu.org>
+2005-05-28  David Turner  <david@freetype.org>
+
+    * include/freetype/ftbdf.h: adding documentation comments for the
+    API reference describing the new function FT_Get_BDF_Charset_ID.
+
+2002-05-28  Werner Lemberg  <wl@gnu.org>
 
 	* src/base/ftnames.c (FT_Get_Sfnt_Name): Don't use FT_STREAM_READ_AT
 	but FT_STREAM_READ.
@@ -6,7 +11,7 @@
 
 2002-05-28  David Turner  <david@freetype.org>
 
-	Fixing the SFNT name table loader to support various buggy fonts. 
+	Fixing the SFNT name table loader to support various buggy fonts.
 	It now ignores empty name entries, entries with invalid pointer
 	Offsets and certain fonts containing tables with broken
 	"storageOffset" fields.
diff --git a/include/freetype/ftbdf.h b/include/freetype/ftbdf.h
index 2e25c2d..fe5f8b6 100644
--- a/include/freetype/ftbdf.h
+++ b/include/freetype/ftbdf.h
@@ -26,11 +26,52 @@
 FT_BEGIN_HEADER
 
 
+  /*************************************************************************/
+  /*                                                                       */
+  /* <Section>                                                             */
+  /*    bdf_fonts                                                          */
+  /*                                                                       */
+  /* <Title>                                                               */
+  /*    BDF Fonts                                                          */
+  /*                                                                       */
+  /* <Abstract>                                                            */
+  /*    BDF-specific APIs                                                  */
+  /*                                                                       */
+  /* <Description>                                                         */
+  /*    This section contains the declaration of BDF-specific functions.   */
+  /*                                                                       */
+  /*************************************************************************/
+
+
+ /**********************************************************************
+  *
+  * @function: FT_Get_BDF_Charset_ID
+  *
+  * @description:
+  *    retrieves a BDF font character set identity, according to
+  *    the BDF specification
+  *
+  * @input:
+  *    face  :: handle to input face
+  *
+  * @output:
+  *    acharset_encoding :: charset encoding, as a C string owned by the face
+  *    acharset_registry :: charset register, as a C string owned by the face
+  *
+  * @return:
+  *   error code. 0 means success
+  *
+  * @note:
+  *   this function will only work with BDF faces, it will return an
+  *   error otherwise.
+  */
   FT_EXPORT( FT_Error )
   FT_Get_BDF_Charset_ID( FT_Face       face,
                          const char*  *acharset_encoding,
                          const char*  *acharset_registry );
 
+ /* */
+
 FT_END_HEADER
 
 #endif /* __FTBDF_H__ */