summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@theqtcompany.com>2015-09-11 12:50:33 +0200
committerKai Koehne <kai.koehne@theqtcompany.com>2015-09-14 09:17:57 +0000
commitc68fb8a3146aeff8ef04905810ba867312372ded (patch)
treeb57b2b73d20eb78eddd29f82cbc97b80d9fc2ff5
parentcf21bf56458e401c70faa2c12ec980121a8793e0 (diff)
Improve WebEngineProfile documentation
Change-Id: Ia7b160444a6c8902c6174d9859b3989a9442bc2e Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
-rw-r--r--src/webengine/api/qquickwebengineprofile.cpp7
-rw-r--r--src/webenginewidgets/api/qwebengineprofile.cpp5
2 files changed, 7 insertions, 5 deletions
diff --git a/src/webengine/api/qquickwebengineprofile.cpp b/src/webengine/api/qquickwebengineprofile.cpp
index 67c74c356..b06345b83 100644
--- a/src/webengine/api/qquickwebengineprofile.cpp
+++ b/src/webengine/api/qquickwebengineprofile.cpp
@@ -135,10 +135,11 @@ void QQuickWebEngineProfilePrivate::downloadUpdated(const DownloadItemInfo &info
\instantiates QQuickWebEngineProfile
\inqmlmodule QtWebEngine 1.1
\since QtWebEngine 1.1
- \brief Contains common settings for multiple web engine views.
+ \brief Contains settings, scripts, and visited links common to multiple web engine views.
- Contains settings and history shared by all the web engine views that belong
- to the profile.
+ WebEngineProfile contains settings, scripts, and the list of visited links shared by all
+ views that belong to the profile. As such, profiles can be used to isolate views
+ from each other. A typical use case is a dedicated profile for a 'private browsing' mode.
Each web engine view has an associated profile. Views that do not have a specific profile set
share a common default one.
diff --git a/src/webenginewidgets/api/qwebengineprofile.cpp b/src/webenginewidgets/api/qwebengineprofile.cpp
index 418f0996b..9789556fc 100644
--- a/src/webenginewidgets/api/qwebengineprofile.cpp
+++ b/src/webenginewidgets/api/qwebengineprofile.cpp
@@ -60,8 +60,9 @@ using QtWebEngineCore::BrowserContextAdapter;
\inmodule QtWebEngineWidgets
- QWebEngineProfile contains settings and history shared by all web engine pages that belong
- to the profile.
+ QWebEngineProfile contains settings, scripts, and the list of visited links shared by all
+ web engine pages that belong to the profile. As such, profiles can be used to isolate pages
+ from each other. A typical use case is a dedicated profile for a 'private browsing' mode.
The default profile is a built-in profile that all web pages not specifically created with
another profile belong to.