Document FT_Module_Class's `module_interface' field.
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 43 44
diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h
index 4900528..c50c9ce 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.