summaryrefslogtreecommitdiffstats
path: root/src/corelib/doc/src/cmake/qt_finalize_project.qdoc
blob: dc63e66cd6375cb81fc68f6c5023709b6484c065 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
\page qt_finalize_project.html
\ingroup cmake-commands-qtcore

\title qt_finalize_project
\target qt6_finalize_project

\summary {Handles various common platform-specific tasks associated with Qt project.}
\preliminarycmakecommand

\include cmake-find-package-core.qdocinc

\cmakecommandsince 6.3

\section1 Synopsis

\badcode
qt_finalize_project()
\endcode

\versionlessCMakeCommandsNote qt6_finalize_project()

\section1 Description

Some targets that are created using Qt commands require additional actions
at the end of CMake configuring phase. Depending on the platform the function
typically walks through the build tree, resolves dependencies between targets
created by the user, and applies extra deployment steps.

With CMake versions 3.19 and higher, 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 scope.

\include cmake-android-qt-finalize-project-warning.cmake

\section2 Examples

For projects that use a CMake version lower than 3.19, you need to call
\c qt_finalize_project manually. This example shows the typical use of the
function:

\snippet cmake-macros/examples.cmake qt_finalize_project_manual

*/