From 991e32f2fae311f32791df90d8e531e1cbd23c2f Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Date: Fri, 4 Dec 2015 12:17:32 +0100
Subject: [PATCH] Doc: edit WebEngineCertificateError QML type docs
Change-Id: I658eaaefa422a0393318140a345e5114a3c085e6
Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>
---
.../api/qquickwebenginecertificateerror.cpp | 20 ++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/src/webengine/api/qquickwebenginecertificateerror.cpp b/src/webengine/api/qquickwebenginecertificateerror.cpp
index 202d201b3..f17d4a6d7 100644
--- a/src/webengine/api/qquickwebenginecertificateerror.cpp
+++ b/src/webengine/api/qquickwebenginecertificateerror.cpp
@@ -64,10 +64,10 @@ public:
\inqmlmodule QtWebEngine 1.1
\since QtWebEngine 1.1
- \brief A utility class for accepting or denying certificate exceptions when a certificate error occurs.
+ \brief A utility type for ignoring certificate errors or rejecting erroneous certificates.
- This class contains information about a certificate error that happened and provides a way to accept or
- deny a certificate exception.
+ This QML type contains information about a certificate error that occurred and provides a way
+ to ignore the error or reject the certificate.
\sa WebEngineView::certificateError
*/
@@ -86,8 +86,9 @@ QQuickWebEngineCertificateError::~QQuickWebEngineCertificateError()
/*!
\qmlmethod void WebEngineCertificateError::defer()
- This function should be called when there is a need to postpone the decision to ignore or not the certificate error. This is useful to
- wait for user input. When called it will pause the url request until WebEngineCertificateError::ignoreCertificateError() or
+ This function should be called when there is a need to postpone the decision whether to ignore a
+ certificate error, for example, while waiting for user input. When called, the function pauses the
+ URL request until WebEngineCertificateError::ignoreCertificateError() or
WebEngineCertificateError::rejectCertificate() is called.
*/
void QQuickWebEngineCertificateError::defer()
@@ -98,7 +99,7 @@ void QQuickWebEngineCertificateError::defer()
/*!
\qmlmethod void WebEngineCertificateError::ignoreCertificateError()
- The certificate error is ignored and the WebEngineView continues to load the requested url.
+ The certificate error is ignored, and the web engine view continues to load the requested URL.
*/
void QQuickWebEngineCertificateError::ignoreCertificateError()
{
@@ -114,7 +115,7 @@ void QQuickWebEngineCertificateError::ignoreCertificateError()
/*!
\qmlmethod void WebEngineCertificateError::rejectCertificate()
- The WebEngineView stops loading the requested url.
+ The certificate is rejected, and the web engine view stops loading the requested URL.
*/
void QQuickWebEngineCertificateError::rejectCertificate()
{
@@ -148,7 +149,8 @@ QUrl QQuickWebEngineCertificateError::url() const
The type of the error.
- \value SslPinnedKeyNotInCertificateChain The certificate did not match the built-in public key pins for the host name.
+ \value SslPinnedKeyNotInCertificateChain The certificate did not match the built-in public keys
+ pinned for the host name.
\value CertificateCommonNameInvalid The certificate's common name did not match the host name.
\value CertificateDateInvalid The certificate is not valid at the current date and time.
\value CertificateAuthorityInvalid The certificate is not signed by a trusted authority.
@@ -184,7 +186,7 @@ QString QQuickWebEngineCertificateError::description() const
\qmlproperty bool WebEngineCertificateError::overridable
\readonly
- A boolean that indicates if the certificate error can be overridden and accepted.
+ A boolean that indicates whether the certificate error can be overridden and ignored.
*/
bool QQuickWebEngineCertificateError::overridable() const
{
--
GitLab