qiurui
/
qtdeclarative
mirror of https://github.com/qt/qtdeclarative.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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 d664cb4845)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Topi Reinio 2023-04-24 10:12:26 +00:00 committed by Qt Cherry-pick Bot
parent 1e407d1bb3
commit ee35560dac
3 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/qml/doc/src/cmake/qt_deploy_qml_imports.qdoc
View File

@ -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

2
src/qml/doc/src/cmake/qt_generate_deploy_qml_app_script.qdoc
View File

@ -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

2
src/qml/doc/src/includes/cmake-qml-qt-finalize-target-warning.qdocinc
View File

@ -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]