diff options
author | Kai Köhne <kai.koehne@qt.io> | 2022-06-29 09:29:42 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-07-08 12:59:28 +0000 |
commit | 090b9928a52e8783a5fc459b70a2c23eb394b1f4 (patch) | |
tree | f8258a0a59515b41e079db61fc88e6480b69167b /src | |
parent | 78c7d2ad40b8540dc303d8103eed78f38a3c1d9c (diff) |
Doc: Do not advertise Qt module include
People should rather use class includes, like they are advertised
in each class documentation.
Change-Id: I3fc26c2ff01e35595959878c392dcafa2527d29f
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
(cherry picked from commit bcb415e9bab692479a8d4554d2f9b6aff3857ae7)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src')
12 files changed, 0 insertions, 60 deletions
diff --git a/src/core/doc/snippets/qtwebenginecore_build_snippet.qdoc b/src/core/doc/snippets/qtwebenginecore_build_snippet.qdoc index eb4da08bd..ee22ea774 100644 --- a/src/core/doc/snippets/qtwebenginecore_build_snippet.qdoc +++ b/src/core/doc/snippets/qtwebenginecore_build_snippet.qdoc @@ -5,11 +5,6 @@ QT += webenginecore //! [0] - -//! [1] -#include <QtWebEngineCore> -//! [1] - //! [2] find_package(Qt6 REQUIRED COMPONENTS WebEngineCore) target_link_libraries(target PRIVATE Qt::WebEngineCore) diff --git a/src/core/doc/src/qtwebenginecore-index.qdoc b/src/core/doc/src/qtwebenginecore-index.qdoc index 73a6b4ead..cd6f2efe4 100644 --- a/src/core/doc/src/qtwebenginecore-index.qdoc +++ b/src/core/doc/src/qtwebenginecore-index.qdoc @@ -11,11 +11,6 @@ \section1 Getting Started - To include the definitions of the module's classes, use the - following directive: - - \snippet qtwebenginecore_build_snippet.qdoc 1 - To link against the module, add this line to your qmake project file: \snippet qtwebenginecore_build_snippet.qdoc 0 diff --git a/src/core/doc/src/qtwebenginecore-module.qdoc b/src/core/doc/src/qtwebenginecore-module.qdoc index 2cb321e07..188609793 100644 --- a/src/core/doc/src/qtwebenginecore-module.qdoc +++ b/src/core/doc/src/qtwebenginecore-module.qdoc @@ -12,11 +12,6 @@ \qtvariable webenginecore \qtcmakepackage WebEngineCore - To include the definitions of the module's classes, use the - following directive: - - \snippet qtwebenginecore_build_snippet.qdoc 1 - If you use qmake to build your projects, \QWE Core is usually indirectly included through the \l{Qt WebEngine QML Types}{Qt WebEngine Quick} or \l{Qt WebEngine Widgets C++ Classes}{Qt WebEngine Widgets} modules. diff --git a/src/pdf/doc/snippets/qtpdf_build_snippet.qdoc b/src/pdf/doc/snippets/qtpdf_build_snippet.qdoc index 4be08b5a7..7d30ccdfd 100644 --- a/src/pdf/doc/snippets/qtpdf_build_snippet.qdoc +++ b/src/pdf/doc/snippets/qtpdf_build_snippet.qdoc @@ -4,8 +4,3 @@ //! [0] QT += pdf //! [0] - - -//! [1] -#include <QtPdf> -//! [1] diff --git a/src/pdf/doc/src/qtpdf-index.qdoc b/src/pdf/doc/src/qtpdf-index.qdoc index 1e37565f5..07c151f47 100644 --- a/src/pdf/doc/src/qtpdf-index.qdoc +++ b/src/pdf/doc/src/qtpdf-index.qdoc @@ -48,11 +48,6 @@ \section2 Building with qmake - To include the definitions of the module's classes, use the - following directive: - - \snippet qtpdf_build_snippet.qdoc 1 - To link against the module, add this line to your qmake project file: \snippet qtpdf_build_snippet.qdoc 0 diff --git a/src/pdf/doc/src/qtpdf-module.qdoc b/src/pdf/doc/src/qtpdf-module.qdoc index 6fe1bbcac..e2ca8e4ce 100644 --- a/src/pdf/doc/src/qtpdf-module.qdoc +++ b/src/pdf/doc/src/qtpdf-module.qdoc @@ -13,11 +13,6 @@ The Qt PDF module contains classes and functions for rendering PDF documents. - To include the definitions of the module's classes, use the - following directive: - - \snippet qtpdf_build_snippet.qdoc 1 - \if !defined(qtforpython) To link against the module, add this line to your qmake project file: diff --git a/src/webenginequick/doc/snippets/qtwebengine_build_snippet.qdoc b/src/webenginequick/doc/snippets/qtwebengine_build_snippet.qdoc index d1e230db1..76dea97cf 100644 --- a/src/webenginequick/doc/snippets/qtwebengine_build_snippet.qdoc +++ b/src/webenginequick/doc/snippets/qtwebengine_build_snippet.qdoc @@ -5,11 +5,6 @@ QT += webenginequick //! [0] - -//! [1] -#include <QtWebEngineQuick> -//! [1] - //! [2] find_package(Qt6 REQUIRED COMPONENTS WebEngineQuick) target_link_libraries(target PRIVATE Qt::WebEngineQuick) diff --git a/src/webenginequick/doc/src/qtwebengine-module.qdoc b/src/webenginequick/doc/src/qtwebengine-module.qdoc index 21d8b4749..6f50cc2f4 100644 --- a/src/webenginequick/doc/src/qtwebengine-module.qdoc +++ b/src/webenginequick/doc/src/qtwebengine-module.qdoc @@ -12,11 +12,6 @@ The \QWE Quick module exposes C++ functionality to Qt Quick. - To include the definitions of the module's classes, use the - following directive: - - \snippet qtwebengine_build_snippet.qdoc 1 - \if !defined(qtforpython) To link against the module, add the following to your qmake project file: diff --git a/src/webenginequick/doc/src/qtwebengine-qmlmodule.qdoc b/src/webenginequick/doc/src/qtwebengine-qmlmodule.qdoc index 7899fad56..19348508c 100644 --- a/src/webenginequick/doc/src/qtwebengine-qmlmodule.qdoc +++ b/src/webenginequick/doc/src/qtwebengine-qmlmodule.qdoc @@ -8,11 +8,6 @@ \ingroup qtwebengine-modules \ingroup qmlmodules - The QML types can be imported into your application using the following import statements in - your .qml file: - - \snippet qtwebengine_build_snippet.qdoc 1 - To link against the module using build with qmake, add the following QT variable to your qmake .pro file: diff --git a/src/webenginewidgets/doc/snippets/qtwebenginewidgets_build_snippet.qdoc b/src/webenginewidgets/doc/snippets/qtwebenginewidgets_build_snippet.qdoc index e732bbeed..4ab54a2ba 100644 --- a/src/webenginewidgets/doc/snippets/qtwebenginewidgets_build_snippet.qdoc +++ b/src/webenginewidgets/doc/snippets/qtwebenginewidgets_build_snippet.qdoc @@ -5,11 +5,6 @@ QT += webenginewidgets //! [0] - -//! [1] -#include <QtWebEngineWidgets> -//! [1] - //! [2] find_package(Qt6 REQUIRED COMPONENTS WebEngineWidgets) target_link_libraries(target PRIVATE Qt::WebEngineWidgets) diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc index a80400c60..8eb28b797 100644 --- a/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc +++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc @@ -10,11 +10,6 @@ \section1 Getting Started - To include the definitions of the module's classes, use the - following directive: - - \snippet qtwebenginewidgets_build_snippet.qdoc 1 - To link against the module, add this line to your qmake project file: \snippet qtwebenginewidgets_build_snippet.qdoc 0 diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc index b88d7af36..df06909df 100644 --- a/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc +++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc @@ -13,11 +13,6 @@ The \QWE Widgets module provides a web browser engine as well as C++ classes to render and interact with web content. - To include the definitions of the module's classes, use the - following directive: - - \snippet qtwebenginewidgets_build_snippet.qdoc 1 - \if !defined(qtforpython) To link against the module using build with qmake, add the following QT variable to your qmake .pro file: |