diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-04-24 10:06:14 +0000 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2023-04-25 15:03:03 +0200 |
| commit | 4fc3f0c159dac617e9e32367127332de19a84026 (patch) | |
| tree | 4b25ff90444f976e998ac12138e3da0ab84f73b3 | |
| parent | e1818d9e9c7e9ce6b5857054926a5f7c7f44e0d9 (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.
Pick-to: 6.5
Fixes: QTBUG-113138
Change-Id: Ie3fe2fede1e81d08201ec4353352ef069aebc388
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
3 files changed, 4 insertions, 2 deletions
diff --git a/src/corelib/doc/src/cmake/qt_add_executable.qdoc b/src/corelib/doc/src/cmake/qt_add_executable.qdoc index 97f415f6c4..cc8c924c79 100644 --- a/src/corelib/doc/src/cmake/qt_add_executable.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_executable.qdoc @@ -110,5 +110,5 @@ for finalizing the target by adding the \c{MANUAL_FINALIZATION} keyword. \snippet cmake-macros/examples.cmake qt_add_executable_deferred -\include cmake-android-qt-finalize-project-warning.qdocinc +\include cmake-android-qt-finalize-project-warning.qdocinc warning */ diff --git a/src/corelib/doc/src/cmake/qt_finalize_project.qdoc b/src/corelib/doc/src/cmake/qt_finalize_project.qdoc index 9beb427050..5506712691 100644 --- a/src/corelib/doc/src/cmake/qt_finalize_project.qdoc +++ b/src/corelib/doc/src/cmake/qt_finalize_project.qdoc @@ -38,7 +38,7 @@ With CMake version 3.19 or later, you don't need to call this command since it consists of sub-commands that are ordinarily invoked at the end of \c CMAKE_SOURCE_DIR directory scope processing. -\include cmake-android-qt-finalize-project-warning.qdocinc +\include cmake-android-qt-finalize-project-warning.qdocinc warning \section2 Examples diff --git a/src/corelib/doc/src/includes/cmake-android-qt-finalize-project-warning.qdocinc b/src/corelib/doc/src/includes/cmake-android-qt-finalize-project-warning.qdocinc index 3f2a4ab6ec..47133f6d10 100644 --- a/src/corelib/doc/src/includes/cmake-android-qt-finalize-project-warning.qdocinc +++ b/src/corelib/doc/src/includes/cmake-android-qt-finalize-project-warning.qdocinc @@ -1,6 +1,8 @@ // Copyright (C) 2020 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only +//! [warning] \warning If your \e Android project is built using a CMake version lower than 3.19, make sure that you call \l{qt_finalize_project}{qt6_finalize_project()} at the end of a top-level CMakeLists.txt. +//! [warning] |