summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-10-08 12:45:48 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2015-10-08 12:30:23 +0000
commit0228a5bd581ae6d672ce5f39f11d6205a8bd8aaf (patch)
treebcd303612023083a304f5b7a755c38c7ab65bff7 /src
parent96c80416cf685f9eb7765d1befff93d85606fe2a (diff)
Doc: Collect external links into a single file
Move external links to a dedicated .qdoc file for maintainability. Add an \externalpage that's marked internal to work around the issue of each occurrence of 'WebEngine' being autolinked to the WebEngine QML type, which is typically not desired. Change-Id: Icfdbefac7372866f5258378aa59daba1a97cc776 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Diffstat (limited to 'src')
-rw-r--r--src/webengine/api/qquickwebenginesettings.cpp2
-rw-r--r--src/webengine/doc/src/external-resources.qdoc48
-rw-r--r--src/webengine/doc/src/qtwebengine-devtools.qdoc2
-rw-r--r--src/webengine/doc/src/qtwebengine-overview.qdoc10
4 files changed, 55 insertions, 7 deletions
diff --git a/src/webengine/api/qquickwebenginesettings.cpp b/src/webengine/api/qquickwebenginesettings.cpp
index 407f2a49f..8f2e1bcf2 100644
--- a/src/webengine/api/qquickwebenginesettings.cpp
+++ b/src/webengine/api/qquickwebenginesettings.cpp
@@ -59,7 +59,7 @@ QQuickWebEngineSettings::QQuickWebEngineSettings(QQuickWebEngineSettings *parent
The WebEngineSettings type can be used to configure browser properties and generic
attributes, such as JavaScript support, focus behavior, and access to remote content. This type
is uncreatable, but the default settings for all web engine views can be accessed by using
- the \l{WebEngine::settings}{WebEngine.settings} property.
+ the \l [QML] {WebEngine::settings}{WebEngine.settings} property.
Each web engine view can have individual settings that can be accessed by using the
\l{WebEngineView::settings}{WebEngineView.settings} property.
diff --git a/src/webengine/doc/src/external-resources.qdoc b/src/webengine/doc/src/external-resources.qdoc
new file mode 100644
index 000000000..34a66291e
--- /dev/null
+++ b/src/webengine/doc/src/external-resources.qdoc
@@ -0,0 +1,48 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \externalpage http://www.chromium.org
+ \title Chromium Project
+*/
+
+/*!
+ \externalpage https://developers.google.com/web/tools/chrome-devtools
+ \title Chrome DevTools
+*/
+
+/*
+ This prevents autolinking of each occurrence of 'WebEngine'
+ To link to the WebEngine QML type, use explicit linking:
+ \l [QML] WebEngine
+ \sa {QtWebEngine::}{WebEngine}
+*/
+/*!
+ \externalpage nolink
+ \title WebEngine
+ \internal
+*/
diff --git a/src/webengine/doc/src/qtwebengine-devtools.qdoc b/src/webengine/doc/src/qtwebengine-devtools.qdoc
index 8d12e0eb0..ee87214e1 100644
--- a/src/webengine/doc/src/qtwebengine-devtools.qdoc
+++ b/src/webengine/doc/src/qtwebengine-devtools.qdoc
@@ -54,5 +54,5 @@
device.
For a detailed explanation of the capabilities of developer tools, see the
- \l{https://developers.google.com/web/tools/chrome-devtools}{Chrome DevTools page}.
+ \l {Chrome DevTools} page.
*/
diff --git a/src/webengine/doc/src/qtwebengine-overview.qdoc b/src/webengine/doc/src/qtwebengine-overview.qdoc
index 11d939cf8..15052f6e8 100644
--- a/src/webengine/doc/src/qtwebengine-overview.qdoc
+++ b/src/webengine/doc/src/qtwebengine-overview.qdoc
@@ -61,11 +61,11 @@
Qt WebEngine Widgets
\endlist
- The Qt WebEngine core is based on the \l{http://www.chromium.org}{Chromium Project}. Chromium
- provides its own network and painting engines and is developed tightly together with its
- dependent modules, and therefore Qt WebEngine provides better and more reliable support for the
- latest HTML5 specification than Qt WebKit. However, Qt WebEngine is thus heavier than Qt WebKit
- and does not provide direct access to the network stack and the HTML document through C++ APIs.
+ The Qt WebEngine core is based on the \l {Chromium Project}. Chromium provides its own network
+ and painting engines and is developed tightly together with its dependent modules, and
+ therefore Qt WebEngine provides better and more reliable support for the latest HTML5
+ specification than Qt WebKit. However, Qt WebEngine is thus heavier than Qt WebKit and does
+ not provide direct access to the network stack and the HTML document through C++ APIs.
Chromium is tightly integrated to the \l{Qt Quick Scene Graph}{Qt Quick scene graph}, which is
based on OpenGL ES 2.0 or OpenGL 2.0 for its rendering. This provides you with one-pass