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/webenginewidgets/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/webenginewidgets/doc')
3 files changed, 18 insertions, 1 deletions
diff --git a/src/webenginewidgets/doc/snippets/qtwebenginewidgets_build_snippet.qdoc b/src/webenginewidgets/doc/snippets/qtwebenginewidgets_build_snippet.qdoc index 38366db17..f48932eae 100644 --- a/src/webenginewidgets/doc/snippets/qtwebenginewidgets_build_snippet.qdoc +++ b/src/webenginewidgets/doc/snippets/qtwebenginewidgets_build_snippet.qdoc @@ -33,3 +33,8 @@ QT += webenginewidgets //! [1] #include <QtWebEngineWidgets> //! [1] + +//! [2] +find_package(Qt6 COMPONENTS WebEngineWidgets REQUIRED) +target_link_libraries(target PRIVATE Qt::WebEngineWidgets) +//! [2] diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc index b93bc86f2..cc1a33464 100644 --- a/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc +++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc @@ -43,6 +43,11 @@ \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 + \section1 Articles and Guides \list diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc index 6f3eac5ad..a2775d641 100644 --- a/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc +++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc @@ -32,6 +32,7 @@ \ingroup modules \ingroup qtwebengine-modules \qtvariable webenginewidgets + \qtcmakepackage WebEngineWidgets The \QWEWidgets module provides a web browser engine as well as C++ classes to render and interact with web content. @@ -42,8 +43,14 @@ \snippet qtwebenginewidgets_build_snippet.qdoc 1 \if !defined(qtforpython) - To link against the module, add the following to your qmake project file: + To link against the module using build with qmake, + add the following QT variable to your qmake .pro file: \snippet qtwebenginewidgets_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 qtwebenginewidgets_build_snippet.qdoc 2 \endif */ |