diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2018-07-16 16:30:55 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2018-07-17 07:00:18 +0000 |
| commit | 22abf720dcfa248cf4884e4ac664f6d214c0f790 (patch) | |
| tree | 25a0c46650e5ed9e69ae2adf967cce56a9a18941 /sources | |
| parent | b9ff93a70c74ade2615d79bf9d465137c06cb826 (diff) | |
shiboken: Document the smart-pointer-type
Task-number: PYSIDE-363
Change-Id: Ib07430cb26676a47e6de1453c10b080719f7ed7d
Reviewed-by: Christian Tismer <tismer@stackless.com>
Diffstat (limited to 'sources')
| -rw-r--r-- | sources/shiboken2/ApiExtractor/doc/typesystem_specifying_types.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/sources/shiboken2/ApiExtractor/doc/typesystem_specifying_types.rst b/sources/shiboken2/ApiExtractor/doc/typesystem_specifying_types.rst index 322f9bca6..c5f6463fd 100644 --- a/sources/shiboken2/ApiExtractor/doc/typesystem_specifying_types.rst +++ b/sources/shiboken2/ApiExtractor/doc/typesystem_specifying_types.rst @@ -348,6 +348,26 @@ custom-type The **name** attribute is the name of the custom type, e.g., "PyObject". +.. _smart-pointer-type: + +smart-pointer-type +^^^^^^^^^^^^^^^^^^ + + The smart pointer type node indicates that the given class is a smart pointer + and requires inserting calls to **getter** to access the pointeee. + Currently, only the **type** *shared* is supported and the usage is limited + to function return values. + **ref-count-method** specifies the name of the method used to do reference counting. + + .. code-block:: xml + + <typesystem> + <smart-pointer-type name="..." + since="..." + type="..." + getter="..." + ref-count-method="..."/> + </typesystem> .. _function: |