Commit 214ca056f5fe29e7ae9b7b62a398fca7e5849e0d
2009-01-11T11:45:54
* include/freetype/ftbdf.h (FT_Get_BDF_Property): Improve documentation.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
diff --git a/ChangeLog b/ChangeLog
index 2dfad04..f89f3d1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -2,6 +2,9 @@
* docs/formats.txt: Add link to PCF specification.
+ * include/freetype/ftbdf.h (FT_Get_BDF_Property): Improve
+ documentation.
+
2009-01-09 suzuki toshiya <mpsuzuki@hiroshima-u.ac.jp>
* src/base/ftadvanc.c (_ft_face_scale_advances, FT_Get_Advance,
diff --git a/include/freetype/ftbdf.h b/include/freetype/ftbdf.h
index a8cf6a5..4f8baf8 100644
--- a/include/freetype/ftbdf.h
+++ b/include/freetype/ftbdf.h
@@ -4,7 +4,7 @@
/* */
/* FreeType API for accessing BDF-specific strings (specification). */
/* */
-/* Copyright 2002, 2003, 2004, 2006 by */
+/* Copyright 2002, 2003, 2004, 2006, 2009 by */
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
/* */
/* This file is part of the FreeType project, and may only be used, */
@@ -183,6 +183,14 @@ FT_BEGIN_HEADER
* otherwise. It also returns an error if the property is not in the
* font.
*
+ * A `property' is a either key-value pair within the STARTPROPERTIES
+ * ... ENDPROPERTIES block of a BDF font or a key-value pair from the
+ * `info->props' array within a `FontRec' structure of a PCF font.
+ *
+ * Integer properties are always stored as `signed' within PCF fonts;
+ * consequently, @BDF_PROPERTY_TYPE_CARDINAL is a possible return value
+ * for BDF fonts only.
+ *
* In case of error, `aproperty->type' is always set to
* @BDF_PROPERTY_TYPE_NONE.
*/