diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-04-24 10:12:26 +0000 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-04-25 17:39:07 +0000 |
| commit | ee35560dacedfb0264ccdf1c5d4863a6a791e8bb (patch) | |
| tree | 5e76ebc1fa8697bfeb8f593f01e47f90e33ed114 | |
| parent | 1e407d1bb30ac8c8753cdf5b3624d4bcff9bd991 (diff) | |
Doc: Exclude licensing header when including a .qdocinc
The \include command includes the source in its entirety when the
second parameter is omitted. This pulled in also the license header
which was visible in the generated documentation.
Add snippet tags and use them to extract only the content we need.
Task-number: QTBUG-113138
Change-Id: Ie3fe2fede1e81d08201ec4353352ef069aebc388
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
(cherry picked from commit d664cb4845f8b5c79ce34bb963312b18cce7452f)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
3 files changed, 4 insertions, 2 deletions
diff --git a/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc b/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc index e4ad8a29f0..68c2735f51 100644 --- a/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc +++ b/src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc @@ -16,7 +16,7 @@ Unlike most other CMake commands provided by Qt, \c{qt6_deploy_qml_imports}{qt_deploy_qml_imports()} can only be called from a deployment script. It cannot be called directly by the project. -\include cmake-qml-qt-finalize-target-warning.qdocinc +\include cmake-qml-qt-finalize-target-warning.qdocinc warning \section1 Synopsis diff --git a/src/qml/doc/src/cmake/qt_generate_deploy_qml_app_script.qdoc b/src/qml/doc/src/cmake/qt_generate_deploy_qml_app_script.qdoc index 0fd03a8c93..54fe977873 100644 --- a/src/qml/doc/src/cmake/qt_generate_deploy_qml_app_script.qdoc +++ b/src/qml/doc/src/cmake/qt_generate_deploy_qml_app_script.qdoc @@ -14,7 +14,7 @@ \cmakecommandsince 6.3 -\include cmake-qml-qt-finalize-target-warning.qdocinc +\include cmake-qml-qt-finalize-target-warning.qdocinc warning \section1 Synopsis diff --git a/src/qml/doc/src/includes/cmake-qml-qt-finalize-target-warning.qdocinc b/src/qml/doc/src/includes/cmake-qml-qt-finalize-target-warning.qdocinc index 9152726398..0125a1c4c2 100644 --- a/src/qml/doc/src/includes/cmake-qml-qt-finalize-target-warning.qdocinc +++ b/src/qml/doc/src/includes/cmake-qml-qt-finalize-target-warning.qdocinc @@ -1,7 +1,9 @@ // Copyright (C) 2022 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only +//! [warning] \warning If you are using a CMake version lower than 3.19, make sure that you pass the \c MANUAL_FINALIZATION option to \l{qt_add_executable}{qt6_add_executable()}, and then call \l{qt_finalize_target}{qt6_finalize_target()} before calling this function. +//! [warning] |