diff options
| author | Kai Koehne <kai.koehne@theqtcompany.com> | 2016-03-29 14:16:09 +0200 |
|---|---|---|
| committer | Kai Koehne <kai.koehne@theqtcompany.com> | 2016-03-29 14:08:10 +0000 |
| commit | f66c8894268e25d58f7a405914f81595ce6ac8c1 (patch) | |
| tree | a1aaaf8e9e98ba893bb299e9d1e36b423b80662c /src | |
| parent | b6dc12bbb5059441363dcea3bcae94d17da482ec (diff) | |
Doc: Fix documentation about cookie stores
Remove misleading "singleton, if one has been set" from the accessor's
documentation. Also link to the accessor's from the class documentation,
and remove mentioning of cookie store as something that can be accessed
for an individual page.
Finally, mark QWebEngineProfile::cookieStore as new in Qt 5.6.
Change-Id: Ia20ca0ef45a9a15de0052f7ceb7f59d454c70fdc
Reviewed-by: Florian Bruhin <qt-project.org@the-compiler.org>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/core/api/qwebenginecookiestore.cpp | 3 | ||||
| -rw-r--r-- | src/webengine/api/qquickwebengineprofile.cpp | 2 | ||||
| -rw-r--r-- | src/webengine/doc/src/qtwebengine-overview.qdoc | 2 | ||||
| -rw-r--r-- | src/webenginewidgets/api/qwebengineprofile.cpp | 4 |
4 files changed, 8 insertions, 3 deletions
diff --git a/src/core/api/qwebenginecookiestore.cpp b/src/core/api/qwebenginecookiestore.cpp index 5220073f3..df537a787 100644 --- a/src/core/api/qwebenginecookiestore.cpp +++ b/src/core/api/qwebenginecookiestore.cpp @@ -188,6 +188,9 @@ void QWebEngineCookieStorePrivate::onCookieChanged(const QNetworkCookie &cookie, to get notified about the success of the operation. The signal handlers for removal and addition should not be used to execute heavy tasks, because they might block the IO thread in case of a blocking connection. + + Use QWebEngineProfile::cookieStore() and QQuickWebEngineProfile::cookieStore() + to access the cookie store object for a specific profile. */ /*! diff --git a/src/webengine/api/qquickwebengineprofile.cpp b/src/webengine/api/qquickwebengineprofile.cpp index 3284d8491..c522ef1ea 100644 --- a/src/webengine/api/qquickwebengineprofile.cpp +++ b/src/webengine/api/qquickwebengineprofile.cpp @@ -592,7 +592,7 @@ QQuickWebEngineProfile *QQuickWebEngineProfile::defaultProfile() } /*! - Returns the cookie store singleton, if one has been set. + Returns the cookie store for this profile. */ QWebEngineCookieStore *QQuickWebEngineProfile::cookieStore() const { diff --git a/src/webengine/doc/src/qtwebengine-overview.qdoc b/src/webengine/doc/src/qtwebengine-overview.qdoc index 6ec345cb0..1ac7710a9 100644 --- a/src/webengine/doc/src/qtwebengine-overview.qdoc +++ b/src/webengine/doc/src/qtwebengine-overview.qdoc @@ -152,7 +152,7 @@ Each QWebEnginePage belongs to a QWebEngineProfile that can have a QWebEngineSettings for specifying page settings, a QWebEngineScriptCollection for running scripts on the page, and a QWebEngineCookieStore for accessing the HTTP cookies of Chromium. A QWebEnginePage can also - directly point to a script collection or cookie store. + directly point to a script collection. \section1 Embedding Web Content into Qt Quick Applications diff --git a/src/webenginewidgets/api/qwebengineprofile.cpp b/src/webenginewidgets/api/qwebengineprofile.cpp index 894db3251..b2cc23565 100644 --- a/src/webenginewidgets/api/qwebengineprofile.cpp +++ b/src/webenginewidgets/api/qwebengineprofile.cpp @@ -457,7 +457,9 @@ void QWebEngineProfile::setHttpCacheMaximumSize(int maxSize) } /*! - Returns the cookie store singleton, if one has been set. + Returns the cookie store for this profile. + + \since 5.6 */ QWebEngineCookieStore* QWebEngineProfile::cookieStore() |