diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2023-01-31 09:34:31 +0100 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-02-02 19:04:41 +0000 |
| commit | a5d5028ba2f25c3d02e59af035e6142163a91bd4 (patch) | |
| tree | a7738ec1686488f24c276c4ca7aa64a39ac98481 | |
| parent | 4ef78d5bbf021ba0723f6cc14aba8ef65d3218c5 (diff) | |
| download | qttools-a5d5028ba2f25c3d02e59af035e6142163a91bd4.tar.gz | |
Qt Designer module: Fix documentation on how to link
Remove the misleading doc_src_qtdesigner.pro which wrongly sets
the CONFIG qmake and use the standard qdoc macros to generate the
correct information.
Add dependency to qtcmake to make linking to CMake manual work,
and fix the sourcedirs qdocconf variable not to override settings
from the documentation template.
Task-number: QTBUG-110447
Change-Id: I68f2fa2bed420fd2cef2fe780521d70d729fdd62
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
(cherry picked from commit 4dd01588e4f69cd5468618e788d8326e18d3d276)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
4 files changed, 14 insertions, 19 deletions
diff --git a/src/designer/src/designer/doc/qtdesigner.qdocconf b/src/designer/src/designer/doc/qtdesigner.qdocconf index 75c8c78dd..0a95732fd 100644 --- a/src/designer/src/designer/doc/qtdesigner.qdocconf +++ b/src/designer/src/designer/doc/qtdesigner.qdocconf @@ -27,11 +27,7 @@ qhp.QtDesigner.subprojects.classes.sortPages = true language = Cpp -headerdirs += .. \ - ../../../../uiplugin \ - ../../lib - -sourcedirs = .. \ +{headerdirs,sourcedirs} += .. \ ../../../../uiplugin \ ../../lib @@ -40,7 +36,7 @@ exampledirs = ../../../../../examples/designer \ imagedirs = images -depends += qtdoc qtgui qtwidgets qtcore qtuitools qtquick qmake +depends += qtdoc qtgui qtwidgets qtcore qtuitools qtquick qtcmake qmake navigation.landingpage = "Qt Designer Manual" navigation.cppclassespage = "Qt Designer C++ Classes" diff --git a/src/designer/src/designer/doc/snippets/plugins/doc_src_qtdesigner.pro b/src/designer/src/designer/doc/snippets/plugins/doc_src_qtdesigner.pro deleted file mode 100644 index 49db4f3e3..000000000 --- a/src/designer/src/designer/doc/snippets/plugins/doc_src_qtdesigner.pro +++ /dev/null @@ -1,6 +0,0 @@ -// Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -#! [1] -CONFIG += designer -#! [1] diff --git a/src/designer/src/designer/doc/src/qtdesigner-index.qdoc b/src/designer/src/designer/doc/src/qtdesigner-index.qdoc index f65b03e4e..c509d266e 100644 --- a/src/designer/src/designer/doc/src/qtdesigner-index.qdoc +++ b/src/designer/src/designer/doc/src/qtdesigner-index.qdoc @@ -17,11 +17,20 @@ that covers all steps of UI design and implementation for Qt Quick user interfaces. - \section1 Getting Started + \if !defined(qtforpython) - To link against the Qt Designer module, add this line to the project file: + \section1 Using the Module - \snippet plugins/doc_src_qtdesigner.pro 1 + \include {module-use.qdocinc} {using the c++ api} + + \section2 Building with CMake + + \include {module-use.qdocinc} {building with cmake} {Designer} + + \section2 Building with qmake + + \include {module-use.qdocinc} {building_with_qmake} {designer} + \endif \section1 Articles and Guides diff --git a/src/designer/src/designer/doc/src/qtdesigner-module.qdoc b/src/designer/src/designer/doc/src/qtdesigner-module.qdoc index 20c19c599..838bd9db4 100644 --- a/src/designer/src/designer/doc/src/qtdesigner-module.qdoc +++ b/src/designer/src/designer/doc/src/qtdesigner-module.qdoc @@ -13,10 +13,6 @@ In addition, the QFormBuilder class provides the possibility of constructing user interfaces from UI files at run-time. - - To link against the module, add this line to your \c qmake .pro file: - - \snippet plugins/doc_src_qtdesigner.pro 1 */ /*! |