aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken2/ApiExtractor
diff options
context:
space:
mode:
authorCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2018-04-10 11:31:44 +0200
committerCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2018-05-04 08:53:25 +0000
commit36d2564f3a7e5fe2cd5bf77bec36e31669c772c1 (patch)
tree3e439af25cedf67b0919469adcee94b51aa40f11 /sources/shiboken2/ApiExtractor
parent8f6611ca89adf2a4c8a84049a7b5b8ba405236ba (diff)
Update ApiExtractor documentation
Changed a few old references and links. Ran aspell on the rst files. Task-number: PYSIDE-622 Change-Id: I3e096df96bfe80ead53afa8568b7de42e8a25766 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/shiboken2/ApiExtractor')
-rw-r--r--sources/shiboken2/ApiExtractor/doc/_templates/layout.html6
-rw-r--r--sources/shiboken2/ApiExtractor/doc/overview.rst2
-rw-r--r--sources/shiboken2/ApiExtractor/doc/ownership.rst6
-rw-r--r--sources/shiboken2/ApiExtractor/doc/typesystem.rst4
-rw-r--r--sources/shiboken2/ApiExtractor/doc/typesystem_manipulating_objects.rst4
-rw-r--r--sources/shiboken2/ApiExtractor/doc/typesystem_solving_compilation.rst2
6 files changed, 11 insertions, 13 deletions
diff --git a/sources/shiboken2/ApiExtractor/doc/_templates/layout.html b/sources/shiboken2/ApiExtractor/doc/_templates/layout.html
index 9dc53722d..d99d3f0cf 100644
--- a/sources/shiboken2/ApiExtractor/doc/_templates/layout.html
+++ b/sources/shiboken2/ApiExtractor/doc/_templates/layout.html
@@ -8,7 +8,7 @@
<div id="container">
<div class="header">
<div class="header_container">
- <div class="logo"><a href="http://www.pyside.org"><img alt="PySide" src="{{ pathto('_static/pysidelogo.png', 1) }}" width="199" height="102" /></a></div>
+ <div class="logo"><a href="http://www.pyside.org"><img alt="Qt for Python (PySide2)" src="{{ pathto('_static/pysidelogo.png', 1) }}" width="199" height="102" /></a></div>
<div class="related">
<ul>
{%- block rootrellink %}
@@ -26,9 +26,7 @@
{%- block footer %}
<div class="footer">
- <a href="http://www.indt.org.br"><img src="{{ pathto('_static/logo_indt.jpg', 1) }}" alt="Indt" border="0" /></a>
- <a href="http://www.openbossa.org"><img src="{{ pathto('_static/logo_openbossa.png', 1) }}" alt="Openbossa" border="0" /></a>
- <a href="http://qt.nokia.com/"><img src="{{ pathto('_static/logo_qt.png', 1) }}" alt="Qt" border="0" /></a>
+ <a href="https://qt.io/"><img src="{{ pathto('_static/logo_qt.png', 1) }}" alt="Qt" border="0" /></a>
<a href="http://www.python.org"><img src="{{ pathto('_static/logo_python.jpg', 1) }}" alt="Python" border="0" /></a>
</div>
</div>
diff --git a/sources/shiboken2/ApiExtractor/doc/overview.rst b/sources/shiboken2/ApiExtractor/doc/overview.rst
index 471e2439b..89c0d2c00 100644
--- a/sources/shiboken2/ApiExtractor/doc/overview.rst
+++ b/sources/shiboken2/ApiExtractor/doc/overview.rst
@@ -12,4 +12,4 @@ bindings is performed by specific generators using the API Extractor library.
The API Extractor is based on QtScriptGenerator_ codebase.
-.. _QtScriptGenerator: http://labs.trolltech.com/page/Projects/QtScript/Generator
+.. _QtScriptGenerator: http://code.qt.io/cgit/qt-labs/qtscriptgenerator.git/
diff --git a/sources/shiboken2/ApiExtractor/doc/ownership.rst b/sources/shiboken2/ApiExtractor/doc/ownership.rst
index 760967da6..4e28f1427 100644
--- a/sources/shiboken2/ApiExtractor/doc/ownership.rst
+++ b/sources/shiboken2/ApiExtractor/doc/ownership.rst
@@ -14,7 +14,7 @@ Ownership transfers
From C++ to target
^^^^^^^^^^^^^^^^^^
- When an object that is currently owned by C++ has its ownership transfered
+ When an object currently owned by C++ has its ownership transferred
back to the target language, the binding can know for sure when the object will be deleted and
tie the C++ instance existence to the wrapper, calling the C++ destructor normally when the
wrapper is deleted.
@@ -29,7 +29,7 @@ From C++ to target
From target to C++
^^^^^^^^^^^^^^^^^^
- In the opposite direction,when an object ownership is transfered from the target language
+ In the opposite direction, when an object ownership is transferred from the target language
to C++, the native code takes full control of the object life and you don't
know when that object will be deleted, rendering the wrapper object invalid,
unless you're wrapping an object with a virtual destructor,
@@ -82,4 +82,4 @@ call returned. In this case, you should use the ``invalidate-after-use`` attribu
In this example the second argument will be invalidated after this method call.
-.. [#] See *Object Trees and Object Ownership* http://doc.trolltech.com/4.5/objecttrees.html
+.. [#] See *Object Trees and Object Ownership* http://doc.qt.io/qt-5/objecttrees.html
diff --git a/sources/shiboken2/ApiExtractor/doc/typesystem.rst b/sources/shiboken2/ApiExtractor/doc/typesystem.rst
index 69dda43a0..b56d21164 100644
--- a/sources/shiboken2/ApiExtractor/doc/typesystem.rst
+++ b/sources/shiboken2/ApiExtractor/doc/typesystem.rst
@@ -12,8 +12,8 @@ It is even possible to use the typesystem specification to inject arbitrary
code into the source files, such as an extra member function.
Below there is a complete reference guide to the various nodes (XML tags) of the typesystem.
-For usage examples, take a look at the typesystem files used to generate PySide. These files
-can be found in the PySide/<QT_MODULE_NAME> directory of the PySide package.
+For usage examples, take a look at the typesystem files used to generate PySide2. These files
+can be found in the PySide2/<QT_MODULE_NAME> directory of the PySide2 package.
.. toctree::
diff --git a/sources/shiboken2/ApiExtractor/doc/typesystem_manipulating_objects.rst b/sources/shiboken2/ApiExtractor/doc/typesystem_manipulating_objects.rst
index 2838c95e1..ff6ea5317 100644
--- a/sources/shiboken2/ApiExtractor/doc/typesystem_manipulating_objects.rst
+++ b/sources/shiboken2/ApiExtractor/doc/typesystem_manipulating_objects.rst
@@ -92,8 +92,8 @@ add-function
The add-function node allows you to add a given function onto the target language,
and it is a child of an :ref:`object-type` or :ref:`value-type` nodes if the
- function is suposed to be a method, or :ref:`namespace` and :ref:`typesystem` if
- the function is suposed to be a function inside a namespace or a global function.
+ 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.
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.
diff --git a/sources/shiboken2/ApiExtractor/doc/typesystem_solving_compilation.rst b/sources/shiboken2/ApiExtractor/doc/typesystem_solving_compilation.rst
index 81d14a187..23ab9012d 100644
--- a/sources/shiboken2/ApiExtractor/doc/typesystem_solving_compilation.rst
+++ b/sources/shiboken2/ApiExtractor/doc/typesystem_solving_compilation.rst
@@ -28,7 +28,7 @@ extra-includes
The generator automatically tries to read the global header for each type but
sometimes it is required to include extra files in the generated C++ code to
make sure that the code compiles. These files must be listed using include
- nodes witin the extra-include node:
+ nodes within the extra-include node:
.. code-block:: xml