summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWerner Lemberg <wl@gnu.org>2018-07-26 07:22:18 +0200
committerWerner Lemberg <wl@gnu.org>2018-07-26 07:22:43 +0200
commit6e6acdcb0ebba5d8cecacd6b649d409b7fb5248a (patch)
tree9838d5211ef6c93e53a3640a725940a48c8239d7
parent8ed53468772ec0bc70d121cc1af2c77b1a15e8d0 (diff)
downloadfreetype2-6e6acdcb0ebba5d8cecacd6b649d409b7fb5248a.tar.gz
Document FT_Module_Class's `module_interface' field.
-rw-r--r--include/freetype/ftmodapi.h20
1 files changed, 12 insertions, 8 deletions
diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h
index 4900528c6..c50c9ce40 100644
--- a/include/freetype/ftmodapi.h
+++ b/include/freetype/ftmodapi.h
@@ -195,27 +195,31 @@ FT_BEGIN_HEADER
* FT_Module_Class
*
* @description:
- * The module class descriptor.
+ * The module class descriptor. While being a public structure
+ * necessary for FreeType's module bookkeeping, most of the fields are
+ * essentially internal, not to be used directly by an application.
*
* @fields:
* module_flags ::
* Bit flags describing the module.
*
* module_size ::
- * The size of one module object/instance in
- * bytes.
+ * The size of one module object/instance in bytes.
*
* module_name ::
* The name of the module.
*
* module_version ::
- * The version, as a 16.16 fixed number
- * (major.minor).
+ * The version, as a 16.16 fixed number (major.minor).
*
* module_requires ::
- * The version of FreeType this module requires,
- * as a 16.16 fixed number (major.minor). Starts
- * at version 2.0, i.e., 0x20000.
+ * The version of FreeType this module requires, as a 16.16 fixed
+ * number (major.minor). Starts at version 2.0, i.e., 0x20000.
+ *
+ * module_interface ::
+ * A typeless pointer to a structure (which varies between different
+ * modules) that holds the module's interface functions. This is
+ * essentially what `get_interface' returns.
*
* module_init ::
* The initializing function.