aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@qt.io>2020-11-23 22:48:23 +0100
committerJerome Pasion <jerome.pasion@qt.io>2020-11-26 17:50:40 +0100
commit198db199e5e9f7f6bf8c2a8fdd870d46c5615256 (patch)
tree52e80fba8d7ccdc4d7c08d5c21393171c3d52a96 /src
parent4fac3dd5b5241a244148e7c567869f45e371e2d4 (diff)
Doc: Remove version numbers for import statement in snippets
-recommend using the import statement without versions for Qt 6.0 -update use of \qml snippet without \QtMinorVersion Task-number: QTBUG-87155 Pick-to: 6.0 6.0.0 Change-Id: I338d4fb81b9709f2f342f250c07ddf66f116b1dd Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/imports/controls/doc/src/includes/customize-button-background.qdocinc6
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc26
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-fileselectors.qdoc22
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-gettingstarted.qdoc6
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-index.qdoc4
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc4
-rw-r--r--src/imports/platform/doc/src/qtlabsplatform-qmltypes.qdoc2
-rw-r--r--src/imports/templates/doc/src/qtquicktemplates2-qmltypes.qdoc4
-rw-r--r--src/quicktemplates2/qquickdrawer.cpp18
-rw-r--r--src/quicktemplates2/qquicksplitview.cpp12
10 files changed, 52 insertions, 52 deletions
diff --git a/src/imports/controls/doc/src/includes/customize-button-background.qdocinc b/src/imports/controls/doc/src/includes/customize-button-background.qdocinc
index 59df7d8e..0acad02d 100644
--- a/src/imports/controls/doc/src/includes/customize-button-background.qdocinc
+++ b/src/imports/controls/doc/src/includes/customize-button-background.qdocinc
@@ -1,7 +1,7 @@
//! [file]
-\qml \QtMinorVersion
-import QtQuick 2.\1
-import QtQuick.Controls 2.\1
+\qml
+import QtQuick
+import QtQuick.Controls
ApplicationWindow {
width: 400
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc
index 321588b4..ba62425f 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc
@@ -70,8 +70,8 @@
module itself, we'll call the file \c MyButton.qml. To use the control in
your application, refer to it by its filename:
- \qml \QtMinorVersion
- import QtQuick.Controls 2.\1
+ \qml
+ import QtQuick.Controls
ApplicationWindow {
MyButton {
@@ -86,8 +86,8 @@
subfolder in your project named (for example) \c controls. To use the
control, first import the folder into a namespace:
- \qml \QtMinorVersion
- import QtQuick.Controls 2.\1
+ \qml
+ import QtQuick.Controls
import "controls" as MyControls
ApplicationWindow {
@@ -432,10 +432,10 @@
Next, we add a drop shadow to the \l {Control::}{background} delegate of
the Button:
- \code \QtMinorVersion
+ \code
// ...
- import QtGraphicalEffects 1.\1
- import MyStyle 1.0
+ import QtGraphicalEffects
+ import MyStyle
// ...
background: Rectangle {
@@ -463,9 +463,9 @@
To try out the attached property, we create a \l Row with two Buttons in
\c main.qml:
- \qml \QtMinorVersion
- import QtQuick 2.\1
- import QtQuick.Controls 2.\1
+ \qml
+ import QtQuick
+ import QtQuick.Controls
import MyStyle 1.0
@@ -518,9 +518,9 @@
ApplicationWindow consists of one visual item:
\l {ApplicationWindow::background}{background}.
- \code \QtMinorVersion
- import QtQuick 2.\1
- import QtQuick.Controls 2.\1
+ \code
+ import
+ import QtQuick.Controls
ApplicationWindow {
visible: true
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-fileselectors.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-fileselectors.qdoc
index 57efd67b..4c782de1 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-fileselectors.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-fileselectors.qdoc
@@ -58,10 +58,10 @@
\c Material selector will be present and the \c +Material/CustomButton.qml
version will be used instead.
- \code \QtMinorVersion
+ \code
// main.qml
- import QtQuick 2.\1
- import QtQuick.Controls 2.\1
+ import QtQuick
+ import QtQuick.Controls
ApplicationWindow {
id: window
@@ -77,10 +77,10 @@
The base implementation of the custom button is a simple rounded
flat button.
- \code \QtMinorVersion
+ \code
// CustomButton.qml
- import QtQuick 2.\1
- import QtQuick.Controls 2.\1
+ import QtQuick
+ import QtQuick.Controls
Button {
id: control
@@ -98,12 +98,12 @@
Material style, requests a dark theme to get light text, and creates
a drop shadow for the background.
- \code \QtMinorVersion
+ \code
// +Material/CustomButton.qml
- import QtQuick 2.\1
- import QtGraphicalEffects 1.\1
- import QtQuick.Controls 2.\1
- import QtQuick.Controls.Material 2.\1
+ import QtQuick
+ import QtGraphicalEffects
+ import QtQuick.Controls
+ import QtQuick.Controls.Material
Button {
id: control
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-gettingstarted.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-gettingstarted.qdoc
index 377b55ed..09209d21 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-gettingstarted.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-gettingstarted.qdoc
@@ -32,9 +32,9 @@
A basic example of a QML file that makes use of controls is shown here:
- \qml \QtMinorVersion
- import QtQuick 2.\1
- import QtQuick.Controls 2.\1
+ \qml
+ import QtQuick
+ import QtQuick.Controls
ApplicationWindow {
title: "My Application"
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
index 964af4ea..c5be4285 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
@@ -49,8 +49,8 @@
The \l{Qt Quick Controls QML Types}{QML types} can be imported into your
application using the following import statement in your \c {.qml} file:
- \qml \QtMinorVersion
- import QtQuick.Controls 2.\1
+ \qml
+ import QtQuick.Controls
\endqml
\section2 C++ API
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc
index 211abedc..0251a6f9 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc
@@ -40,8 +40,8 @@
Qt Quick Controls QML types can be imported into your application
using the following import statement in your .qml file:
- \qml \QtMinorVersion
- import QtQuick.Controls 2.\1
+ \qml
+ import QtQuick.Controls
\endqml
\section1 QML Types
diff --git a/src/imports/platform/doc/src/qtlabsplatform-qmltypes.qdoc b/src/imports/platform/doc/src/qtlabsplatform-qmltypes.qdoc
index f1a4daf3..51b7601a 100644
--- a/src/imports/platform/doc/src/qtlabsplatform-qmltypes.qdoc
+++ b/src/imports/platform/doc/src/qtlabsplatform-qmltypes.qdoc
@@ -39,7 +39,7 @@
following import statement in your .qml file:
\qml
- import Qt.labs.platform 1.1
+ import Qt.labs.platform
\endqml
\section1 QML Types
diff --git a/src/imports/templates/doc/src/qtquicktemplates2-qmltypes.qdoc b/src/imports/templates/doc/src/qtquicktemplates2-qmltypes.qdoc
index 127d14e8..396dbdc5 100644
--- a/src/imports/templates/doc/src/qtquicktemplates2-qmltypes.qdoc
+++ b/src/imports/templates/doc/src/qtquicktemplates2-qmltypes.qdoc
@@ -37,8 +37,8 @@
The QML types can be imported using the following import statement in your
\c .qml file:
- \qml \QtMinorVersion
- import QtQuick.Templates 2.\1 as T
+ \qml
+ import QtQuick.Templates as T
\endqml
For the sake of clarity, there is a one-to-one mapping between the types
diff --git a/src/quicktemplates2/qquickdrawer.cpp b/src/quicktemplates2/qquickdrawer.cpp
index e5839906..7de548e6 100644
--- a/src/quicktemplates2/qquickdrawer.cpp
+++ b/src/quicktemplates2/qquickdrawer.cpp
@@ -68,9 +68,9 @@ QT_BEGIN_NAMESPACE
drawer is then opened by \e "dragging" it out from the left edge of the
window.
- \code \QtMinorVersion
- import QtQuick 2.\1
- import QtQuick.Controls 2.\1
+ \code
+ import QtQuick
+ import QtQuick.Controls
ApplicationWindow {
id: window
@@ -97,9 +97,9 @@ QT_BEGIN_NAMESPACE
Drawer can be configured to cover only part of its window edge. The following example
illustrates how Drawer can be positioned to appear below a window header:
- \code \QtMinorVersion
- import QtQuick 2.\1
- import QtQuick.Controls 2.\1
+ \code
+ import QtQuick
+ import QtQuick.Controls
ApplicationWindow {
id: window
@@ -123,9 +123,9 @@ QT_BEGIN_NAMESPACE
In the image above, the application's contents are \e "pushed" across the
screen. This is achieved by applying a translation to the contents:
- \code \QtMinorVersion
- import QtQuick 2.\1
- import QtQuick.Controls 2.\1
+ \code
+ import QtQuick
+ import QtQuick.Controls
ApplicationWindow {
id: window
diff --git a/src/quicktemplates2/qquicksplitview.cpp b/src/quicktemplates2/qquicksplitview.cpp
index 9c3da3f0..a9c92eaf 100644
--- a/src/quicktemplates2/qquicksplitview.cpp
+++ b/src/quicktemplates2/qquicksplitview.cpp
@@ -205,9 +205,9 @@ QT_BEGIN_NAMESPACE
SplitView.preferredWidth and \c SplitView.preferredHeight properties can be
serialized using the \l saveState() and \l restoreState() functions:
- \qml \QtMinorVersion
- import QtQuick.Controls 2.\1
- import Qt.labs.settings 1.0
+ \qml
+ import QtQuick.Controls
+ import Qt.labs.settings
ApplicationWindow {
// ...
@@ -230,9 +230,9 @@ QT_BEGIN_NAMESPACE
Alternatively, the \l {Settings::}{value()} and \l {Settings::}{setValue()}
functions of \l Settings can be used:
- \qml \QtMinorVersion
- import QtQuick.Controls 2.\1
- import Qt.labs.settings 1.0
+ \qml
+ import QtQuick.Controls
+ import Qt.labs.settings
ApplicationWindow {
// ...