feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Fix broken links when building with Qt 6

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/qtcreator/config/qtcreator-project.qdocconf
View File

@@ -22,8 +22,7 @@ examples.fileextensions += *.qml *.svg
include(../../qtcreator/images/extraimages/qtcreator-extraimages.qdocconf)
depends += qtandroidextras\
qtwidgets \
depends += qtwidgets \
qtcmake \
qtcore \
qtqml \
@@ -40,7 +39,6 @@ depends += qtandroidextras\
qttestlib \
qtuitools \
qtxml \
qtlocation \
qtvirtualkeyboard
include(../../config/macros.qdocconf)

2
doc/qtcreator/src/android/androiddev.qdoc
View File

@@ -63,7 +63,7 @@
To use \QC to develop Qt applications for Android, you need
\l{Qt for Android} 5.2, or later, and the tool chain that \QC
can automatically download, install, and configure for you.
For more information, see \l{Installing the Prerequisites}.
For more information, see \l{Manually Installing the Prerequisites}.
\section1 Specifying Android Device Settings

11
doc/qtcreator/src/android/deploying-android.qdoc
View File

@@ -514,10 +514,10 @@
\li In the \uicontrol Permissions field, you can specify the permissions that your
application needs. Starting from Android 6.0 (API 23), permissions have to be
requested at runtime (see \l{QtAndroid::requestPermissionsSync()} or
\l{QtAndroid::requestPermissions()}). For lower Android API levels,
users are asked to grant the permissions when they install the application.
Android OS then grants the application access to the appropriate data and features.
requested at runtime (see \l{QtAndroidPrivate::requestPermission()}). For
lower Android API levels, users are asked to grant the permissions when they
install the application. Android OS then grants the application access to the
appropriate data and features.
\image qtcreator-android-manifest-editor-permissions.png "Permissions in Android Manifest Editor"
@@ -525,7 +525,8 @@
\uicontrol {Include default features for Qt modules} check boxes to add the
permissions needed by Qt libraries. This can be
\c {android.permission.WRITE_EXTERNAL_STORAGE} for \l{Qt Core} or
\c {android.permission.ACCESS_COARSE_LOCATION} for \l{Qt Location}.
\c {android.permission.ACCESS_COARSE_LOCATION} for
\l{https://doc.qt.io/qt-5.15/qtlocation-index.html}{Qt Location}.
\li To add a permission, select it from the list, and then click \uicontrol Add.

11
doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc
View File

@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -62,12 +62,11 @@
\section1 Boot2Qt
The Boot2Qt stack can be made to run on a variety of hardware. For
\l{https://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation}
license holders, tooling is provided to customize the contents of the stack
as well as to take it into desired production hardware.
Either Windows 7 or later or Ubuntu Linux 64-bit 12.04 LTS
or later is required to install and use Qt for Device Creation.
or later is required to install and use Boot2Qt.
The following topics contain more information about developing applications
for Boot2Qt devices:
@@ -121,11 +120,9 @@
\section1 QNX
The QNX Neutrino RTOS should provide a few additional command line tools
and services, as described in \l {Qt Creator Target Requirements}.
and services, as described in \l {Qt for QNX}.
\note In Qt 6, Qt for QNX is a part of
\l{https://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation},
and the \QC support is considered experimental.
\note In Qt 6, \QC support for QNX is considered experimental.
The following topics contain more information about developing applications
for QNX devices:

8
doc/qtcreator/src/overview/creator-only/creator-mobile-platforms.qdoc
View File

@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -92,6 +92,8 @@
therefore applications that only use the core APIs will run on any
Windows 10 device, such as a desktop PC, or Xbox One.
For more information about developing applications for UWP, see
\l{Qt for UWP}.
For more information about developing applications for UWP using Qt 5, see
\l{https://doc.qt.io/qt-5/winrt-support.html}{Qt for UWP}.
\note Developing for UWP using Qt 6 is not supported.
*/

8
doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc
View File

@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -58,9 +58,9 @@
\li \l{Connecting MCUs}{MCU Device} (commercial only)
\li \l{Connecting QNX Devices}{QNX Device}
\li \l{Building Applications for the Web}{WebAssembly Runtime}
\li \l{Qt for UWP}{Windows Phone}
\li Windows Phone Emulator
\li Windows Runtime (local)
\li \l{https://doc.qt.io/qt-5/winrt-support.html}{Windows Phone} (Qt 5)
\li Windows Phone Emulator (Qt 5)
\li Windows Runtime (local, Qt 5)
\endlist
\section1 Filtering Kit Settings

0
doc/qtcreator/src/projects/creator-qtcreator-variables.qdocinc → doc/qtcreator/src/projects/qtcreator-variables.qdocinc
View File

8
doc/qtcreator/src/qnx/creator-developing-qnx.qdoc
View File

@@ -4,7 +4,7 @@
** Contact: Blackberry (qt@blackberry.com)
** Contact: KDAB (info@kdab.com)
**
** Copyright (C) 2021 The Qt Company Ltd.
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -38,11 +38,9 @@
You can connect QNX devices to the development PC to deploy, run and debug
applications on them from within \QC. The QNX Neutrino RTOS should provide
a few additional command line tools and services, as described in
\l {Qt Creator Target Requirements}.
\l {Qt for QNX}.
\note In Qt 6, Qt for QNX is a part of
\l{https://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation},
and the \QC support is considered experimental.
\note In Qt 6, \QC support for QNX is considered experimental.
\section1 Adding a QNX Neutrino Device in \QC

6
doc/qtcreator/src/qnx/creator-projects-running-qnx.qdocinc
View File

@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -51,7 +51,7 @@
To support running, debugging, and stopping applications from \QC, the QNX
Neutrino RTOS should provide a few additional command line tools and
services, as described in \l {Qt Creator Target Requirements}.
services, as described in \l {Qt for QNX}.
\section3 Debug Output Cannot Be Shown
@@ -71,7 +71,5 @@
\c printf, \c ps, \c read, \c sed, \c sleep, \c uname, \c slog2info, and
\c cat.
For more information, see \l{Other Utilities on the Target Device}.
//! [running on qnx]
*/

2
doc/qtcreator/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc
View File

@@ -207,7 +207,7 @@
\uicontrol {Run CMake} to apply configuration changes.
For more information about the CMakeLists.txt file, see
\l{Get started with CMake}.
\l{Getting started with CMake}.
\section1 Running the Application

33
doc/qtcreator/src/qtquick/qtquick-modules-with-plugins.qdoc
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

6
doc/qtcreator/src/user-interface/creator-ui.qdoc
View File

@@ -180,9 +180,9 @@
\list
\li On \macos, high DPI scaling is forced, which means that \QC allows
Qt to use the system scaling factor as the \QC scaling factor.
\li On Windows, if no \l{High DPI Support in Qt}
{scaling environment variables} are set, \QC instructs Qt to detect
the scaling factor and use it for \QC.
\li On Windows, if no \l{High DPI}{scaling environment variables} are
set, \QC instructs Qt to detect the scaling factor and use it for
\QC.
\li On Linux, \QC leaves it to the user to enable high DPI scaling,
because the process varies so much on different distributions
and windowing systems that it cannot be reliably done automatically.