From b50e7669ea463a0c6d326b831dc816c939ff6398 Mon Sep 17 00:00:00 2001
From: Kirill Burtsev <kirill.burtsev@qt.io>
Date: Thu, 26 Sep 2019 17:43:30 +0200
Subject: [PATCH] Mark new QWebEngineCertificateError methods with '\since' tag
Change-Id: Idf6c6448e8c8979dccd507b1ae131dc386161e94
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
---
.../api/qwebenginecertificateerror.cpp | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/src/webenginewidgets/api/qwebenginecertificateerror.cpp b/src/webenginewidgets/api/qwebenginecertificateerror.cpp
index a61d98f94..f5a8e6c6d 100644
--- a/src/webenginewidgets/api/qwebenginecertificateerror.cpp
+++ b/src/webenginewidgets/api/qwebenginecertificateerror.cpp
@@ -190,6 +190,8 @@ QString QWebEngineCertificateError::errorDescription() const
}
/*!
+ \since 5.14
+
Marks the certificate error for delayed handling.
This function should be called when there is a need to postpone the decision whether to ignore a
@@ -207,6 +209,8 @@ void QWebEngineCertificateError::defer()
}
/*!
+ \since 5.14
+
Returns whether the decision for error handling was delayed and the URL load was halted.
*/
bool QWebEngineCertificateError::deferred() const
@@ -215,6 +219,8 @@ bool QWebEngineCertificateError::deferred() const
}
/*!
+ \since 5.14
+
Ignores the certificate error and continues the loading of the requested URL.
*/
void QWebEngineCertificateError::ignoreCertificateError()
@@ -223,6 +229,8 @@ void QWebEngineCertificateError::ignoreCertificateError()
}
/*!
+ \since 5.14
+
Rejects the certificate and aborts the loading of the requested URL.
*/
void QWebEngineCertificateError::rejectCertificate()
@@ -231,7 +239,9 @@ void QWebEngineCertificateError::rejectCertificate()
}
/*!
- Returns \c true if the error was explicitly rejected or accepted.
+ \since 5.14
+
+ Returns \c true if the error was explicitly rejected or ignored.
*/
bool QWebEngineCertificateError::answered() const
{
@@ -239,7 +249,9 @@ bool QWebEngineCertificateError::answered() const
}
/*!
- Returns the peer's chain of digital certificates
+ \since 5.14
+
+ Returns the peer's chain of digital certificates.
Chain starts with the peer's immediate certificate and ending with the CA's certificate.
*/
--
GitLab