From 315e656efa99fce4ec9e822d428eed8af4fd1022 Mon Sep 17 00:00:00 2001
From: Florian Bruhin <git@the-compiler.org>
Date: Mon, 6 Feb 2017 16:38:42 +0100
Subject: [PATCH] Improve cross-links between QtWebEngine classes in docs
Change-Id: Iae853d4d3ab73306f90d93b62a419d1d440a3259
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
---
src/core/api/qwebengineurlrequestinfo.cpp | 11 ++++++-----
src/core/api/qwebengineurlschemehandler.cpp | 3 ++-
.../api/qwebenginecertificateerror.cpp | 3 ++-
3 files changed, 10 insertions(+), 7 deletions(-)
diff --git a/src/core/api/qwebengineurlrequestinfo.cpp b/src/core/api/qwebengineurlrequestinfo.cpp
index 877b376b0..c03255a97 100644
--- a/src/core/api/qwebengineurlrequestinfo.cpp
+++ b/src/core/api/qwebengineurlrequestinfo.cpp
@@ -96,6 +96,9 @@ ASSERT_ENUMS_MATCH(QtWebEngineCore::WebContentsAdapterClient::OtherNavigation, Q
interceptor on the profile enables intercepting, blocking, and modifying URL requests
before they reach the networking stack of Chromium.
+ You can install the interceptor on a profile via QWebEngineProfile::setRequestInterceptor()
+ or QQuickWebEngineProfile::setRequestInterceptor().
+
\sa interceptRequest(), QWebEngineUrlRequestInfo
*/
@@ -108,14 +111,12 @@ ASSERT_ENUMS_MATCH(QtWebEngineCore::WebContentsAdapterClient::OtherNavigation, Q
/*!
\fn void QWebEngineUrlRequestInterceptor::interceptRequest(QWebEngineUrlRequestInfo &info)
- Reimplementing this virtual function and setting the interceptor on a profile makes
- it possible to intercept URL requests. This function is executed on the IO thread,
- and therefore running long tasks here will block networking.
+ Reimplementing this virtual function makes it possible to intercept URL
+ requests. This function is executed on the IO thread, and therefore running
+ long tasks here will block networking.
\a info contains the information about the URL request and will track internally
whether its members have been altered.
-
- \sa QWebEngineProfile::setRequestInterceptor()
*/
diff --git a/src/core/api/qwebengineurlschemehandler.cpp b/src/core/api/qwebengineurlschemehandler.cpp
index e60d90d04..94b85c42b 100644
--- a/src/core/api/qwebengineurlschemehandler.cpp
+++ b/src/core/api/qwebengineurlschemehandler.cpp
@@ -49,7 +49,8 @@ QT_BEGIN_NAMESPACE
\since 5.6
To implement a custom URL scheme for QtWebEngine, you must write a class derived from this class,
- and reimplement requestStarted().
+ and reimplement requestStarted(). Then install it via QWebEngineProfile::installUrlSchemeHandler()
+ or QQuickWebEngineProfile::installUrlSchemeHandler().
\inmodule QtWebEngineCore
diff --git a/src/webenginewidgets/api/qwebenginecertificateerror.cpp b/src/webenginewidgets/api/qwebenginecertificateerror.cpp
index a0641c9dd..f04b73615 100644
--- a/src/webenginewidgets/api/qwebenginecertificateerror.cpp
+++ b/src/webenginewidgets/api/qwebenginecertificateerror.cpp
@@ -47,7 +47,8 @@ QT_BEGIN_NAMESPACE
\since 5.4
\inmodule QtWebEngineWidgets
- Provides information about a certificate error.
+ Provides information about a certificate error. This class is used as a parameter of
+ QWebEnginePage::certificateError().
*/
class QWebEngineCertificateErrorPrivate {
--
GitLab