diff options
author | Kai Köhne <kai.koehne@qt.io> | 2023-12-06 15:56:40 +0100 |
---|---|---|
committer | Kai Köhne <kai.koehne@qt.io> | 2023-12-08 19:11:27 +0000 |
commit | 4660f04c1824f3bd71de59bf7dce8981c99ee1ab (patch) | |
tree | 2f13a837aa0d263f7f1ba9315f8ee7b20a82eeb2 /src/qml/doc | |
parent | c89c14423bb5b6425764291f4900803690419899 (diff) |
Doc: Fix description on how to load the extending-qml sources
The tutorial is not a qdoc 'example' anymore , and therefore also
do not show up in the Qt Creator welcome screen.
While at it, also remove the version from the QML import snippet.
Task-number: QTBUG-119663
Pick-to: 6.6
Change-Id: Ib32b6fc9a4c80001f6ab30d8f38bce129e5209a0
Reviewed-by: Olivier De Cannière <olivier.decanniere@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Diffstat (limited to 'src/qml/doc')
-rw-r--r-- | src/qml/doc/src/cppintegration/extending-tutorial.qdoc | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc index 588c12a885..2dc6d0eccc 100644 --- a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc +++ b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc @@ -20,18 +20,19 @@ particular, you may be interested in the sub-topics \l{qtqml-cppintegration-exposecppattributes.html}{Exposing Attributes of C++ Classes to QML} and \l {qtqml-cppintegration-definetypes.html}{Defining QML Types from C++}. -\section1 Running the Tutorial Examples +\section1 Opening the Tutorial Sources -The code in this tutorial is available as an example project with subprojects -associated with each tutorial chapter. In \l{Qt Creator Manual}{Qt Creator}, open -the \uicontrol Welcome mode and select the tutorial from \uicontrol Examples. In -\uicontrol Edit mode, expand the \e extending-qml project, right-click on the -subproject (chapter) you want to run and select \uicontrol Run. +The code in this tutorial is available as part of the Qt sources. +If you installed Qt with the \QOI, you can +find the sources in the Qt installation directory under +Examples/Qt-\QtVersion/qml/tutorials/extending-qml/. -\section1 Creating Tutorial Project +\section1 Creating Project from Scratch -We create a new project using the \e {Qt Quick Application} template in Qt Creator, -as instructed in \l {Qt Creator: Creating Qt Quick Projects}. +Alternatively, you can follow the tutorial by creating the sources from scratch: +For each chapter, create a new project using the \e {Qt Quick Application} template +in Qt Creator, as instructed in \l {Qt Creator: Creating Qt Quick Projects}. +Then follow along by adapting and extending the generated skeleton code. \section1 Chapter 1: Creating a New Type \c extending-qml/chapter1-basics @@ -54,7 +55,7 @@ a version of 1.0. We want this \c PieChart type to be usable from QML like this: \qml - import Charts 1.0 + import Charts PieChart { width: 100; height: 100 |