diff options
author | Allan Sandfeld Jensen <allan.jensen@digia.com> | 2014-12-01 11:53:59 +0100 |
---|---|---|
committer | Allan Sandfeld Jensen <allan.jensen@theqtcompany.com> | 2014-12-03 14:39:53 +0100 |
commit | b4b6d85fea56fde2447b57c8a6e379b6d8a2ec41 (patch) | |
tree | 7554287aeabf279ee7d081d4959d9561ef8f1be4 | |
parent | 5aa433cf1dc116326308e610dce80033aba67a85 (diff) |
Add class and enum documentation to QWebEngineCertificateError
Without the class description the methods documentation was never
generated.
Change-Id: I0d7232e8f5cc6765908cb28b77d0fe0f514d359d
Task-number: QTBUG-42996
Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>
-rw-r--r-- | src/webenginewidgets/api/qwebenginecertificateerror.cpp | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/src/webenginewidgets/api/qwebenginecertificateerror.cpp b/src/webenginewidgets/api/qwebenginecertificateerror.cpp index 7be8c75d0..bf7239cf3 100644 --- a/src/webenginewidgets/api/qwebenginecertificateerror.cpp +++ b/src/webenginewidgets/api/qwebenginecertificateerror.cpp @@ -38,6 +38,15 @@ QT_BEGIN_NAMESPACE +/*! + \class QWebEngineCertificateError + \brief The QWebEngineCertificateError class provides information about a certificate error. + + \inmodule QtWebEngineWidgets + + QWebEngineCertificateError holds known information about a certificate error to be used to determine whether to allow it or not, and to be reported to the user. +*/ + class QWebEngineCertificateErrorPrivate { public: QWebEngineCertificateErrorPrivate(int error, QUrl url, bool overridable, QString errorDescription); @@ -56,15 +65,39 @@ QWebEngineCertificateErrorPrivate::QWebEngineCertificateErrorPrivate(int error, { } +/*! \internal +*/ QWebEngineCertificateError::QWebEngineCertificateError(int error, QUrl url, bool overridable, QString errorDescription) : d_ptr(new QWebEngineCertificateErrorPrivate(error, url, overridable, errorDescription)) { } +/*! \internal +*/ QWebEngineCertificateError::~QWebEngineCertificateError() { } /*! + \enum QWebEngineCertificateError::Error + + This enum describes the type of certificate error encountered. + + \value SslPinnedKeyNotInCertificateChain The certificate did not match the built-in public key pins 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. + \value CertificateContainsErrors The certificate contains errors. + \value CertificateNoRevocationMechanism The certificate has no mechanism for determining if it has been revoked. + \value CertificateUnableToCheckRevocation Revocation information for the certificate is not available. + \value CertificateRevoked The certificate has been revoked. + \value CertificateInvalid The certificate is invalid. + \value CertificateWeakSignatureAlgorithm The certificate is signed using a weak signature algorithm. + \value CertificateNonUniqueName The host name specified in the certificate is not unique. + \value CertificateWeakKey The certificate contains a weak key. + \value CertificateNameConstraintViolation The certificate claimed DNS names that are in violation of name constraints. +*/ + +/*! Returns whether this error can be overridden and accepted. \sa error(), errorDescription() |