aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/doc/typesystem_modify_function.rst
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2020-12-02 10:35:13 +0100
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2020-12-02 10:27:30 +0000
commit844f76cf8e01377fa3de6ac8c61eb8342c0c31f1 (patch)
tree386a3cccc9226590e526cd64e0332a128c264146 /sources/shiboken6/doc/typesystem_modify_function.rst
parentaf294cd6e1a55ee50ccb1dee66a401386bc351db (diff)
shiboken6: Remove deprecated typesystem tags
<remove> and <access> were deprecated in favor of attributes on the functions in PySide2. Similarly for <rename>, but it is still used as a child of <modify-argument>. Leave this usage in place, but add parsing of the rename attribute to <modify-argument>. Change-Id: I8e80ba13a3e4af1df0448bd0de034d242a9fdeb4 Reviewed-by: Christian Tismer <tismer@stackless.com>
Diffstat (limited to 'sources/shiboken6/doc/typesystem_modify_function.rst')
-rw-r--r--sources/shiboken6/doc/typesystem_modify_function.rst53
1 files changed, 3 insertions, 50 deletions
diff --git a/sources/shiboken6/doc/typesystem_modify_function.rst b/sources/shiboken6/doc/typesystem_modify_function.rst
index 071cea4f5..d7ed13b07 100644
--- a/sources/shiboken6/doc/typesystem_modify_function.rst
+++ b/sources/shiboken6/doc/typesystem_modify_function.rst
@@ -17,7 +17,7 @@ modify-argument
.. code-block:: xml
<modify-function>
- <modify-argument index="return | this | 1 ..." >
+ <modify-argument index="return | this | 1 ..." rename="...">
// modifications
</modify-argument>
</modify-function>
@@ -27,52 +27,5 @@ modify-argument
modify the function's return value or the object the function is called upon,
respectively.
-.. _remove:
-
-remove
-^^^^^^
-
- The remove node removes the given method from the generated target language
- API, and it is a child of the modify-function node.
-
- .. code-block:: xml
-
- <modify-function>
- <remove class="all" />
- </modify-function>
-
- .. warning:: This tag is deprecated, use the ``remove`` attribute from :ref:`modify-function` tag instead.
-
-.. _access:
-
-access
-^^^^^^
-
- The access node changes the access privileges of the given function in the
- generated target language API, and it is a child of the modify-function node.
-
- .. code-block:: xml
-
- <modify-function>
- <access modifier="public | protected | private"/>
- </modify-function>
-
- .. warning:: This tag is deprecated, use the ``access`` attribute from :ref:`modify-function` tag instead.
-
-.. _rename:
-
-rename
-^^^^^^
-
- The rename node changes the name of the given function in the generated target
- language API, and it is a child of the modify-function node.
-
- .. code-block:: xml
-
- <modify-function>
- <rename to="..." />
- </modify-function>
-
- The ``to`` attribute is the new name of the function.
-
- .. warning:: This tag is deprecated, use the ``rename`` attribute from :ref:`modify-function` tag instead.
+ The optional ``rename`` attribute is used to rename a argument and use this
+ new name in the generated code.