diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-09-09 16:06:30 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2018-09-26 10:51:45 +0000 |
commit | f6302903649315325965820c0ca9a32e87aaa49f (patch) | |
tree | 41e612a5f20a153177c645fb87d54a00c283c58c | |
parent | 9a0cbcc53c16e36ac161b04fdd1fe3d843951ed9 (diff) |
Doc: Use a macro to resolve QML import versions
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: Ia09a5cc06bd6e7ccd41305cecbdac90318402d00
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
-rw-r--r-- | src/core/doc/src/qt3dcore-module.qdoc | 8 | ||||
-rw-r--r-- | src/doc/src/qt3danimation-module.qdoc | 8 | ||||
-rw-r--r-- | src/doc/src/qt3dextras-module.qdoc | 8 | ||||
-rw-r--r-- | src/doc/src/qt3dinput-module.qdoc | 8 | ||||
-rw-r--r-- | src/doc/src/qt3dlogic-module.qdoc | 8 | ||||
-rw-r--r-- | src/doc/src/qt3drender-module.qdoc | 8 | ||||
-rw-r--r-- | src/doc/src/qt3dscene2d-module.qdoc | 8 | ||||
-rw-r--r-- | src/doc/src/qt3dscene3d-module.qdoc | 8 |
8 files changed, 32 insertions, 32 deletions
diff --git a/src/core/doc/src/qt3dcore-module.qdoc b/src/core/doc/src/qt3dcore-module.qdoc index 208df1c86..8f67bae41 100644 --- a/src/core/doc/src/qt3dcore-module.qdoc +++ b/src/core/doc/src/qt3dcore-module.qdoc @@ -51,7 +51,7 @@ */ /*! - \qmlmodule Qt3D.Core 2.0 + \qmlmodule Qt3D.Core 2.\QtMinorVersion \title Qt 3D Core QML Types \ingroup qmlmodules \ingroup qt3d-qmlmodules @@ -61,9 +61,9 @@ To import and use the module's QML types, use the following statement: - \badcode - import Qt3D.Core 2.0 - \endcode + \qml \QtMinorVersion + import Qt3D.Core 2.\1 + \endqml See \l {Qt 3D QML Types} for a list of all QML types in Qt 3D. diff --git a/src/doc/src/qt3danimation-module.qdoc b/src/doc/src/qt3danimation-module.qdoc index 631e449e2..9cf32b4c8 100644 --- a/src/doc/src/qt3danimation-module.qdoc +++ b/src/doc/src/qt3danimation-module.qdoc @@ -215,7 +215,7 @@ */ /*! - \qmlmodule Qt3D.Animation 2.9 + \qmlmodule Qt3D.Animation 2.\QtMinorVersion \title Qt 3D Qt3DAnimation QML Types \preliminary @@ -226,7 +226,7 @@ To import and use the module's QML types, use the following statement: - \badcode - import Qt3D.Animation 2.9 - \endcode + \qml \QtMinorVersion + import Qt3D.Animation 2.\1 + \endqml */ diff --git a/src/doc/src/qt3dextras-module.qdoc b/src/doc/src/qt3dextras-module.qdoc index 390a2a564..8f08b60e5 100644 --- a/src/doc/src/qt3dextras-module.qdoc +++ b/src/doc/src/qt3dextras-module.qdoc @@ -103,7 +103,7 @@ */ /*! - \qmlmodule Qt3D.Extras 2.0 + \qmlmodule Qt3D.Extras 2.\QtMinorVersion \title Qt 3D Extras QML Types \preliminary @@ -114,7 +114,7 @@ To import and use the module's QML types, use the following statement: - \badcode - import Qt3D.Extras 2.0 - \endcode + \qml \QtMinorVersion + import Qt3D.Extras 2.\1 + \endqml */ diff --git a/src/doc/src/qt3dinput-module.qdoc b/src/doc/src/qt3dinput-module.qdoc index 0fbe0aef1..9ae8accac 100644 --- a/src/doc/src/qt3dinput-module.qdoc +++ b/src/doc/src/qt3dinput-module.qdoc @@ -58,7 +58,7 @@ */ /*! - \qmlmodule Qt3D.Input 2.0 + \qmlmodule Qt3D.Input 2.\QtMinorVersion \title Qt 3D Input QML Types \since 5.7 @@ -69,9 +69,9 @@ To import and use the module's QML types, use the following statement: - \badcode - import Qt3D.Input 2.0 - \endcode + \qml \QtMinorVersion + import Qt3D.Input 2.\1 + \endqml \section1 QML Types */ diff --git a/src/doc/src/qt3dlogic-module.qdoc b/src/doc/src/qt3dlogic-module.qdoc index 8994b8bcd..5823c5cc7 100644 --- a/src/doc/src/qt3dlogic-module.qdoc +++ b/src/doc/src/qt3dlogic-module.qdoc @@ -60,7 +60,7 @@ */ /*! - \qmlmodule Qt3D.Logic 2.0 + \qmlmodule Qt3D.Logic 2.\QtMinorVersion \title Qt 3D Logic QML Types \since 5.7 @@ -71,9 +71,9 @@ To import and use the module's QML types, use the following statement: - \badcode - import Qt3D.Logic 2.0 - \endcode + \qml \QtMinorVersion + import Qt3D.Logic 2.\1 + \endqml \section1 QML Types */ diff --git a/src/doc/src/qt3drender-module.qdoc b/src/doc/src/qt3drender-module.qdoc index c42e2b7c7..834ea45fd 100644 --- a/src/doc/src/qt3drender-module.qdoc +++ b/src/doc/src/qt3drender-module.qdoc @@ -74,7 +74,7 @@ */ /*! - \qmlmodule Qt3D.Render 2.0 + \qmlmodule Qt3D.Render 2.\QtMinorVersion \title Qt 3D Render QML Types \since 5.7 @@ -85,7 +85,7 @@ To import and use the module's QML types, use the following statement: - \badcode - import Qt3D.Render 2.0 - \endcode + \qml \QtMinorVersion + import Qt3D.Render 2.\1 + \endqml */ diff --git a/src/doc/src/qt3dscene2d-module.qdoc b/src/doc/src/qt3dscene2d-module.qdoc index c9022245a..39ca8a44f 100644 --- a/src/doc/src/qt3dscene2d-module.qdoc +++ b/src/doc/src/qt3dscene2d-module.qdoc @@ -69,7 +69,7 @@ */ /*! - \qmlmodule QtQuick.Scene2D 2.11 + \qmlmodule QtQuick.Scene2D 2.\QtMinorVersion \preliminary \title Qt 3D Scene2D QML Types \ingroup qmlmodules @@ -79,7 +79,7 @@ To import and use the module's QML types, use the following statement: - \badcode - import QtQuick.Scene2D 2.11 - \endcode + \qml \QtMinorVersion + import QtQuick.Scene2D 2.\1 + \endqml */ diff --git a/src/doc/src/qt3dscene3d-module.qdoc b/src/doc/src/qt3dscene3d-module.qdoc index aa6939ef9..27bdd81aa 100644 --- a/src/doc/src/qt3dscene3d-module.qdoc +++ b/src/doc/src/qt3dscene3d-module.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \qmlmodule QtQuick.Scene3D 2.0 + \qmlmodule QtQuick.Scene3D 2.\QtMinorVersion \preliminary \title Qt 3D Scene3D QML Types \ingroup qmlmodules @@ -36,7 +36,7 @@ To import and use the module's QML types, use the following statement: - \badcode - import QtQuick.Scene3D 2.0 - \endcode + \qml \QtMinorVersion + import QtQuick.Scene3D 2.\1 + \endqml */ |