summaryrefslogtreecommitdiffstats
path: root/src/webenginequick/doc/src
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2021-06-30 14:04:31 +0200
committerTopi Reinio <topi.reinio@qt.io>2021-07-01 14:50:42 +0200
commitc248844b3b8ee004800606d1a6c6e6d6bee31738 (patch)
treee5c9d05a1f59f725d79279f8dbc5cb75136d118a /src/webenginequick/doc/src
parent57eb73f933e3c1499a969b2023073c3c01bb9a1f (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. Pick-to: 6.2 Change-Id: I96be38b7daac37a7e35c149b4b3ec3f18c4415c9 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/webenginequick/doc/src')
-rw-r--r--src/webenginequick/doc/src/context_menu_request.qdoc6
-rw-r--r--src/webenginequick/doc/src/loading_info.qdoc3
-rw-r--r--src/webenginequick/doc/src/qtwebengine-overview.qdoc4
-rw-r--r--src/webenginequick/doc/src/qtwebengine-platform-notes.qdoc2
-rw-r--r--src/webenginequick/doc/src/webengine_download_request.qdoc2
-rw-r--r--src/webenginequick/doc/src/webengineview_lgpl.qdoc8
6 files changed, 10 insertions, 15 deletions
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