From 4723e88f6ec4aeadb35d65cfebbbb471ad8eb784 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 19 Dec 2016 17:28:57 +0100 Subject: Doc: Describe WebEngineLoadRequest::errorDomain MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Remove the WebEngineLoadRequest property doc from WebEngineView::loadingChanged() method docs and add the type name to create an automatic link to the type docs. Fix a typo in the copied ErrorDomain docs. Change-Id: I9798e066d599c75a062bb7f596e4465f32d613b4 Reviewed-by: Michael Brüning --- src/webengine/api/qquickwebengineloadrequest.cpp | 20 ++++++++++++++++++ src/webengine/doc/src/webengineview.qdoc | 26 +++--------------------- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/src/webengine/api/qquickwebengineloadrequest.cpp b/src/webengine/api/qquickwebengineloadrequest.cpp index 47ec17c16..b3422c516 100644 --- a/src/webengine/api/qquickwebengineloadrequest.cpp +++ b/src/webengine/api/qquickwebengineloadrequest.cpp @@ -120,6 +120,26 @@ QString QQuickWebEngineLoadRequest::errorString() const return d->errorString; } +/*! + \qmlproperty enumeration WebEngineLoadRequest::errorDomain + This enumeration holds the type of a load request error: + + \value WebEngineView.NoErrorDomain + Error type is not known. + \value WebEngineView.InternalErrorDomain + Content cannot be interpreted by Qt WebEngine. + \value WebEngineView.ConnectionErrorDomain + Error results from a faulty network connection. + \value WebEngineView.CertificateErrorDomain + Error is related to the SSL/TLS certificate. + \value WebEngineView.HttpErrorDomain + Error is related to the HTTP connection. + \value WebEngineView.FtpErrorDomain + Error is related to the FTP connection. + \value WebEngineView.DnsErrorDomain + Error is related to the DNS connection. +*/ + QQuickWebEngineView::ErrorDomain QQuickWebEngineLoadRequest::errorDomain() const { Q_D(const QQuickWebEngineLoadRequest); diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 6e403929d..364fa6c8a 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -513,28 +513,8 @@ This signal is emitted when a page load begins, ends, or fails. When handling the signal with \c onLoadingChanged, various read-only - parameters are available on the \a loadRequest: - - \table - \header - \li Property - \li Description - \row - \li url - \li The location of the resource that is loading. - \row - \li status - \li The \l{LoadStatus}{load status} of the page. - \row - \li errorString - \li The description of load error. - \row - \li errorCode - \li The HTTP error code. - \row - \li errorDomain - \li The high-level \l{ErrorDomain}{error type}. - \endtable + parameters are available on the WebEngineLoadRequest specified by + \a loadRequest. \sa loading, LoadStatus, ErrorDomain */ @@ -652,7 +632,7 @@ \value WebEngineView.ConnectionErrorDomain Error results from faulty network connection. \value WebEngineView.CertificateErrorDomain - Error related to the SSL/TLS certficate. + Error related to the SSL/TLS certificate. \value WebEngineView.HttpErrorDomain Error related to the HTTP connection. \value WebEngineView.FtpErrorDomain -- cgit v1.2.3