summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2021-08-18 12:50:39 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-08-23 19:19:37 +0000
commitcba74c389e68ab1412f26a8a7d1a42f92aa36e83 (patch)
tree462cd197454cb76dc646a91b4ab6762167f7dd56 /examples
parent469da22481f779f646cf809d8e0bda471d061f9d (diff)
Doc: Fix documentation warnings for Qt WebEngine
Task-number: QTBUG-95860 Change-Id: I5b1fd6a6e5f172724fcfbde1a791b342a7e1ff92 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> (cherry picked from commit 30237ec607a70964a7bfeaf875afb79f741214a7) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'examples')
-rw-r--r--examples/pdfwidgets/pdfviewer/doc/src/pdfviewer.qdoc6
-rw-r--r--examples/webengine/quicknanobrowser/doc/src/quicknanobrowser.qdoc26
-rw-r--r--examples/webenginewidgets/maps/doc/src/maps.qdoc8
3 files changed, 22 insertions, 18 deletions
diff --git a/examples/pdfwidgets/pdfviewer/doc/src/pdfviewer.qdoc b/examples/pdfwidgets/pdfviewer/doc/src/pdfviewer.qdoc
index a38d62e52..8024c0a51 100644
--- a/examples/pdfwidgets/pdfviewer/doc/src/pdfviewer.qdoc
+++ b/examples/pdfwidgets/pdfviewer/doc/src/pdfviewer.qdoc
@@ -34,8 +34,8 @@
//! TODO add thumbnail \image pdfviewer.png
- \e {PDF Viewer} demonstrates how to use the \l QPdfDocument class to render
- PDF documents and the \l QPdfPageNavigation class to navigate them.
+ \e {PDF Viewer} demonstrates how to use the QPdfDocument class to render
+ PDF documents and the QPdfPageNavigation class to navigate them.
Qt Creator and the integrated Qt Designer were used to create the example
UI and to connect it to the code. This affects the code, which might be
@@ -83,7 +83,7 @@
\printuntil addWidget(m_pageSelector)
- We use the \l QPdfPageNavigation class to handle the navigation through a
+ We use the QPdfPageNavigation class to handle the navigation through a
PDF document:
\printuntil setPageNavigation
diff --git a/examples/webengine/quicknanobrowser/doc/src/quicknanobrowser.qdoc b/examples/webengine/quicknanobrowser/doc/src/quicknanobrowser.qdoc
index 3188bb299..b1d44357d 100644
--- a/examples/webengine/quicknanobrowser/doc/src/quicknanobrowser.qdoc
+++ b/examples/webengine/quicknanobrowser/doc/src/quicknanobrowser.qdoc
@@ -62,15 +62,18 @@
\skipto width
\printuntil title
- We use the TabView Qt Quick control to create an empty tab view that fills the main window. We
- set the tab active first, to make sure that the tab item is immediately instantiated:
+ We use the TabBar Qt Quick control to create a tab bar anchored to the top of the window, and
+ create a new, empty tab:
- \skipto TabView
- \printuntil Component.onCompleted
+ \skipto TabBar {
+ \printuntil return webview
+ \printuntil }
The tab contains a web engine view that loads web content:
- \printuntil focus
+ \skipto Component {
+ \printuntil currentWebView.reload
+ \printuntil /^\ {8}\}/
We use the \l Action type to create new tabs:
@@ -82,14 +85,15 @@
We use the \l TextField Qt Quick Control within a \l ToolBar to create an address bar that
shows the current URL and where users can enter another URL:
- \skipto toolBar
+ \quotefromfile webengine/quicknanobrowser/BrowserWindow.qml
+ \skipto menuBar: ToolBar
\printuntil anchors.fill
\dots
\skipto TextField
\printuntil addressBar
\dots
\skipto focus
- \printuntil /^\ {16}\}/
+ \printuntil /^\ {12}\}/
\section1 Handling Certificate Errors
@@ -101,14 +105,14 @@
\skipto onCertificateError
\printuntil }
- We use the MessageDialog type to prompt users to continue or cancel the loading of the web page.
+ We use the Dialog type to prompt users to continue or cancel the loading of the web page.
If users select \uicontrol Yes, we call the
- \l{WebEngineCertificateError::}{ignoreCertificateError()} method to ignore the error and
- continue loading content from the URL. If users select \uicontrol No, we call the
+ \l{WebEngineCertificateError::}{acceptCertificate()} method to continue loading content from
+ the URL. If users select \uicontrol No, we call the
\l{WebEngineCertificateError::}{rejectCertificate()} method to reject the request and stop
loading content from the URL:
- \skipto MessageDialog
+ \skipto Dialog {
\printuntil /^\ {4}\}/
\section1 Entering and Leaving Fullscreen Mode
diff --git a/examples/webenginewidgets/maps/doc/src/maps.qdoc b/examples/webenginewidgets/maps/doc/src/maps.qdoc
index 489a5a780..75923c8f5 100644
--- a/examples/webenginewidgets/maps/doc/src/maps.qdoc
+++ b/examples/webenginewidgets/maps/doc/src/maps.qdoc
@@ -38,9 +38,9 @@
The \l {https://www.w3.org/TR/geolocation-API/}{Geolocation API} is a
JavaScript API that web applications can use to determine the user's
- physical location to show on a map, for example. As \QWE relies on
- \l {Qt Location} to power this API a viable location backend is needed for
- the target platform.
+ physical location to show on a map, for example. As \QWE relies on the
+ \e {Qt Location} module to power this API, a viable location backend is
+ needed for the target platform.
To avoid accidentally sending location information to third parties
geolocation requests are denied by default. This example demonstrates the
@@ -94,5 +94,5 @@
\printuntil /^\}/
- \sa {html5-geolocation}{Qt WebEngine HTML5 Geolocation}, {Qt Location}
+ \sa {html5-geolocation}{Qt WebEngine HTML5 Geolocation}
*/