diff options
author | Kai Köhne <kai.koehne@qt.io> | 2022-06-29 09:20:22 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-07-21 15:14:12 +0000 |
commit | 3b151e462c7adf4d5d3b0bf577fbc045a165c5f5 (patch) | |
tree | e952740c3a0893718947452d190369af8a5d8457 | |
parent | f5f385bb6df32881a1010f7ec1077fdd6d97b5e6 (diff) |
Doc: Do not advertise Qt module include
People should rather use class includes, like they are advertised
in each class documentation.
Change-Id: Ic0d24553432a02212feb63e25eb8695a374604fc
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit ea3365ef1f9338cf534e8840a2d1f1c5a23c03c0)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
8 files changed, 0 insertions, 39 deletions
diff --git a/src/assistant/help/doc/snippets/doc_src_qthelp.cpp b/src/assistant/help/doc/snippets/doc_src_qthelp.cpp index 563e1a381..7498c22f3 100644 --- a/src/assistant/help/doc/snippets/doc_src_qthelp.cpp +++ b/src/assistant/help/doc/snippets/doc_src_qthelp.cpp @@ -1,10 +1,6 @@ // Copyright (C) 2016 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause -//! [0] -#include <QtHelp> -//! [0] - //! [6] QHelpEngineCore helpEngine("mycollection.qhc"); ... diff --git a/src/assistant/help/doc/src/qthelp-index.qdoc b/src/assistant/help/doc/src/qthelp-index.qdoc index 55f3a3fc4..f97ed415a 100644 --- a/src/assistant/help/doc/src/qthelp-index.qdoc +++ b/src/assistant/help/doc/src/qthelp-index.qdoc @@ -10,10 +10,6 @@ \section1 Getting Started - To use Qt Help classes, add this directive into the C++ files: - - \snippet doc_src_qthelp.cpp 0 - To link against the Qt Help module, add this line to the project file: \snippet doc_src_qthelp.qdoc 1 diff --git a/src/assistant/help/doc/src/qthelp-module.qdoc b/src/assistant/help/doc/src/qthelp-module.qdoc index d4e4349cb..3308b95b8 100644 --- a/src/assistant/help/doc/src/qthelp-module.qdoc +++ b/src/assistant/help/doc/src/qthelp-module.qdoc @@ -15,11 +15,6 @@ online help and documentation in their applications are described in more detail in \l{The Qt Help Framework} overview document. - To include the definitions of the module's classes, use the - following directive: - - \snippet doc_src_qthelp.cpp 0 - To link against the module, add this line to your \l qmake \c .pro file: diff --git a/src/designer/src/designer/doc/snippets/plugins/doc_src_qtdesigner.cpp b/src/designer/src/designer/doc/snippets/plugins/doc_src_qtdesigner.cpp index 3516bfcc9..9cb08e027 100644 --- a/src/designer/src/designer/doc/snippets/plugins/doc_src_qtdesigner.cpp +++ b/src/designer/src/designer/doc/snippets/plugins/doc_src_qtdesigner.cpp @@ -1,11 +1,6 @@ // Copyright (C) 2016 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause -//! [0] -#include <QtDesigner> -//! [0] - - //! [2] QDesignerMemberSheetExtension *memberSheet = nullptr; QExtensionManager manager = formEditor->extensionManager(); diff --git a/src/designer/src/designer/doc/src/qtdesigner-index.qdoc b/src/designer/src/designer/doc/src/qtdesigner-index.qdoc index bd0a07837..f65b03e4e 100644 --- a/src/designer/src/designer/doc/src/qtdesigner-index.qdoc +++ b/src/designer/src/designer/doc/src/qtdesigner-index.qdoc @@ -19,10 +19,6 @@ \section1 Getting Started - To use Qt Designer classes, add this directive into the C++ files: - - \snippet plugins/doc_src_qtdesigner.cpp 0 - To link against the Qt Designer module, add this line to the project file: \snippet plugins/doc_src_qtdesigner.pro 1 diff --git a/src/designer/src/designer/doc/src/qtdesigner-module.qdoc b/src/designer/src/designer/doc/src/qtdesigner-module.qdoc index 2adfad679..20c19c599 100644 --- a/src/designer/src/designer/doc/src/qtdesigner-module.qdoc +++ b/src/designer/src/designer/doc/src/qtdesigner-module.qdoc @@ -14,11 +14,6 @@ In addition, the QFormBuilder class provides the possibility of constructing user interfaces from UI files at run-time. - To include the definitions of the module classes, use the following - directive: - - \snippet plugins/doc_src_qtdesigner.cpp 0 - To link against the module, add this line to your \c qmake .pro file: \snippet plugins/doc_src_qtdesigner.pro 1 diff --git a/src/uitools/doc/snippets/quiloader/doc_src_qtuiloader.cpp b/src/uitools/doc/snippets/quiloader/doc_src_qtuiloader.cpp deleted file mode 100644 index 16ee00e76..000000000 --- a/src/uitools/doc/snippets/quiloader/doc_src_qtuiloader.cpp +++ /dev/null @@ -1,6 +0,0 @@ -// Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -//! [1] -#include <QtUiTools> -//! [1] diff --git a/src/uitools/doc/src/qtuitools-module.qdoc b/src/uitools/doc/src/qtuitools-module.qdoc index b545fc52e..7a3357459 100644 --- a/src/uitools/doc/src/qtuitools-module.qdoc +++ b/src/uitools/doc/src/qtuitools-module.qdoc @@ -29,10 +29,4 @@ used to obtain a form stored in a project's resources. The QUiLoader::load() function takes the user interface description contained in the file and constructs the form widget. - - To include the definitions of the module's classes, use the following - directive: - - \snippet quiloader/doc_src_qtuiloader.cpp 1 - */ |