diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2019-01-11 14:20:50 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2019-01-17 11:57:55 +0000 |
| commit | 161e4ec3af7d6c952f1a4b3c44ec6722dc1c0a18 (patch) | |
| tree | 7858e09d18c39b1776c19c396ec6772398713583 | |
| parent | 5f219dd53bb87da9e07a65177c9bdfb289f7d14e (diff) | |
Doc: Add info about using Qt WebView on the desktop
Fixes: QTBUG-72977
Change-Id: Ibc274cbcc5f5aa1e71673caff156627bf04b12ea
Reviewed-by: Christian Stromme <christian.stromme@qt.io>
| -rw-r--r-- | src/webview/doc/qtwebview.qdocconf | 2 | ||||
| -rw-r--r-- | src/webview/doc/src/qtwebview-overview.qdoc | 11 |
2 files changed, 8 insertions, 5 deletions
diff --git a/src/webview/doc/qtwebview.qdocconf b/src/webview/doc/qtwebview.qdocconf index 96cf19e..70da9a4 100644 --- a/src/webview/doc/qtwebview.qdocconf +++ b/src/webview/doc/qtwebview.qdocconf @@ -35,7 +35,7 @@ exampledirs += ../../../examples/webview imagedirs += images examplesinstallpath = webview -depends = qtcore qtdoc qtgui qtquick qtqml +depends = qtcore qtdoc qtgui qtquick qtqml qtwebengine Cpp.ignoretokens += Q_WEBVIEW_EXPORT diff --git a/src/webview/doc/src/qtwebview-overview.qdoc b/src/webview/doc/src/qtwebview-overview.qdoc index 067e4bd..195a0f5 100644 --- a/src/webview/doc/src/qtwebview-overview.qdoc +++ b/src/webview/doc/src/qtwebview-overview.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -31,7 +31,7 @@ \title Qt WebView \brief A light-weight web view. - Qt WebView provides a way to display web content in a QML application without + Qt \WebView provides a way to display web content in a QML application without necessarily including a full web browser stack by using native APIs where it makes sense. @@ -40,9 +40,12 @@ on iOS, where policy dictates that all web content is displayed using the operating system's web view. + On Windows, Linux, and \macos, Qt \WebView depends on the \l{Qt WebEngine} + module to render content. + \section1 Prerequisites - To make the Qt WebView module function correctly across all platforms, it's necessary + To make the Qt \WebView module function correctly across all platforms, it's necessary to call \l {qtwebview-initialize}{QtWebView::initialize}() right after creating the QGuiApplication instance. @@ -64,7 +67,7 @@ \section1 Licenses - Qt WebView is available under commercial licenses from \l{The Qt Company}. + Qt \WebView is available under commercial licenses from \l{The Qt Company}. In addition, it is available under the \l{GNU Lesser General Public License, version 3}, or the \l{GNU General Public License, version 2}. |