Doc: Fix broken links when building with Qt 6

Some section titles have changed in Qt 6 and some
platforms and modules are not supported. Where necessary,
use fixed links to Qt 5 docs.

Fixes: QTCREATORBUG-27015
Change-Id: I469a630731f9c37deffe5ca454f5365310aaf713
Reviewed-by: Tommi Mänttäri <tommi.manttari@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
Leena Miettinen
2022-02-18 16:48:33 +01:00
parent 741a2de6b9
commit 659d82c499
12 changed files with 34 additions and 65 deletions

View File

@@ -69,8 +69,8 @@
in the module directory. For more information, see
\l {Module Definition qmldir Files}.
\li Create a \c qmltypes file, preferably using \c qmlplugindump.
For more information see, \l {Generating qmltypes Files}.
\li Create a \c qmltypes file, as instructed in
\l {Generating Type Description Files}.
\li Create a directory named \c designer in your module directory.
@@ -111,39 +111,14 @@
for QML modules with plugins before distributing them.
\endif
\section1 Generating qmltypes Files
\section1 Generating Type Description Files
Ideally, QML modules have a \c{plugins.qmltypes} file in the same directory
as the \c qmldir file. The \c qmltypes file contains a description of the
components exported by the module's plugins and is loaded by \QC when the
module is imported.
For Qt 4.8 and later, one or more \c qmltypes files can be listed in the
\c qmldir file under the \c typeinfo header. These files will be read in
addition to \c{plugins.qmltypes}. For more information, see
\l{Writing a qmltypes File}.
You can create and edit \c qmltypes files manually, but you are recommended
to use the \c qmlplugindump tool shipped with Qt 4.8 and later to generate
them automatically.
Once you have obtained \c qmlplugindump for the Qt version the QML module's
plugins were compiled with, run the following command to load My.Module
version 1.0 from \c{/import/path/my/module} including all its plugins and
output a description of the plugins' components to
\c{/import/path/my/module/plugins.qmltypes}:
\code
qmlplugindump -nonrelocatable My.Module 1.0 /import/path > /import/path/my/module/plugins.qmltypes
\endcode
You can safely ignore the debug output.
\if defined(qtcreator)
For Qt 4.7.x, you can compile a version of the tool called \c qmldump from
the sources in \c{<QtCreator>/share/qtcreator/qml/qmldump} if the Qt version
contains private headers.
\endif
For more information, see \l{Type Description Files}.
\section2 Dumping Plugins Automatically