diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2019-04-03 10:34:54 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2019-04-03 10:48:30 +0000 |
| commit | 1d7af0b25ac241a95e33bd46561033d0b33b9013 (patch) | |
| tree | 665f22d84b263dac40d22bdf8fa58536d7a46c85 /sources/shiboken2/doc/typesystem.rst | |
| parent | 66f466b6c80dc3bc016c7e8f98898805ab2d149e (diff) | |
shiboken: Move the Api extractor documentation into shiboken
It does not really make sense to have it separately and the reference
documentation is currently not accessible from the TOC. Move it over
and append it to the TOC. Merge the chapters on ownership chapters
(for starters, by simply concatenating).
The Api extractor overview chapter is dropped as it is outdated anyways.
Partially reverts 0d12d71920067be499d9237b4ad04f7f11047759.
Task-number: PYSIDE-363
Change-Id: I02f6b0a4bb91fc54267fa03cefd2ac7d4049f07b
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'sources/shiboken2/doc/typesystem.rst')
| -rw-r--r-- | sources/shiboken2/doc/typesystem.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/sources/shiboken2/doc/typesystem.rst b/sources/shiboken2/doc/typesystem.rst new file mode 100644 index 000000000..7674129cd --- /dev/null +++ b/sources/shiboken2/doc/typesystem.rst @@ -0,0 +1,29 @@ +Type System Reference +********************* + +The typesystem is used by a binding generator or any other software using the APIExtractor library +to map a C++ library API onto a higher level language. + +The typesystem specification is a handwritten XML document listing the types +that will be available in the generated target language API; types that are not +declared in the specification will be ignored along with everything depending on +them. In addition, it is possible to manipulate and modify types and functions. +It is even possible to use the typesystem specification to inject arbitrary +code into the source files, such as an extra member function. + +Below there is a complete reference guide to the various nodes (XML tags) of the typesystem. +For usage examples, take a look at the typesystem files used to generate PySide2. These files +can be found in the PySide2/<QT_MODULE_NAME> directory of the PySide2 package. + +.. toctree:: + + typesystem_specifying_types + typesystem_manipulating_objects + typesystem_modify_function + typesystem_arguments + typesystem_solving_compilation + typesystem_templates + typesystem_conversionrule + typesystem_documentation + + |