diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-11-30 11:41:51 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-12-01 09:06:44 +0000 |
| commit | e5a2a23d7ced6bc91075ba468870448acb4fe4ea (patch) | |
| tree | 2d8f361fc5e17f6b96ca12db3f297da4ea071ce9 | |
| parent | 281fa8329be7bcd66c181ac73d8f8d9c3dfe3fe9 (diff) | |
Doc: remove include and linking instructions from front page
Make sure that the instructions are visible on the linked page
for each module.
Change-Id: I47625bd8eb19ddf1f94e1bafb49f132216a0c069
Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>
| -rw-r--r-- | src/core/doc/src/qtwebenginecore-module.qdoc | 10 | ||||
| -rw-r--r-- | src/webengine/doc/src/qtwebengine-index.qdoc | 23 | ||||
| -rw-r--r-- | src/webengine/doc/src/qtwebengine-qmlmodule.qdoc | 7 |
3 files changed, 15 insertions, 25 deletions
diff --git a/src/core/doc/src/qtwebenginecore-module.qdoc b/src/core/doc/src/qtwebenginecore-module.qdoc index 750a0244e..d0224c834 100644 --- a/src/core/doc/src/qtwebenginecore-module.qdoc +++ b/src/core/doc/src/qtwebenginecore-module.qdoc @@ -39,6 +39,12 @@ \snippet qtwebenginecore_build_snippet.qdoc 1 If you use qmake to build your projects, Qt WebEngine Core is usually - indirectly included through the \l[QtWebEngine]{Qt WebEngine} or - \l[QtWebEngineWidgets]{Qt WebEngine Widgets} modules. + indirectly included through the \l{Qt WebEngine QML Types}{Qt WebEngine} or + \l{Qt WebEngine Widgets C++ Classes}{Qt WebEngine Widgets} modules. + + To link against the module, add this line to your qmake project file: + + \snippet qtwebenginecore_build_snippet.qdoc 0 + + However, \c webenginecore is implied by adding \c webengine or \c webenginewidgets. */ diff --git a/src/webengine/doc/src/qtwebengine-index.qdoc b/src/webengine/doc/src/qtwebengine-index.qdoc index 671425e75..e30976ef3 100644 --- a/src/webengine/doc/src/qtwebengine-index.qdoc +++ b/src/webengine/doc/src/qtwebengine-index.qdoc @@ -42,29 +42,6 @@ \annotatedlist qtwebengine-qmlmodules - \section1 Getting Started - - To include the definitions of the Qt WebEngineCore and Qt WebEngineWidgets modules' classes, use - the following directives: - - \badcode - #include <QtWebEngineCore> - #include <QtWebEngineWidgets> - \endcode - - To import the Qt WebEngine module's QML types, add the following import statement to your .qml - file: - - \badcode - import QtWebEngine 1.2 - \endcode - - To link against the modules, add QT variables to your qmake .pro file: - - \badcode - QT += webengine webenginecore webenginewidgets - \endcode - \section1 Articles and Guides \list diff --git a/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc b/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc index e098071b3..90c17f89b 100644 --- a/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc +++ b/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc @@ -36,4 +36,11 @@ import QtQuick 2.0 import QtWebEngine 1.1 \endcode + + To link against the module, add the following QT variable to your qmake .pro + file: + + \badcode + QT += webengine + \endcode */ |