aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken2/ApiExtractor/doc
diff options
context:
space:
mode:
authorCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2018-04-13 13:55:45 +0200
committerCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2018-04-26 14:34:03 +0000
commit0d12d71920067be499d9237b4ad04f7f11047759 (patch)
tree258ddf9f4b76a46f2abc656b6c725857b606c509 /sources/shiboken2/ApiExtractor/doc
parent0b842db3a95a44fbda3379d2093cb52f8ae2a1ff (diff)
Add references from ApiExtractor to shiboken doc
Including intersphinx extension allow us to link the documentation from ApiExtractor to shiboken's. ApiExtractor doc need to be build first, so we can use the inventory that sphinx create, to link it to shiboken's configuration. All the harcoded references were replaced by dynamic references. Also new labels were included to properly cross reference topics. Checked the spell on many rst files too. Task-number: PYSIDE-363 Change-Id: I11a50b1f9eee48a00a3de6f957942eb0823eba47 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'sources/shiboken2/ApiExtractor/doc')
-rw-r--r--sources/shiboken2/ApiExtractor/doc/typesystem_arguments.rst20
1 files changed, 17 insertions, 3 deletions
diff --git a/sources/shiboken2/ApiExtractor/doc/typesystem_arguments.rst b/sources/shiboken2/ApiExtractor/doc/typesystem_arguments.rst
index 16e0678d3..28a5c80bc 100644
--- a/sources/shiboken2/ApiExtractor/doc/typesystem_arguments.rst
+++ b/sources/shiboken2/ApiExtractor/doc/typesystem_arguments.rst
@@ -3,17 +3,18 @@
Modifying Arguments
-------------------
-.. _conversion-rule:
+.. _conversionrule:
conversion-rule
^^^^^^^^^^^^^^^
The conversion-rule node allows you to write customized code to convert
- the given argument between the target language and C++, and it is a child of the modify-argument node.
+ the given argument between the target language and C++, and it is a child of the modify-argument node:
.. code-block:: xml
- <modify-argument ...>
+ <modify-argument index="2">
+ <!-- for the second argument of the function -->
<conversion-rule class="target | native">
// the code
</conversion-rule>
@@ -36,6 +37,8 @@ conversion-rule
.. note:: You can also use the conversion-rule node to specify :ref:`a conversion code which will be used instead of the generator's conversion code everywhere for a given type <conversion-rule-on-types>`.
+.. _remove-argument:
+
remove-argument
^^^^^^^^^^^^^^^
@@ -48,6 +51,8 @@ remove-argument
<remove-argument />
</modify-argument>
+.. _rename-to:
+
rename to
^^^^^^^^^
@@ -59,6 +64,7 @@ rename to
<rename to='...' />
</modify-argument>
+.. _remove-default-expression:
remove-default-expression
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -72,6 +78,8 @@ remove-default-expression
<remove-default-expression />
</modify-argument>
+.. _replace-default-expression:
+
replace-default-expression
^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -85,6 +93,7 @@ replace-default-expression
<replace-default-expression with="..." />
</modify-argument>
+.. _replace-type:
replace-type
^^^^^^^^^^^^
@@ -103,6 +112,8 @@ replace-type
the fully qualified name (including name of the package as well as the class
name).
+.. _define-ownership:
+
define-ownership
^^^^^^^^^^^^^^^^
@@ -126,6 +137,7 @@ define-ownership
owner="target | c++ | default" />
</modify-argument>
+.. _reference-count:
reference-count
^^^^^^^^^^^^^^^
@@ -161,6 +173,7 @@ reference-count
The variable-name attribute specifies the name used for the variable that
holds the reference(s).
+.. _replace-value:
replace-value
^^^^^^^^^^^^^
@@ -173,6 +186,7 @@ replace-value
<modify-argument index="0" replace-value="this"/>
+.. _parent:
parent
^^^^^^