aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/doc
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2022-04-07 12:49:19 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-04-08 03:08:52 +0000
commit989bbd947173c1bf2d76cbc69e20cf3e462c537d (patch)
treeaf285d53d209b1f895f4e493821f5290d0e42582 /sources/shiboken6/doc
parente3bc0369480347d62c8bb274130daa0ee7f4e880 (diff)
shiboken6: Enable adding modifications to declare-function
Amends 40483a4249306b62029987d03e7de57d456954b2. Task-number: PYSIDE-1627 Change-Id: I1521e7436749fb95f282a07539310257dca3918f Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit d375273ba0d6fed567a5b8cc386395b10f5f2bda) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'sources/shiboken6/doc')
-rw-r--r--sources/shiboken6/doc/typesystem_manipulating_objects.rst3
-rw-r--r--sources/shiboken6/doc/typesystem_modify_function.rst3
2 files changed, 4 insertions, 2 deletions
diff --git a/sources/shiboken6/doc/typesystem_manipulating_objects.rst b/sources/shiboken6/doc/typesystem_manipulating_objects.rst
index 79add6d57..653de7718 100644
--- a/sources/shiboken6/doc/typesystem_manipulating_objects.rst
+++ b/sources/shiboken6/doc/typesystem_manipulating_objects.rst
@@ -261,6 +261,7 @@ add-function
language, and it is a child of an :ref:`object-type` or :ref:`value-type` nodes if the
function is supposed to be a method, or :ref:`namespace` and :ref:`typesystem` if
the function is supposed to be a function inside a namespace or a global function.
+ It may contain :ref:`modify-argument` nodes.
Typically when adding a function some code must be injected to provide the function
logic. This can be done using the :ref:`inject-code` node.
@@ -303,7 +304,7 @@ declare-function
the type and it is a child of an :ref:`object-type` or :ref:`value-type` nodes
if the function is supposed to be a method, or :ref:`namespace` and
:ref:`typesystem` if the function is supposed to be a function inside a
- namespace or a global function.
+ namespace or a global function. It may contain :ref:`modify-argument` nodes.
.. code-block:: xml
diff --git a/sources/shiboken6/doc/typesystem_modify_function.rst b/sources/shiboken6/doc/typesystem_modify_function.rst
index d7cb50dd6..19d0f211a 100644
--- a/sources/shiboken6/doc/typesystem_modify_function.rst
+++ b/sources/shiboken6/doc/typesystem_modify_function.rst
@@ -9,7 +9,8 @@ modify-argument
^^^^^^^^^^^^^^^
Function modifications consist of a list of ``modify-argument`` nodes
- contained in a :ref:`modify-function` node. Use the :ref:`remove-argument`,
+ contained in :ref:`modify-function`, :ref:`add-function` or
+ :ref:`declare-function` nodes. Use the :ref:`remove-argument`,
:ref:`replace-default-expression`, :ref:`remove-default-expression`,
:ref:`replace-type`, :ref:`reference-count` and :ref:`define-ownership`
nodes to specify the details of the modification.