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/localstorage | |
| 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/localstorage')
| -rw-r--r-- | src/imports/localstorage/plugin.cpp | 18 |
1 files changed, 10 insertions, 8 deletions
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 |