diff options
| author | Kirill Burtsev <kirill.burtsev@qt.io> | 2021-08-16 14:19:36 +0200 |
|---|---|---|
| committer | Kirill Burtsev <kirill.burtsev@qt.io> | 2021-08-17 17:38:55 +0200 |
| commit | e3cc8e0283daa989ca6957a7100c2c11669f5d1f (patch) | |
| tree | 9679e001b30837a9bf6a30226a41a9d28856b61c /src/webenginequick/doc | |
| parent | 79d04aa9e3e9aa84d7378260519f9e9a6759dc41 (diff) | |
Update documentation notes for build with WebEngine modules
Add cmake usage snippets for module's libraries. Remove quick version
from code snippets. Fix minor documentation warnings.
Fixes: QTBUG-94937
Pick-to: 6.2
Change-Id: I2e5c8616ceeab495f604e135bb2aa2261c50c68d
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'src/webenginequick/doc')
4 files changed, 30 insertions, 16 deletions
diff --git a/src/webenginequick/doc/snippets/qtwebengine_build_snippet.qdoc b/src/webenginequick/doc/snippets/qtwebengine_build_snippet.qdoc index 35bc480bb..b21efbdf9 100644 --- a/src/webenginequick/doc/snippets/qtwebengine_build_snippet.qdoc +++ b/src/webenginequick/doc/snippets/qtwebengine_build_snippet.qdoc @@ -26,10 +26,15 @@ ****************************************************************************/ //! [0] -QT += webengine +QT += webenginequick //! [0] //! [1] -#include <QtWebEngine> +#include <QtWebEngineQuick> //! [1] + +//! [2] +find_package(Qt6 COMPONENTS WebEngineQuick REQUIRED) +target_link_libraries(target PRIVATE Qt::WebEngineQuick) +//! [2] diff --git a/src/webenginequick/doc/snippets/qtwebengine_webengineview_newviewrequested.qml b/src/webenginequick/doc/snippets/qtwebengine_webengineview_newviewrequested.qml index 0835c5246..70afea2b9 100644 --- a/src/webenginequick/doc/snippets/qtwebengine_webengineview_newviewrequested.qml +++ b/src/webenginequick/doc/snippets/qtwebengine_webengineview_newviewrequested.qml @@ -48,9 +48,9 @@ ** ****************************************************************************/ -import QtQuick 2.0 -import QtQuick.Window 2.1 -import QtWebEngine 2.0 +import QtQuick +import QtQuick.Window +import QtWebEngine //! [0] QtObject { diff --git a/src/webenginequick/doc/src/qtwebengine-module.qdoc b/src/webenginequick/doc/src/qtwebengine-module.qdoc index 5554bd519..ab6fc49ca 100644 --- a/src/webenginequick/doc/src/qtwebengine-module.qdoc +++ b/src/webenginequick/doc/src/qtwebengine-module.qdoc @@ -26,10 +26,13 @@ ****************************************************************************/ /*! - \module QtWebEngine - \title Qt WebEngine C++ Classes + \module QtWebEngineQuick + \title Qt WebEngine Quick C++ Classes \brief Exposes C++ functionality to Qt Quick. \ingroup modules + \ingroup qtwebengine-modules + \qtvariable webenginequick + \qtcmakepackage WebEngineQuick The \QWE module exposes C++ functionality to Qt Quick. @@ -42,5 +45,10 @@ To link against the module, add the following to your qmake project file: \snippet qtwebengine_build_snippet.qdoc 0 + + For build with CMake use the \c find_package() command to locate the needed module components + in the Qt6 package and \c target_link_libraries() to link against the module: + + \snippet qtwebengine_build_snippet.qdoc 2 \endif */ diff --git a/src/webenginequick/doc/src/qtwebengine-qmlmodule.qdoc b/src/webenginequick/doc/src/qtwebengine-qmlmodule.qdoc index 4fd7e3a3b..ac1fff80b 100644 --- a/src/webenginequick/doc/src/qtwebengine-qmlmodule.qdoc +++ b/src/webenginequick/doc/src/qtwebengine-qmlmodule.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \qmlmodule QtWebEngine 1.10 + \qmlmodule QtWebEngine \title Qt WebEngine QML Types \brief Provides QML types for rendering web content within a QML application. \ingroup qtwebengine-modules @@ -35,14 +35,15 @@ The QML types can be imported into your application using the following import statements in your .qml file: - \qml - import QtWebEngine 1.10 - \endqml + \snippet qtwebengine_build_snippet.qdoc 1 - To link against the module, add the following QT variable to your qmake .pro - file: + To link against the module using build with qmake, + add the following QT variable to your qmake .pro file: - \badcode - QT += webengine - \endcode + \snippet qtwebengine_build_snippet.qdoc 0 + + For build with CMake use the \c find_package() command to locate the needed module components + in the Qt6 package and \c target_link_libraries() to link against the module: + + \snippet qtwebengine_build_snippet.qdoc 2 */ |