ref: 6e6acdcb0ebba5d8cecacd6b649d409b7fb5248a
parent: 8ed53468772ec0bc70d121cc1af2c77b1a15e8d0
author: Werner Lemberg <[email protected]>
date: Thu Jul 26 03:22:18 EDT 2018
Document FT_Module_Class's `module_interface' field.
--- a/include/freetype/ftmodapi.h
+++ b/include/freetype/ftmodapi.h
@@ -195,7 +195,9 @@
* 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 ::
@@ -202,20 +204,22 @@
* 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.