aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc
diff options
context:
space:
mode:
authorAndreas Eliasson <andreas.eliasson@qt.io>2022-04-08 09:58:59 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-04-16 22:54:43 +0000
commitd94fd06730f306a195e24a087cf1adbff8ce08ae (patch)
tree23801630d709184a5396f4551d8debaf95f62f95 /src/qml/doc
parentfc1f595908b64702e62ec1dc5216f4ec17d0cc85 (diff)
Doc: Improve cross-linking between QML and integration articles
Also, separate articles and examples into two lists in the qml module landing page, and replace some of the links to the 'simple c++ integration example' to the more detailed 'Writing QML Extensions with C++' tutorial. Fixes: QTBUG-102116 Change-Id: Id3cc9de35c1cec6e53caa5cc1feff1f55ff4b084 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> (cherry picked from commit 0dc9cb059b66d93d6b1097bcf1a662e662586f6b) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src/qml/doc')
-rw-r--r--src/qml/doc/src/cppintegration/data.qdoc4
-rw-r--r--src/qml/doc/src/cppintegration/definetypes.qdoc4
-rw-r--r--src/qml/doc/src/cppintegration/exposecppattributes.qdoc3
-rw-r--r--src/qml/doc/src/cppintegration/extending-tutorial.qdoc8
-rw-r--r--src/qml/doc/src/cppintegration/interactqmlfromcpp.qdoc3
-rw-r--r--src/qml/doc/src/cppintegration/topic.qdoc2
-rw-r--r--src/qml/doc/src/qmllanguageref/typesystem/objecttypes.qdoc3
-rw-r--r--src/qml/doc/src/qtqml.qdoc16
8 files changed, 36 insertions, 7 deletions
diff --git a/src/qml/doc/src/cppintegration/data.qdoc b/src/qml/doc/src/cppintegration/data.qdoc
index 223ea3b636..64c2aa3465 100644
--- a/src/qml/doc/src/cppintegration/data.qdoc
+++ b/src/qml/doc/src/cppintegration/data.qdoc
@@ -38,6 +38,10 @@ The QML engine provides built-in support for a large number of Qt C++ data
types. Additionally, custom C++ types may be registered with the QML type
system to make them available to the engine.
+For more information about C++ and the different QML integration methods,
+see the
+\l {Overview - QML and C++ Integration} {C++ and QML integration overview} page.
+
This page discusses the data types supported by the QML engine and how
they are converted between QML and C++.
diff --git a/src/qml/doc/src/cppintegration/definetypes.qdoc b/src/qml/doc/src/cppintegration/definetypes.qdoc
index 2aa26de3af..5539804fe9 100644
--- a/src/qml/doc/src/cppintegration/definetypes.qdoc
+++ b/src/qml/doc/src/cppintegration/definetypes.qdoc
@@ -48,6 +48,10 @@ demonstrated in the \l{Writing QML Extensions with C++} tutorial.)
\b{NOTE:} All headers that declare QML types need to be accessible without any prefix from the project's include path.
+For more information about C++ and the different QML integration methods,
+see the
+\l {Overview - QML and C++ Integration} {C++ and QML integration overview} page.
+
\section1 Registering C++ Types with the QML Type System
A QObject-derived class can be registered with the QML type system to enable the
diff --git a/src/qml/doc/src/cppintegration/exposecppattributes.qdoc b/src/qml/doc/src/cppintegration/exposecppattributes.qdoc
index 618ed1e334..c01253f345 100644
--- a/src/qml/doc/src/cppintegration/exposecppattributes.qdoc
+++ b/src/qml/doc/src/cppintegration/exposecppattributes.qdoc
@@ -61,6 +61,9 @@ class may need to be registered.
Also note that a number of the important concepts covered in this document are
demonstrated in the \l{Writing QML Extensions with C++} tutorial.
+For more information about C++ and the different QML integration methods,
+see the
+\l {Overview - QML and C++ Integration} {C++ and QML integration overview} page.
\section1 Data Type Handling and Ownership
diff --git a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
index b5f0676920..88b180e644 100644
--- a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
+++ b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
@@ -464,9 +464,9 @@ In this tutorial, we've shown the basic steps for creating a QML extension:
\l {Module Definition qmldir Files}{qmldir} file
\endlist
-The \l{Integrating QML and C++} documentation shows
-other useful features that can be added to QML extensions. For example, we
-could use \l{Default Properties}{default properties} to allow
+The \l{Overview - QML and C++ Integration}{QML and C++ Integration overview}
+documentation shows other useful features that can be added to QML extensions.
+For example, we could use \l{Default Properties}{default properties} to allow
slices to be added without using the \c slices property:
\badcode
@@ -485,5 +485,5 @@ Or randomly add and remove slices from time to time using \l{Property Value Sour
}
\endcode
-\sa {Integrating QML and C++}
+\sa {Simple QML and C++ Integration Example}
*/
diff --git a/src/qml/doc/src/cppintegration/interactqmlfromcpp.qdoc b/src/qml/doc/src/cppintegration/interactqmlfromcpp.qdoc
index dc38a8c201..86a9f1d1f7 100644
--- a/src/qml/doc/src/cppintegration/interactqmlfromcpp.qdoc
+++ b/src/qml/doc/src/cppintegration/interactqmlfromcpp.qdoc
@@ -41,6 +41,9 @@ into a C++ application. Once a QML object is created, it can be inspected from
C++ in order to read and write to properties, invoke methods and receive signal
notifications.
+For more information about C++ and the different QML integration methods,
+see the
+\l {Overview - QML and C++ Integration} {C++ and QML integration overview} page.
\section1 Loading QML Objects from C++
diff --git a/src/qml/doc/src/cppintegration/topic.qdoc b/src/qml/doc/src/cppintegration/topic.qdoc
index 14a27c9a3f..47e8991571 100644
--- a/src/qml/doc/src/cppintegration/topic.qdoc
+++ b/src/qml/doc/src/cppintegration/topic.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
\page qtqml-cppintegration-topic.html
-\title Integrating QML and C++
+\title Simple QML and C++ Integration Example
\brief Provides instruction to integrate QML and C++
QML applications often need to handle more advanced and performance-intensive
diff --git a/src/qml/doc/src/qmllanguageref/typesystem/objecttypes.qdoc b/src/qml/doc/src/qmllanguageref/typesystem/objecttypes.qdoc
index 5f089b5ebc..28b91033cc 100644
--- a/src/qml/doc/src/qmllanguageref/typesystem/objecttypes.qdoc
+++ b/src/qml/doc/src/qmllanguageref/typesystem/objecttypes.qdoc
@@ -48,6 +48,9 @@ and registering the type with the QML engine, as discussed in
Note that in both cases, the type name must begin with an uppercase letter in
order to be declared as a QML object type in a QML file.
+For more information about C++ and the different QML integration methods,
+see the
+\l {Overview - QML and C++ Integration} {C++ and QML integration overview} page.
\section1 Defining Object Types from QML
diff --git a/src/qml/doc/src/qtqml.qdoc b/src/qml/doc/src/qtqml.qdoc
index 00a61d99f4..3ad276e953 100644
--- a/src/qml/doc/src/qtqml.qdoc
+++ b/src/qml/doc/src/qtqml.qdoc
@@ -127,10 +127,22 @@ The module also provides the framework for running QML applications.
The QML framework allows QML code to contain JavaScript expressions and for
the QML code to interact with C++ code.
+\section2 Articles and Guides
+
\list
+ \li \l {Overview - QML and C++ Integration}
+ \li \l {Data Type Conversion Between QML and C++}
+ \li \l {Exposing Attributes of C++ Types to QML}
+ \li \l {Defining QML Types from C++}
\li \l {Writing QML Modules}
\li \l {Important C++ Classes Provided By The Qt QML Module}
- \li \l {Integrating QML and C++}
+\endlist
+
+\section2 Examples
+
+\list
+ \li \l {Writing QML Extensions with C++}
+ \li \l {Simple QML and C++ Integration Example}
\endlist
\omit
@@ -140,7 +152,7 @@ the QML code to interact with C++ code.
\endlist
\endomit
-\section1 Articles and Guides
+\section1 Related Articles and Guides
Further information for writing QML applications:
\list