diff options
author | Topi Reinio <topi.reinio@qt.io> | 2021-06-30 14:04:31 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-07-07 15:21:28 +0000 |
commit | a864df85a9e46c5dcd7a03a444d3b8a7717946f7 (patch) | |
tree | 0c70ac6ece86802a0ad3bc42f7f2bd51edd84eee /src/webenginequick | |
parent | bbab484dc45ae2391065d07e1f68027bb53e44d9 (diff) |
Doc: Fix documentation issues for Qt WebEngine
API and documentation changes since 5.15 caused multiple warnings from
QDoc; this change addresses most of them. Some warnings indicate
missing documentation, those issues still remain.
Change-Id: I96be38b7daac37a7e35c149b4b3ec3f18c4415c9
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
(cherry picked from commit c248844b3b8ee004800606d1a6c6e6d6bee31738)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src/webenginequick')
11 files changed, 33 insertions, 47 deletions
diff --git a/src/webenginequick/api/qquickwebengineclientcertificateselection.cpp b/src/webenginequick/api/qquickwebengineclientcertificateselection.cpp index 4d8b38427..3a42366b6 100644 --- a/src/webenginequick/api/qquickwebengineclientcertificateselection.cpp +++ b/src/webenginequick/api/qquickwebengineclientcertificateselection.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype WebEngineClientCertificateOption - \instantiates QQuickWebEngineClientCertificateOption + //! \instantiates QQuickWebEngineClientCertificateOption \inqmlmodule QtWebEngine \since QtWebEngine 1.9 \brief Represents a client certificate option. @@ -117,7 +117,7 @@ void QQuickWebEngineClientCertificateOption::select() /*! \qmltype WebEngineClientCertificateSelection - \instantiates QQuickWebEngineClientCertificateSelection + //! \instantiates QQuickWebEngineClientCertificateSelection \inqmlmodule QtWebEngine \since QtWebEngine 1.9 \brief Provides a selection of client certificates. diff --git a/src/webenginequick/api/qquickwebenginedialogrequests.cpp b/src/webenginequick/api/qquickwebenginedialogrequests.cpp index da1aecaf6..5d56d6b75 100644 --- a/src/webenginequick/api/qquickwebenginedialogrequests.cpp +++ b/src/webenginequick/api/qquickwebenginedialogrequests.cpp @@ -71,7 +71,7 @@ ASSERT_ENUMS_MATCH(FilePickerController::Save, /*! \qmltype AuthenticationDialogRequest - \instantiates QQuickWebEngineAuthenticationDialogRequest + //! \instantiates QQuickWebEngineAuthenticationDialogRequest \inqmlmodule QtWebEngine \since QtWebEngine 1.4 @@ -246,7 +246,7 @@ void QQuickWebEngineAuthenticationDialogRequest::dialogReject() /*! \qmltype JavaScriptDialogRequest - \instantiates QQuickWebEngineJavaScriptDialogRequest + //! \instantiates QQuickWebEngineJavaScriptDialogRequest \inqmlmodule QtWebEngine \since QtWebEngine 1.4 @@ -441,7 +441,7 @@ void QQuickWebEngineJavaScriptDialogRequest::dialogReject() /*! \qmltype ColorDialogRequest - \instantiates QQuickWebEngineColorDialogRequest + //! \instantiates QQuickWebEngineColorDialogRequest \inqmlmodule QtWebEngine \since QtWebEngine 1.4 @@ -560,7 +560,7 @@ void QQuickWebEngineColorDialogRequest::dialogReject() /*! \qmltype FileDialogRequest - \instantiates QQuickWebEngineFileDialogRequest + //! \instantiates QQuickWebEngineFileDialogRequest \inqmlmodule QtWebEngine \since QtWebEngine 1.4 @@ -716,7 +716,7 @@ void QQuickWebEngineFileDialogRequest::dialogReject() /*! \qmltype FormValidationMessageRequest - \instantiates QQuickWebEngineFormValidationMessageRequest + //! \instantiates QQuickWebEngineFormValidationMessageRequest \inqmlmodule QtWebEngine \since QtWebEngine 1.4 \obsolete @@ -830,7 +830,7 @@ void QQuickWebEngineFormValidationMessageRequest::setAccepted(bool accepted) /*! \qmltype TooltipRequest - \instantiates QQuickWebEngineTooltipRequest + //! \instantiates QQuickWebEngineTooltipRequest \inqmlmodule QtWebEngine \since QtWebEngine 1.10 diff --git a/src/webenginequick/api/qquickwebengineprofile.cpp b/src/webenginequick/api/qquickwebengineprofile.cpp index d3909418d..1c32c9ffb 100644 --- a/src/webenginequick/api/qquickwebengineprofile.cpp +++ b/src/webenginequick/api/qquickwebengineprofile.cpp @@ -941,10 +941,8 @@ QQuickWebEngineSettings *QQuickWebEngineProfile::settings() const \qmlproperty list<WebEngineScript> WebEngineProfile::userScripts \since 1.5 - Returns the collection of WebEngineScripts that are injected into all pages that share - this profile. - - \sa WebEngineScript + Returns the collection of WebEngineScript objects that are injected into + all pages that share this profile. */ QQuickWebEngineScriptCollection *QQuickWebEngineProfile::userScripts() const diff --git a/src/webenginequick/api/qquickwebenginesettings.cpp b/src/webenginequick/api/qquickwebenginesettings.cpp index f1fd00b8d..aba47dfe6 100644 --- a/src/webenginequick/api/qquickwebenginesettings.cpp +++ b/src/webenginequick/api/qquickwebenginesettings.cpp @@ -54,7 +54,7 @@ QQuickWebEngineSettings::QQuickWebEngineSettings(QQuickWebEngineSettings *parent /*! \qmltype WebEngineSettings - \instantiates QQuickWebEngineSettings + //! \instantiates QQuickWebEngineSettings \inqmlmodule QtWebEngine \since QtWebEngine 1.1 \brief Allows configuration of browser properties and attributes. @@ -73,22 +73,6 @@ QQuickWebEngineSettings::~QQuickWebEngineSettings() { } /*! - \enum QQuickWebEngineSettings::UnknownUrlSchemePolicy - \since WebEngine 1.7 - - This enum describes how navigation requests to URLs with unknown schemes are handled. - - \value DisallowUnknownUrlSchemes - Disallows all navigation requests to URLs with unknown schemes. - \value AllowUnknownUrlSchemesFromUserInteraction - Allows navigation requests to URLs with unknown schemes that are issued from - user-interaction (like a mouse-click), whereas other navigation requests (for example - from JavaScript) are suppressed. - \value AllowAllUnknownUrlSchemes - Allows all navigation requests to URLs with unknown schemes. -*/ - -/*! \qmlproperty bool WebEngineSettings::autoLoadImages Automatically loads images on web pages. @@ -493,11 +477,20 @@ ASSERT_ENUMS_MATCH(QQuickWebEngineSettings::AllowUnknownUrlSchemesFromUserIntera ASSERT_ENUMS_MATCH(QQuickWebEngineSettings::AllowAllUnknownUrlSchemes, QWebEngineSettings::AllowAllUnknownUrlSchemes) /*! - \qmlproperty QWebEngineSettings::UnknownUrlSchemePolicy WebEngineSettings::unknownUrlSchemePolicy + \qmlproperty enumeration WebEngineSettings::unknownUrlSchemePolicy \since QtWebEngine 1.7 Specifies how navigation requests to URLs with unknown schemes are handled. - Default is \l{QWebEngineSettings::UnknownUrlSchemePolicy}{WebEngineSettings.AllowUnknownUrlSchemesFromUserInteraction}. + \value WebEngineSettings.DisallowUnknownUrlSchemes + Disallows all navigation requests to URLs with unknown schemes. + \value WebEngineSettings.AllowUnknownUrlSchemesFromUserInteraction + Allows navigation requests to URLs with unknown schemes that are issued from + user-interaction (like a mouse-click), whereas other navigation requests (for example + from JavaScript) are suppressed. + \value WebEngineSettings.AllowAllUnknownUrlSchemes + Allows all navigation requests to URLs with unknown schemes. + + Default value is \c {WebEngineSettings.AllowUnknownUrlSchemesFromUserInteraction}. */ QQuickWebEngineSettings::UnknownUrlSchemePolicy QQuickWebEngineSettings::unknownUrlSchemePolicy() const { diff --git a/src/webenginequick/api/qquickwebenginesingleton.cpp b/src/webenginequick/api/qquickwebenginesingleton.cpp index 05f38e34e..a35404aa8 100644 --- a/src/webenginequick/api/qquickwebenginesingleton.cpp +++ b/src/webenginequick/api/qquickwebenginesingleton.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype WebEngine - \instantiates QQuickWebEngineSingleton + //! \instantiates QQuickWebEngineSingleton \inqmlmodule QtWebEngine \since QtWebEngine 1.1 \brief Provides access to the default settings and profiles shared by all web engine views. diff --git a/src/webenginequick/doc/src/context_menu_request.qdoc b/src/webenginequick/doc/src/context_menu_request.qdoc index cc812dcf2..40b595696 100644 --- a/src/webenginequick/doc/src/context_menu_request.qdoc +++ b/src/webenginequick/doc/src/context_menu_request.qdoc @@ -27,7 +27,7 @@ /*! \qmltype ContextMenuRequest - \instantiates QQuickWebEngineContextMenuRequest + //! \instantiates QQuickWebEngineContextMenuRequest \inqmlmodule QtWebEngine \since QtWebEngine 1.4 @@ -35,8 +35,8 @@ A ContextMenuRequest is passed as an argument of the WebEngineView::contextMenuRequested signal. It provides further - information about the context of the request. The position of the - request origin can be found via the \l x and \l y properties. + information about the context of the request. The \l position + property provides the origin of the request. The \l accepted property of the request indicates whether the request is handled by the user code or the default context menu should diff --git a/src/webenginequick/doc/src/loading_info.qdoc b/src/webenginequick/doc/src/loading_info.qdoc index 9666b2020..fe8e30a80 100644 --- a/src/webenginequick/doc/src/loading_info.qdoc +++ b/src/webenginequick/doc/src/loading_info.qdoc @@ -58,9 +58,6 @@ \sa WebEngineView::loadingChanged */ /*! - \qmlproperty Indicates if the load's resulted in an error page. -*/ -/*! \qmlproperty string WebEngineLoadingInfo::errorString \brief Holds the error message. */ diff --git a/src/webenginequick/doc/src/qtwebengine-overview.qdoc b/src/webenginequick/doc/src/qtwebengine-overview.qdoc index c7aaffc4e..099142f80 100644 --- a/src/webenginequick/doc/src/qtwebengine-overview.qdoc +++ b/src/webenginequick/doc/src/qtwebengine-overview.qdoc @@ -225,7 +225,7 @@ open SSL connections. Instead, \QWE uses the root CA certificates from the operating system to validate the peer's certificate. - The \l{WebEngineCertificateError::error} and \l{QWebEngineCertificateError::Error} enumerations + The \l{WebEngineCertificateError::error} and \l{QWebEngineCertificateError::Type} enumerations provide information about the types of certificate errors that might occur. The errors can be handled by using the WebEngineView::certificateError QML method or by connecting to the QWebEnginePage::certificateError signal. @@ -273,7 +273,7 @@ files. Depending on the target resolutions, one or both of these files need to be deployed. - For more information, see \l{High DPI Displays}. + For more information, see \l{High DPI}. \section1 Using WebEngine Core diff --git a/src/webenginequick/doc/src/qtwebengine-platform-notes.qdoc b/src/webenginequick/doc/src/qtwebengine-platform-notes.qdoc index e32424eea..08eaf72bb 100644 --- a/src/webenginequick/doc/src/qtwebengine-platform-notes.qdoc +++ b/src/webenginequick/doc/src/qtwebengine-platform-notes.qdoc @@ -39,7 +39,7 @@ platform: \list - \li \l{Qt for Windows - Requirements} + \li \l{Qt for Windows - Building from Source} \li \l{Qt for X11 Requirements} \li \l{Qt for macOS - Building from Source} \endlist diff --git a/src/webenginequick/doc/src/webengine_download_request.qdoc b/src/webenginequick/doc/src/webengine_download_request.qdoc index 2b96ec45b..845a8ff07 100644 --- a/src/webenginequick/doc/src/webengine_download_request.qdoc +++ b/src/webenginequick/doc/src/webengine_download_request.qdoc @@ -219,7 +219,7 @@ */ /*! - \qmlproperty bool WebEngineDownloadItem::isSavePageDownload + \qmlproperty bool WebEngineDownloadRequest::isSavePageDownload \readonly Whether this is a download request for saving a web page or a file. diff --git a/src/webenginequick/doc/src/webengineview_lgpl.qdoc b/src/webenginequick/doc/src/webengineview_lgpl.qdoc index 11dceae69..f45558b9c 100644 --- a/src/webenginequick/doc/src/webengineview_lgpl.qdoc +++ b/src/webenginequick/doc/src/webengineview_lgpl.qdoc @@ -331,9 +331,7 @@ \readonly \since QtWebEngine 1.1 - List of script objects attached to the view. - - \sa WebEngineScript + List of WebEngineScript objects attached to the view. */ /*! @@ -586,7 +584,7 @@ An example implementation: - \snippet snippets/qtwebengine_webengineview_newviewrequested.qml 0 + \snippet qtwebengine_webengineview_newviewrequested.qml 0 \sa WebEngineNewViewRequest, {WebEngine Quick Nano Browser} */ @@ -1482,7 +1480,7 @@ \readonly If no render process is available yet, \c 0 is returned. - This signal is emitted when the PID (process ID) of the page's underlying + This signal is emitted when \a pid (process ID) of the page's underlying render process changed. \sa renderProcessPid |