diff options
| author | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2022-01-07 10:20:05 +0100 |
|---|---|---|
| committer | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2022-01-13 09:28:24 +0100 |
| commit | 4f92f707796f61466b208d2278e74c8a520d3c92 (patch) | |
| tree | 60248909923040535b144ab7713d8225e00a2623 | |
| parent | ebd6f9fca7d7fd3390f48159b6c4c860ac823381 (diff) | |
Documentation Update: conversion-rule tag
- The 'class' attribute of the tag is made explicit on what each value it takes mean.
Task-number: PYSIDE-1766
Pick-to: 6.2
Change-Id: Ib7ebe1cde81df09e40eafccca7bdf4d70307b90d
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
| -rw-r--r-- | sources/shiboken6/doc/typesystem_arguments.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/sources/shiboken6/doc/typesystem_arguments.rst b/sources/shiboken6/doc/typesystem_arguments.rst index ac5e1c826..b6967e721 100644 --- a/sources/shiboken6/doc/typesystem_arguments.rst +++ b/sources/shiboken6/doc/typesystem_arguments.rst @@ -21,6 +21,17 @@ conversion-rule </conversion-rule> </modify-argument> + The ``class`` attribute accepts one of the following values to define the + conversion direction to be either ``target-to-native`` or ``native-to-target``: + + * ``native``: Defines the conversion direction to be ``target-to-native``. + It is similar to the existing ``<target-to-native>`` element. + See :ref:`Conversion Rule Tag <conversion-rule-tag>` for more information. + + * ``target``: Defines the conversion direction to be ``native-to-target``. + It is similar to the existing ``<native-to-target>`` element. + See :ref:`Conversion Rule Tag <conversion-rule-tag>` for more information. + This node is typically used in combination with the :ref:`replace-type` and :ref:`remove-argument` nodes. The given code is used instead of the generator's conversion code. |