diff options
| author | Ulf Hermann <ulf.hermann@qt.io> | 2022-08-02 16:56:35 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-08-25 16:28:59 +0000 |
| commit | 912cea581a60b967b22482bba5e8c1039aceb849 (patch) | |
| tree | 3c4c3aaeb8f8bd8da444ffe51814a8d47e0f139a | |
| parent | c8313721076646d4f5f2f5af8f7f0503bad0de95 (diff) | |
Doc: Apply some fixes to LocalStorage documentation
The identifier is of course not a full (as in absolute) path, but rather
a relative path. The documentation states above that all paths are
relative to the engine's offlineStoragePath after all.
Also, drop the version number from \qmlmodule.
Fixes: QTBUG-95232
Change-Id: I9202d4ecd45d3efca00ad48dbef359491c373916
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
(cherry picked from commit 33fbb6ce749e469c116dd07a6604248031d9caf5)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/qmllocalstorage/qqmllocalstorage.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/qmllocalstorage/qqmllocalstorage.cpp b/src/qmllocalstorage/qqmllocalstorage.cpp index ff17ca8b60..8295b441df 100644 --- a/src/qmllocalstorage/qqmllocalstorage.cpp +++ b/src/qmllocalstorage/qqmllocalstorage.cpp @@ -526,7 +526,7 @@ through the data. */ /*! - \qmlmodule QtQuick.LocalStorage 2.\QtMinorVersion + \qmlmodule QtQuick.LocalStorage \title Qt Quick Local Storage QML Types \ingroup qmlmodules \brief Provides a JavaScript object singleton type for accessing a local @@ -584,10 +584,10 @@ db = Sql.openDatabaseSync(identifier, version, description, estimated_size, call \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 \e estimated_size are written to the INI file (described below), but are currently -unused. +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 relative path) containing the +database. \e description and \e estimated_size are written to the INI file (described below), but +are currently unused. May throw exception with code property SQLException.DATABASE_ERR, or SQLException.VERSION_ERR. |