diff options
Diffstat (limited to 'src/quick/doc/src/cmake-macros.qdoc')
-rw-r--r-- | src/quick/doc/src/cmake-macros.qdoc | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/src/quick/doc/src/cmake-macros.qdoc b/src/quick/doc/src/cmake-macros.qdoc new file mode 100644 index 0000000000..b643a9e4e4 --- /dev/null +++ b/src/quick/doc/src/cmake-macros.qdoc @@ -0,0 +1,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 + +*/ |