summaryrefslogtreecommitdiffstats
path: root/src/core/doc/src
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 /src/core/doc/src
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 'src/core/doc/src')
-rw-r--r--src/core/doc/src/qtwebenginecore-index.qdoc6
-rw-r--r--src/core/doc/src/qtwebenginecore-module.qdoc2
2 files changed, 4 insertions, 4 deletions
diff --git a/src/core/doc/src/qtwebenginecore-index.qdoc b/src/core/doc/src/qtwebenginecore-index.qdoc
index 4d540e277..692e33d1d 100644
--- a/src/core/doc/src/qtwebenginecore-index.qdoc
+++ b/src/core/doc/src/qtwebenginecore-index.qdoc
@@ -29,9 +29,9 @@
\page qtwebenginecore-index.html
\title Qt WebEngine Core
- \brief Provides common API shared by Qt WebEngine and Qt WebEngine Widgets.
+ \brief Provides common API shared by \QWE and \QWE Widgets.
- Qt WebEngine Core provides API shared by \l {Qt WebEngine} and \l {Qt WebEngine Widgets}.
+ \QWE Core provides API shared by \l {Qt WebEngine} and \l {Qt WebEngine Widgets}.
\section1 Getting Started
@@ -61,7 +61,7 @@
This is a snapshot of the integration of Chromium into Qt.
Qt Commercial Edition licensees that wish to distribute applications that
- use the Qt WebEngine module need to be aware of their obligations under the
+ use the \QWE module need to be aware of their obligations under the
GNU Library General Public License (LGPLv2).
Developers using the Open Source Edition can choose to redistribute
diff --git a/src/core/doc/src/qtwebenginecore-module.qdoc b/src/core/doc/src/qtwebenginecore-module.qdoc
index 65e0766de..c976d024c 100644
--- a/src/core/doc/src/qtwebenginecore-module.qdoc
+++ b/src/core/doc/src/qtwebenginecore-module.qdoc
@@ -39,7 +39,7 @@
\snippet qtwebenginecore_build_snippet.qdoc 1
- If you use qmake to build your projects, Qt WebEngine Core is usually
+ If you use qmake to build your projects, \QWE Core is usually
indirectly included through the \l{Qt WebEngine QML Types}{Qt WebEngine} or
\l{Qt WebEngine Widgets C++ Classes}{Qt WebEngine Widgets} modules.