aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/src/cmake-macros.qdoc
blob: b643a9e4e40a343234cdb856a64fb52d32873f9c (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
48
49
50
51
52
53
54
55
56
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page qtqml-cmake-qt5-import-qml-plugins.html
\ingroup cmake-macros-qtqml

\title qt5_import_qml_plugins

\brief Scans \c{.qml} files and imports required QML static plugins

\section1 Overview

\badcode
find_package(Qt5QmlImportScanner REQUIRED)
qt5_import_qml_plugins(<TARGET>)
\endcode

\section1 Description

Runs \c{qmlimportscanner} at configure time to find the static QML plugins
used and links them to the given target.

\note When used with a non-static Qt build, this function does nothing.

This CMake command was introduced in Qt 5.14.

\section1 Example

\snippet cmake-macros/examples.cmake qt5_import_qml_plugins

*/