summaryrefslogtreecommitdiffstats
path: root/examples/webenginewidgets
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2019-03-29 16:29:15 +0100
committerKai Koehne <kai.koehne@qt.io>2019-04-01 11:53:57 +0000
commitf564d58dcdc614f94d2fc3147f24537c35a1317e (patch)
treee147383af7a2e64bb8b6fc826910019ef95a9764 /examples/webenginewidgets
parentd3c11cb4ac32f87d485e4f6bd88afdc93e9ecd16 (diff)
Doc: Avoid auto-linking the string 'WebEngine' to the QML type
Remove the previous workaround (internal \externalpage command) that was used for this purpose, and replace it with a \QWE macro that expands to the string 'Qt \WebEngine'. The backslash in the expanded string instructs QDoc not to attempt auto-linking the word. Change-Id: If4e1c95423fa07479b1af055e4760a890c0ac667 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'examples/webenginewidgets')
-rw-r--r--examples/webenginewidgets/cookiebrowser/doc/src/cookiebrowser.qdoc2
-rw-r--r--examples/webenginewidgets/html2pdf/doc/src/html2pdf.qdoc6
-rw-r--r--examples/webenginewidgets/maps/doc/src/maps.qdoc2
-rw-r--r--examples/webenginewidgets/minimal/doc/src/minimal.qdoc4
-rw-r--r--examples/webenginewidgets/simplebrowser/doc/src/simplebrowser.qdoc4
-rw-r--r--examples/webenginewidgets/spellchecker/doc/src/spellchecker.qdoc4
-rw-r--r--examples/webenginewidgets/videoplayer/doc/src/videoplayer.qdoc6
-rw-r--r--examples/webenginewidgets/webui/doc/src/webui.qdoc6
8 files changed, 17 insertions, 17 deletions
diff --git a/examples/webenginewidgets/cookiebrowser/doc/src/cookiebrowser.qdoc b/examples/webenginewidgets/cookiebrowser/doc/src/cookiebrowser.qdoc
index a1b4eeb18..316e11a9b 100644
--- a/examples/webenginewidgets/cookiebrowser/doc/src/cookiebrowser.qdoc
+++ b/examples/webenginewidgets/cookiebrowser/doc/src/cookiebrowser.qdoc
@@ -29,7 +29,7 @@
\example webenginewidgets/cookiebrowser
\title WebEngine Cookie Browser Example
\ingroup webengine-widgetexamples
- \brief A cookie browser based on Qt WebEngine Widgets.
+ \brief A cookie browser based on \QWE Widgets.
\image cookiebrowser.png
diff --git a/examples/webenginewidgets/html2pdf/doc/src/html2pdf.qdoc b/examples/webenginewidgets/html2pdf/doc/src/html2pdf.qdoc
index eea7f7c09..37fe3eb50 100644
--- a/examples/webenginewidgets/html2pdf/doc/src/html2pdf.qdoc
+++ b/examples/webenginewidgets/html2pdf/doc/src/html2pdf.qdoc
@@ -29,11 +29,11 @@
\example webenginewidgets/html2pdf
\title WebEngine Widgets Html2Pdf Example
\ingroup webengine-widgetexamples
- \brief Converts web pages to PDF documents using Qt WebEngine.
+ \brief Converts web pages to PDF documents using \QWE.
\image html2pdf-example.png
- \e {Html2Pdf} demonstrates how to use Qt WebEngine to implement a
+ \e {Html2Pdf} demonstrates how to use \QWE to implement a
command-line application for converting web pages into PDF documents.
\include examples-run.qdocinc
@@ -90,7 +90,7 @@
\skipto int main
\printuntil /^\}/
- Note that to use Qt WebEngine Widgets we need to create a \l QApplication
+ Note that to use \QWE Widgets we need to create a \l QApplication
and not a \l QCoreApplication, even though this is a command line
application.
*/
diff --git a/examples/webenginewidgets/maps/doc/src/maps.qdoc b/examples/webenginewidgets/maps/doc/src/maps.qdoc
index 5e4a5cd83..489a5a780 100644
--- a/examples/webenginewidgets/maps/doc/src/maps.qdoc
+++ b/examples/webenginewidgets/maps/doc/src/maps.qdoc
@@ -38,7 +38,7 @@
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 Qt WebEngine relies on
+ 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.
diff --git a/examples/webenginewidgets/minimal/doc/src/minimal.qdoc b/examples/webenginewidgets/minimal/doc/src/minimal.qdoc
index d0b25c4b8..b04390d23 100644
--- a/examples/webenginewidgets/minimal/doc/src/minimal.qdoc
+++ b/examples/webenginewidgets/minimal/doc/src/minimal.qdoc
@@ -29,7 +29,7 @@
\example webenginewidgets/minimal
\title WebEngine Widgets Minimal Example
\ingroup webengine-widgetexamples
- \brief Displays a web page using Qt WebEngine Widgets.
+ \brief Displays a web page using \QWE Widgets.
\image minimal-example.png
@@ -53,7 +53,7 @@
In the \c main function we first set the
\l{QCoreApplication::organizationName} property. This affects the locations
- where Qt WebEngine stores persistent and cached data (see also
+ where \QWE stores persistent and cached data (see also
\l{QWebEngineProfile::cachePath} and
\l{QWebEngineProfile::persistentStoragePath}).
diff --git a/examples/webenginewidgets/simplebrowser/doc/src/simplebrowser.qdoc b/examples/webenginewidgets/simplebrowser/doc/src/simplebrowser.qdoc
index b0c426232..b5ad13626 100644
--- a/examples/webenginewidgets/simplebrowser/doc/src/simplebrowser.qdoc
+++ b/examples/webenginewidgets/simplebrowser/doc/src/simplebrowser.qdoc
@@ -29,7 +29,7 @@
\example webenginewidgets/simplebrowser
\title WebEngine Widgets Simple Browser Example
\ingroup webengine-widgetexamples
- \brief A simple browser based on Qt WebEngine Widgets.
+ \brief A simple browser based on \QWE Widgets.
\image simplebrowser.png
@@ -267,7 +267,7 @@
Alternatively we could implement private browsing on the tab-level, with
some tabs in a window in normal mode, others in private mode.
- Implementing private browsing is quite easy using Qt WebEngine. All one has
+ Implementing private browsing is quite easy using \QWE. All one has
to do is to create a new \l{QWebEngineProfile} and use it in the
\l{QWebEnginePage} instead of the default profile. In the example this new
profile is created and owned by the \c Browser object:
diff --git a/examples/webenginewidgets/spellchecker/doc/src/spellchecker.qdoc b/examples/webenginewidgets/spellchecker/doc/src/spellchecker.qdoc
index ff7b43a1b..ecdb1c818 100644
--- a/examples/webenginewidgets/spellchecker/doc/src/spellchecker.qdoc
+++ b/examples/webenginewidgets/spellchecker/doc/src/spellchecker.qdoc
@@ -41,7 +41,7 @@
\section1 Dictionaries
To be able to check the spelling, we need to provide the spellchecker with
- dictionaries. The Qt WebEngine spellchecker supports dictionaries provided by the
+ dictionaries. The \QWE spellchecker supports dictionaries provided by the
\l {Hunspell project} on all platforms and native dictionaries provided by macOS.
In this example, we want to support the English and German languages.
@@ -102,7 +102,7 @@
the actual language display name. We will use that mapping to display names
of dictionaries in the context menu. Spellchecking is disabled by default.
Therefore we also enable spellchecker and set the \e English dictionary.
- When Qt WebEngine's spellcheck service initializes, it will try to load the
+ When \QWE's spellcheck service initializes, it will try to load the
\c bdict dictionaries and to check them for consistency.
Any errors are logged by using the qWarning() function.
diff --git a/examples/webenginewidgets/videoplayer/doc/src/videoplayer.qdoc b/examples/webenginewidgets/videoplayer/doc/src/videoplayer.qdoc
index 9f6add6ae..5c455345b 100644
--- a/examples/webenginewidgets/videoplayer/doc/src/videoplayer.qdoc
+++ b/examples/webenginewidgets/videoplayer/doc/src/videoplayer.qdoc
@@ -40,8 +40,8 @@
cross-browser Javascript API that enables a web page to request that one of
its HTML elements be made to occupy the user's entire screen. It is
commonly used for full screen video playback via the \c <video> element, but
- can in principle be used to display any HTML content in full screen mode. Qt
- WebEngine supports this API, however it is disabled by default. This example
+ can in principle be used to display any HTML content in full screen mode.
+ \QWE supports this API, however it is disabled by default. This example
shows the steps needed to switch it on, including:
\list
@@ -94,7 +94,7 @@
\skipto MainWindow::MainWindow
\printuntil setCentralWidget
- We then configure Qt WebEngine to advertise support for the Fullscreen API:
+ We then configure \QWE to advertise support for the Fullscreen API:
\printline QWebEngineSettings
diff --git a/examples/webenginewidgets/webui/doc/src/webui.qdoc b/examples/webenginewidgets/webui/doc/src/webui.qdoc
index 47d9fbad1..949b358a7 100644
--- a/examples/webenginewidgets/webui/doc/src/webui.qdoc
+++ b/examples/webenginewidgets/webui/doc/src/webui.qdoc
@@ -35,8 +35,8 @@
\e {WebUI} demonstrates how to implement a custom scheme in a secure way.
- Aside from the built-in URL schemes, such as \c {http} and \c {qrc}, Qt
- WebEngine may be extended with \e {custom schemes} by creating \e {custom
+ Aside from the built-in URL schemes, such as \c {http} and \c {qrc},
+ \QWE may be extended with \e {custom schemes} by creating \e {custom
scheme handlers}. This example shows:
\list
@@ -111,7 +111,7 @@
made already at the top of the \c {main} function. This is so because custom
schemes need to be registered as early as possible so that that they can be
passed to all subprocesses. Specifically, custom schemes need to be registered
- before any other Qt WebEngine classes are instantiated by the application.
+ before any other \QWE classes are instantiated by the application.
\section1 Handling Requests