From 583a748340e67ba10cf426fe2712412f9373055a Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@qt.io>
Date: Fri, 22 Mar 2019 10:52:13 +0100
Subject: [PATCH] Doc: Avoid auto-linking to WebEngine, WebSocket etc
When discussing the modules, it typically makes no sense to link
to QML types or external locations - prefix these words with a
backslash to instruct QDoc not attempt autolinking.
Task-number: QTBUG-74634
Change-Id: If134b6c8d00ed3e555834dd19c0b5a4030c9a53d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
---
doc/src/platforms/android.qdoc | 2 +-
doc/src/platforms/supported-platforms.qdoc | 4 ++--
doc/src/qt5-intro.qdoc | 2 +-
doc/src/qtmodules.qdoc | 2 +-
doc/src/userinterfaces.qdoc | 8 ++++----
doc/src/whatsnew/whatsnew511.qdoc | 2 +-
doc/src/whatsnew/whatsnew53.qdoc | 2 +-
doc/src/whatsnew/whatsnew54.qdoc | 2 +-
doc/src/whatsnew/whatsnew55.qdoc | 2 +-
9 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/doc/src/platforms/android.qdoc b/doc/src/platforms/android.qdoc
index 0418995c..1cd2d6a9 100644
--- a/doc/src/platforms/android.qdoc
+++ b/doc/src/platforms/android.qdoc
@@ -33,7 +33,7 @@
Qt for Android enables you to run Qt 5 applications on devices with Android
v4.1 (API level 16) or later. All Qt modules (essential and add-on) are
-supported except Qt WebEngine, Qt Serial Port, and the
+supported except Qt \WebEngine, Qt Serial Port, and the
platform-specific ones (Qt Mac Extras, Qt Windows Extras, and Qt X11 Extras).
The following configurations are supported.
diff --git a/doc/src/platforms/supported-platforms.qdoc b/doc/src/platforms/supported-platforms.qdoc
index 21660e1f..a2f54536 100644
--- a/doc/src/platforms/supported-platforms.qdoc
+++ b/doc/src/platforms/supported-platforms.qdoc
@@ -85,9 +85,9 @@
\section2 Exceptions
Individual modules might be available only on some platforms, or they might
- not support all configurations. For example, as Qt WebEngine has Chromium
+ not support all configurations. For example, as Qt \WebEngine has Chromium
as a third-party dependency, platform or configuration limitations upstream
- also apply to Qt WebEngine.
+ also apply to Qt \WebEngine.
The documentation for each module contains detailed information about any
exceptions the module has from the general platform and configuration
diff --git a/doc/src/qt5-intro.qdoc b/doc/src/qt5-intro.qdoc
index ca25a819..ca954518 100644
--- a/doc/src/qt5-intro.qdoc
+++ b/doc/src/qt5-intro.qdoc
@@ -39,7 +39,7 @@
Developers can be more productive and flexible with the improved support
for JavaScript and QML in Qt 5, while still having the C++ foundation
and Qt Widget support. HTML5 developers will feel at home with the Web
- offering that includes Chromium-based Qt WebEngine and Qt WebChannel.
+ offering that includes Chromium-based Qt \WebEngine and Qt \WebChannel.
Qt 5 is highly compatible with Qt 4. It is possible for developers
of Qt 4 applications to seamlessly move on to Qt 5 with their current
diff --git a/doc/src/qtmodules.qdoc b/doc/src/qtmodules.qdoc
index 4005706d..38e7276d 100644
--- a/doc/src/qtmodules.qdoc
+++ b/doc/src/qtmodules.qdoc
@@ -331,7 +331,7 @@
\li \l[QtWebSockets]{Qt WebSockets}
\li All
\li All
- \li Provides WebSocket communication compliant with \l{http://tools.ietf.org/html/rfc6455} {RFC 6455}.
+ \li Provides \WebSocket communication compliant with \l{http://tools.ietf.org/html/rfc6455} {RFC 6455}.
\row \li \l[QtWebView]{Qt WebView}
\li All
\li Platforms with a native web engine.
diff --git a/doc/src/userinterfaces.qdoc b/doc/src/userinterfaces.qdoc
index 4ff9e411..146fd2dc 100644
--- a/doc/src/userinterfaces.qdoc
+++ b/doc/src/userinterfaces.qdoc
@@ -134,7 +134,7 @@ choose the tool best suited for the job.
\li
\li Qt Quick / Qt Quick Controls
\li Qt Widgets
- \li Qt WebEngine
+ \li Qt \WebEngine
\li Comments
\row
\li Used language(s)
@@ -182,7 +182,7 @@ choose the tool best suited for the job.
\li
\li Qt Widgets provide all the bells and whistles, developed over two
decades, needed for building standard industry type applications.
- Qt WebEngine Widgets provide widgets and additional classes to render
+ Qt \WebEngine Widgets provide widgets and additional classes to render
and interact with web content.
\row
\li Model/View programming
@@ -204,7 +204,7 @@ choose the tool best suited for the job.
\li \inlineimage ok
\li \inlineimage ok
\li Qt Widgets provide QGLWidget for rendering OpenGL graphics,
- and Qt WebEngine supports WebGL, but the OpenGL ES 2.0 or OpenGL 2.0
+ and Qt \WebEngine supports \WebGL, but the OpenGL ES 2.0 or OpenGL 2.0
based \l {Qt Quick Scene Graph} has proven to provide the best
performance for UIs and for integrating with OpenGL content.
\row
@@ -229,7 +229,7 @@ choose the tool best suited for the job.
\li
\li \inlineimage ok
\li Both Qt Quick and Qt Widgets provide components for presenting
- \l {richtext-html-subset.html}{simple rich text}, but Qt WebEngine
+ \l {richtext-html-subset.html}{simple rich text}, but Qt \WebEngine
is the best choice for presenting full-blown web content.
\endtable
diff --git a/doc/src/whatsnew/whatsnew511.qdoc b/doc/src/whatsnew/whatsnew511.qdoc
index 76afa595..3da98db8 100644
--- a/doc/src/whatsnew/whatsnew511.qdoc
+++ b/doc/src/whatsnew/whatsnew511.qdoc
@@ -202,7 +202,7 @@
\section1 Platform Changes
\list
\li MSVC2013 support removed from the code base.
- \li Qt WebEngine now requires MSVC 2017 on Windows.
+ \li Qt \WebEngine now requires MSVC 2017 on Windows.
\li QNX 6.6 no longer supported (note: QNX 7 remains fully supported).
\li macOS 10.10 no longer supported.
\li Improved Accessibility support on Win32 by adopting the Windows UI
diff --git a/doc/src/whatsnew/whatsnew53.qdoc b/doc/src/whatsnew/whatsnew53.qdoc
index 90f56c2e..e275861e 100644
--- a/doc/src/whatsnew/whatsnew53.qdoc
+++ b/doc/src/whatsnew/whatsnew53.qdoc
@@ -42,7 +42,7 @@
\list
\li \l{Enginio Manual}{Enginio} - A client-side library for \l{Qt Cloud Services}.
- \li \l{Qt WebSockets} - An add-on module that implements the WebSocket standard
+ \li \l{Qt WebSockets} - An add-on module that implements the \WebSocket standard
\l{http://tools.ietf.org/html/rfc6455}{RFC 6455}
\endlist
diff --git a/doc/src/whatsnew/whatsnew54.qdoc b/doc/src/whatsnew/whatsnew54.qdoc
index 0b2b1c96..0b0085f4 100644
--- a/doc/src/whatsnew/whatsnew54.qdoc
+++ b/doc/src/whatsnew/whatsnew54.qdoc
@@ -144,7 +144,7 @@
\li Added support for OpenGL accelerated 2D canvas to
\l{Qt WebKit Widgets}.
\li The Qt WebKit module is considered \e done. It will be replaced by
- Qt WebEngine. This applies to the widgets as well as to the QML API of
+ Qt \WebEngine. This applies to the widgets as well as to the QML API of
Qt WebKit.
\endlist
diff --git a/doc/src/whatsnew/whatsnew55.qdoc b/doc/src/whatsnew/whatsnew55.qdoc
index f50440af..41ec4d33 100644
--- a/doc/src/whatsnew/whatsnew55.qdoc
+++ b/doc/src/whatsnew/whatsnew55.qdoc
@@ -186,7 +186,7 @@
{Qt Location} as a backend.
\li Added API for managing downloading of files.
\li Added API for controlling cache and cookie paths and policy.
- \li Added API for WebEngine settings.
+ \li Added API for \WebEngine settings.
\li Various experimental QML APIs promoted to public.
\li Added QtWebChannel integration API over Chromium IPC.
\li Updated Chromium snapshot to version 40.
--
GitLab