diff options
author | Kai Köhne <kai.koehne@qt.io> | 2022-09-02 10:36:18 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-09-02 11:22:10 +0000 |
commit | fb25c98e9bca5fa5ffc6a979df46b8960a85b384 (patch) | |
tree | a39e634b379e2b46e0237009f688c1ece83431ff | |
parent | 5179730a0b9f69462a12fbf8f4ec2e561712d0ad (diff) |
Doc: Do not advertise global module includes
As one comment already says: We don't advise them anymore. Then
let's not advertise them.
Change-Id: Ided3a4b1c98d5d240dfc69c1df05ede4f38be227
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
(cherry picked from commit b52f792019e3f1e101edef07156c1eaf4a0ba220)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
7 files changed, 0 insertions, 48 deletions
diff --git a/src/multimedia/doc/snippets/doc_src_qtmultimedia.cpp b/src/multimedia/doc/snippets/doc_src_qtmultimedia.cpp deleted file mode 100644 index 1028d7611..000000000 --- a/src/multimedia/doc/snippets/doc_src_qtmultimedia.cpp +++ /dev/null @@ -1,6 +0,0 @@ -// Copyright (C) 2018 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -//! [0] -#include <QtMultimedia> -//! [0] diff --git a/src/multimedia/doc/src/qtmultimedia-cpp.qdoc b/src/multimedia/doc/src/qtmultimedia-cpp.qdoc index 5c9f4aa56..e5958912b 100644 --- a/src/multimedia/doc/src/qtmultimedia-cpp.qdoc +++ b/src/multimedia/doc/src/qtmultimedia-cpp.qdoc @@ -11,11 +11,6 @@ \brief The \l {Qt Multimedia} module provides audio, video and camera functionality. - To enable Qt Multimedia in a project, add this directive into your - C++ files: - - \snippet doc_src_qtmultimedia.cpp 0 - \include module-use.qdocinc using qt module \code find_package(Qt6 REQUIRED COMPONENTS Multimedia) diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc index c6180204b..ea159b3c1 100644 --- a/src/multimedia/doc/src/qtmultimedia-index.qdoc +++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc @@ -36,17 +36,6 @@ import QtMultimedia \endqml - If you want to use the C++ classes in your application, include the C++ - definitions using the following directive: - - \code - #include <QtMultimedia> - #include <QtMultimediaWidgets> - \endcode - - \note If you are using a few classes from this module, we recommend - including those specific classes only instead of the module. - To link against the C++ libraries, add the following to your project's \c CMakeLists.txt file. Substitute \c my_project with the name of your project. diff --git a/src/multimediawidgets/doc/snippets/doc_src_qtmultimediawidgets.cpp b/src/multimediawidgets/doc/snippets/doc_src_qtmultimediawidgets.cpp deleted file mode 100644 index 1bfec525f..000000000 --- a/src/multimediawidgets/doc/snippets/doc_src_qtmultimediawidgets.cpp +++ /dev/null @@ -1,6 +0,0 @@ -// Copyright (C) 2018 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -//! [0] -#include <QtMultimediaWidgets> -//! [0] diff --git a/src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc b/src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc index 1c912c8e3..18e6d8deb 100644 --- a/src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc +++ b/src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc @@ -12,12 +12,6 @@ controls. The classes expand the capabilities of the \l{Qt Multimedia} and \section1 Getting Started -To enable Qt Multimedia Widgets in a project, add this directive into the -C++ files: -\code -#include <QtMultimediaWidgets> -\endcode - To link against the C++ libraries, add the following to your project's \c CMakeLists.txt file. Substitute \c my_project with the name of your project. diff --git a/src/spatialaudio/doc/src/qtspatialaudio-cpp.qdoc b/src/spatialaudio/doc/src/qtspatialaudio-cpp.qdoc index 558665e3a..aff743e82 100644 --- a/src/spatialaudio/doc/src/qtspatialaudio-cpp.qdoc +++ b/src/spatialaudio/doc/src/qtspatialaudio-cpp.qdoc @@ -10,13 +10,6 @@ \brief The \l {Qt Spatial Audio} module provides functionality for 3D audio. - To enable Qt Spatial Audio in a project, add this directive into your - C++ files: - - \code - #include <QtSpatialAudio> - \endcode - \include module-use.qdocinc using qt module \code diff --git a/src/spatialaudio/doc/src/qtspatialaudio-index.qdoc b/src/spatialaudio/doc/src/qtspatialaudio-index.qdoc index 7be5aaabb..e6be0247e 100644 --- a/src/spatialaudio/doc/src/qtspatialaudio-index.qdoc +++ b/src/spatialaudio/doc/src/qtspatialaudio-index.qdoc @@ -22,13 +22,6 @@ import QtQuick3D.SpatialAudio \endqml - If you want to use the C++ classes in your application, include the C++ - definitions using the following directive: - - \code - #include <QtSpatialAudio> - \endcode - To link against the C++ libraries, add the following to your project's \c CMakeLists.txt file. Substitute \c my_project with the name of your project. |