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/imports | |
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/imports')
-rw-r--r-- | src/imports/folderlistmodel/qquickfolderlistmodel.cpp | 18 | ||||
-rw-r--r-- | src/imports/localstorage/plugin.cpp | 18 | ||||
-rw-r--r-- | src/imports/models/plugin.cpp | 8 | ||||
-rw-r--r-- | src/imports/window/plugin.cpp | 8 | ||||
-rw-r--r-- | src/imports/xmllistmodel/qqmlxmllistmodel.cpp | 8 |
5 files changed, 32 insertions, 28 deletions
diff --git a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp index f5f38adb18..66d9e7ae46 100644 --- a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp +++ b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp @@ -224,16 +224,16 @@ QString QQuickFolderListModelPrivate::resolvePath(const QUrl &path) } /*! - \qmlmodule Qt.labs.folderlistmodel 2.12 + \qmlmodule Qt.labs.folderlistmodel 2.\QtMinorVersion \title Qt Labs FolderListModel QML Types \ingroup qmlmodules \brief The FolderListModel provides a model of the contents of a file system folder. To use this module, import the module with the following line: - \code - import Qt.labs.folderlistmodel 2.12 - \endcode + \qml \QtMinorVersion + import Qt.labs.folderlistmodel 2.\1 + \endqml */ @@ -251,7 +251,9 @@ QString QQuickFolderListModelPrivate::resolvePath(const QUrl &path) \e{Elements in the Qt.labs module are not guaranteed to remain compatible in future versions.} - \b{import Qt.labs.folderlistmodel 2.12} + \qml \QtMinorVersion + import Qt.labs.folderlistmodel 2.\1 + \endqml The \l folder property specifies the folder to access. Information about the files and directories in the folder is supplied via the model's interface. @@ -295,9 +297,9 @@ QString QQuickFolderListModelPrivate::resolvePath(const QUrl &path) The following example shows a FolderListModel being used to provide a list of QML files in a \l ListView: - \qml - import QtQuick 2.0 - import Qt.labs.folderlistmodel 2.12 + \qml \QtMinorVersion + import QtQuick 2.\1 + import Qt.labs.folderlistmodel 2.\1 ListView { width: 200; height: 400 diff --git a/src/imports/localstorage/plugin.cpp b/src/imports/localstorage/plugin.cpp index 15037b6a3a..bdf7294056 100644 --- a/src/imports/localstorage/plugin.cpp +++ b/src/imports/localstorage/plugin.cpp @@ -520,7 +520,7 @@ through the data. /*! - \qmlmodule QtQuick.LocalStorage 2.12 + \qmlmodule QtQuick.LocalStorage 2.\QtMinorVersion \title Qt Quick Local Storage QML Types \ingroup qmlmodules \brief Provides a JavaScript object singleton type for accessing a local @@ -541,16 +541,16 @@ through the data. To use the types in this module, import the module and call the relevant functions using the \c LocalStorage type: - \code - import QtQuick.LocalStorage 2.0 - import QtQuick 2.0 + \qml \QtMinorVersion + import QtQuick 2.\1 + import QtQuick.LocalStorage 2.\1 Item { Component.onCompleted: { var db = LocalStorage.openDatabaseSync(...) } } - \endcode + \endqml These databases are user-specific and QML-specific, but accessible to all QML applications. @@ -570,11 +570,13 @@ The \l{Qt Quick Examples - Local Storage}{SQL Local Storage example} demonstrate using the Offline Storage API. \section3 Open or Create a Database -\code -import QtQuick.LocalStorage 2.0 as Sql + +\qml \QtMinorVersion +import QtQuick.LocalStorage 2.\1 as Sql db = Sql.openDatabaseSync(identifier, version, description, estimated_size, callback(db)) -\endcode +\endqml + The above code returns the database identified by \e identifier. If the database does not already exist, it is created, and the function \e callback is called with the database as a parameter. \e identifier is the name of the physical file (with or without full path) containing the database. \e description and diff --git a/src/imports/models/plugin.cpp b/src/imports/models/plugin.cpp index e0ba2c07a4..2b19345f6b 100644 --- a/src/imports/models/plugin.cpp +++ b/src/imports/models/plugin.cpp @@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE /*! - \qmlmodule QtQml.Models 2.12 + \qmlmodule QtQml.Models 2.\QtMinorVersion \title Qt QML Models QML Types \ingroup qmlmodules \brief Provides QML types for data models @@ -55,9 +55,9 @@ QT_BEGIN_NAMESPACE To use the types in this module, import the module with the following line: - \code - import QtQml.Models 2.12 - \endcode + \qml \QtMinorVersion + import QtQml.Models 2.\1 + \endqml Note that QtQml.Models module started at version 2.1 to match the version of the parent module, \l{Qt QML}. diff --git a/src/imports/window/plugin.cpp b/src/imports/window/plugin.cpp index e0af82c8ea..657b230fa2 100644 --- a/src/imports/window/plugin.cpp +++ b/src/imports/window/plugin.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE /*! - \qmlmodule QtQuick.Window 2.12 + \qmlmodule QtQuick.Window 2.\QtMinorVersion \title Qt Quick Window QML Types \ingroup qmlmodules \brief Provides QML types for window management @@ -53,9 +53,9 @@ QT_BEGIN_NAMESPACE To use the types in this module, import the module with the following line: - \code - import QtQuick.Window 2.12 - \endcode + \qml \QtMinorVersion + import QtQuick.Window 2.\1 + \endqml */ diff --git a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp index 8941b33045..470b419c1f 100644 --- a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp +++ b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp @@ -74,7 +74,7 @@ typedef QPair<int, int> QQuickXmlListRange; #define XMLLISTMODEL_CLEAR_ID 0 /*! - \qmlmodule QtQuick.XmlListModel 2.12 + \qmlmodule QtQuick.XmlListModel 2.\QtMinorVersion \title Qt Quick XmlListModel QML Types \ingroup qmlmodules \brief Provides QML types for creating models from XML data @@ -83,9 +83,9 @@ typedef QPair<int, int> QQuickXmlListRange; To use the types in this module, import the module with the following line: - \code - import QtQuick.XmlListModel 2.12 - \endcode + \qml \QtMinorVersion + import QtQuick.XmlListModel 2.\1 + \endqml */ /*! |