diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-09-09 14:56:48 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2018-09-14 10:23:29 +0000 |
commit | 940c06a4645cca190055a3987db8147b4e2de02c (patch) | |
tree | 0fb5e97b5cf24b42cf4d7b5740975b4dc5015a12 /src/quick/doc/src | |
parent | d7365a653fffe0a8b05f2f56715de01681e5203a (diff) |
Doc: Use a macro to resolve the QML import version
QDoc now supports macros for its command parameters, as well as passing
parameters to \code and \qml commands. Use these together with the
new \QtMinorVersion macro to automate bumping the QML import versions
within documentation.
Task-number: QTBUG-67818
Change-Id: I8b5300749880421a0d7cdacc1b2c0f96b3b7ef67
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Diffstat (limited to 'src/quick/doc/src')
-rw-r--r-- | src/quick/doc/src/concepts/effects/particles.qdoc | 18 | ||||
-rw-r--r-- | src/quick/doc/src/concepts/layouts/qtquicklayouts.qdoc | 8 | ||||
-rw-r--r-- | src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc | 12 | ||||
-rw-r--r-- | src/quick/doc/src/qmltypereference.qdoc | 19 |
4 files changed, 30 insertions, 27 deletions
diff --git a/src/quick/doc/src/concepts/effects/particles.qdoc b/src/quick/doc/src/concepts/effects/particles.qdoc index 452130a05b..0b87eb4529 100644 --- a/src/quick/doc/src/concepts/effects/particles.qdoc +++ b/src/quick/doc/src/concepts/effects/particles.qdoc @@ -26,15 +26,16 @@ ****************************************************************************/ /*! - \qmlmodule QtQuick.Particles 2.12 + \qmlmodule QtQuick.Particles 2.\QtMinorVersion \title Qt Quick Particles QML Types \ingroup qmlmodules \brief Provides QML types for particle effects This QML module contains a particle system for Qt Quick. To use these types, import the module with the following line: - \code - import QtQuick.Particles 2.12 - \endcode + + \qml \QtMinorVersion + import QtQuick.Particles 2.\1 + \endqml For a simple overview of how the system can be used, see \l{Using the Qt Quick Particle System}. @@ -48,10 +49,11 @@ Documentation for all Particle System types can be found on the \l QtQuick.Particles module page. - Note that to use types from the particles module, you will need to import the types with the following line: - \code - import QtQuick.Particles 2.12 - \endcode + To use the types from the particles module, import the module with the following line: + + \qml \QtMinorVersion + import QtQuick.Particles 2.\1 + \endqml \section1 The ParticleSystem This particle system contains four main types of QML types: ParticleSystem, Painters, Emitters and Affectors. diff --git a/src/quick/doc/src/concepts/layouts/qtquicklayouts.qdoc b/src/quick/doc/src/concepts/layouts/qtquicklayouts.qdoc index d82e35fb93..c33fc0cfa3 100644 --- a/src/quick/doc/src/concepts/layouts/qtquicklayouts.qdoc +++ b/src/quick/doc/src/concepts/layouts/qtquicklayouts.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \qmlmodule QtQuick.Layouts 1.11 + \qmlmodule QtQuick.Layouts 1.\QtMinorVersion \title Qt Quick Layouts QML Types \ingroup qmlmodules \brief Provides QML types for arranging QML items in a user interface. @@ -39,8 +39,8 @@ The QML types can be imported into your application using the following import statement in your .qml file. - \code - import QtQuick.Layouts 1.11 - \endcode + \qml \QtMinorVersion + import QtQuick.Layouts 1.\1 + \endqml */ diff --git a/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc b/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc index bac6ac8a52..f5599e404a 100644 --- a/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc +++ b/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc @@ -197,9 +197,9 @@ so. To explain why, let's take a look at a simplified example. Suppose we were writing the UI for a settings page: -\qml - import QtQuick 2.12 - import QtQuick.Controls 2.12 +\qml \QtMinorVersion + import QtQuick 2.\1 + import QtQuick.Controls 2.\1 Page { Button { @@ -296,9 +296,9 @@ into QML: The QML then calls the C++ slot directly: -\qml - import QtQuick 2.12 - import QtQuick.Controls 2.12 +\qml \QtMinorVersion + import QtQuick 2.\1 + import QtQuick.Controls 2.\1 Page { Button { diff --git a/src/quick/doc/src/qmltypereference.qdoc b/src/quick/doc/src/qmltypereference.qdoc index 1a743b23e6..ddf90f88d9 100644 --- a/src/quick/doc/src/qmltypereference.qdoc +++ b/src/quick/doc/src/qmltypereference.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! -\qmlmodule QtQuick 2.12 +\qmlmodule QtQuick 2.\QtMinorVersion \title Qt Quick QML Types \ingroup qmlmodules \brief Provides graphical QML types. @@ -34,11 +34,11 @@ The \l{Qt Quick} module provides graphical primitive types. These types are only available in a QML document if that document imports the \c QtQuick namespace. -The current version of the \c QtQuick module is version 2.12, and thus it may be -imported via the following statement: +The current version of the \c QtQuick module is version \QtMinorVersion, and +thus it may be imported via the following statement: -\qml -import QtQuick 2.12 +\qml \QtMinorVersion +import QtQuick 2.\1 \endqml Visit the \l {Qt Quick} module documentation for more @@ -889,15 +889,16 @@ console.log(c + " " + d); // false true */ /*! -\qmlmodule QtTest 1.11 +\qmlmodule QtTest 1.\QtMinorVersion \title Qt Quick Test QML Types \brief This module provides QML types to unit test your QML application \ingroup qmlmodules You can import this module using the following statement: -\code -import QtTest 1.11 -\endcode + +\qml \QtMinorVersion +import QtTest 1.\1 +\endqml For more information about how to use these types, see \l{Qt Quick Test}. |