[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[freetype2] master 6e6acdc: Document FT_Module_Class's `module_interface
From: |
Werner LEMBERG |
Subject: |
[freetype2] master 6e6acdc: Document FT_Module_Class's `module_interface' field. |
Date: |
Thu, 26 Jul 2018 01:23:47 -0400 (EDT) |
branch: master
commit 6e6acdcb0ebba5d8cecacd6b649d409b7fb5248a
Author: Werner Lemberg <address@hidden>
Commit: Werner Lemberg <address@hidden>
Document FT_Module_Class's `module_interface' field.
---
include/freetype/ftmodapi.h | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
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.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [freetype2] master 6e6acdc: Document FT_Module_Class's `module_interface' field.,
Werner LEMBERG <=