qiurui
/
qtdeclarative
mirror of https://github.com/qt/qtdeclarative.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.

Pick-to: 6.2 6.3 6.4
Fixes: QTBUG-95232
Change-Id: I9202d4ecd45d3efca00ad48dbef359491c373916
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
This commit is contained in:
Ulf Hermann 2022-08-02 16:56:35 +02:00
parent 87e9ea9efa
commit 33fbb6ce74
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/qmllocalstorage/qqmllocalstorage.cpp
View File

@ -491,7 +491,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
@ -549,10 +549,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.