aboutsummaryrefslogtreecommitdiffstats
path: root/doc/typesystem_specifying_types.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/typesystem_specifying_types.rst')
-rw-r--r--doc/typesystem_specifying_types.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/typesystem_specifying_types.rst b/doc/typesystem_specifying_types.rst
index d5a4ef2d..0d24a6d5 100644
--- a/doc/typesystem_specifying_types.rst
+++ b/doc/typesystem_specifying_types.rst
@@ -328,6 +328,26 @@ container-type
The *optional* **since** value is used to specify the API version of this container.
+
+.. _custom-type:
+
+custom-type
+^^^^^^^^^^^
+
+ The custom-type node simply makes the parser aware of the existence of a target
+ language type, thus avoiding errors when trying to find a type used in function
+ signatures and other places. The proper handling of the custom type is meant to
+ be done by a generator using the APIExractor.
+
+ .. code-block:: xml
+
+ <typesystem>
+ <custom-type name="..." />
+ </typesystem>
+
+ The **name** attribute is the name of the custom type, e.g., "PyObject".
+
+
.. _function:
function