diff options
| author | Kai Köhne <kai.koehne@qt.io> | 2022-06-29 09:20:22 +0200 |
|---|---|---|
| committer | Kai Köhne <kai.koehne@qt.io> | 2022-07-21 16:42:28 +0200 |
| commit | ea3365ef1f9338cf534e8840a2d1f1c5a23c03c0 (patch) | |
| tree | 78924899f757b6639fb30574e535d6f9828b5234 /src/assistant | |
| parent | 77f1ecaf781895e0eba8a399f2615a864b59eeaa (diff) | |
| download | qttools-ea3365ef1f9338cf534e8840a2d1f1c5a23c03c0.tar.gz | |
Doc: Do not advertise Qt module include
People should rather use class includes, like they are advertised
in each class documentation.
Pick-to: 6.4
Change-Id: Ic0d24553432a02212feb63e25eb8695a374604fc
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/assistant')
| -rw-r--r-- | src/assistant/help/doc/snippets/doc_src_qthelp.cpp | 4 | ||||
| -rw-r--r-- | src/assistant/help/doc/src/qthelp-index.qdoc | 4 | ||||
| -rw-r--r-- | src/assistant/help/doc/src/qthelp-module.qdoc | 5 |
3 files changed, 0 insertions, 13 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: |