Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qtqml-tooling-qmlcontextpropertydump.qdoc
Go to the documentation of this file.
1// Copyright (C) 2025 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
3
4/*!
5\page qtqml-tooling-qmlcontextpropertydump.html
6\title qmlcontextpropertydump
7\brief A tool that searches for context property definitions in C++ code.
8\ingroup qtqml-tooling
9\ingroup qtqml-tooling-devtools
10
11\e qmlcontextpropertydump scans a C++ source folder for potential
12context property definitions, and stores them in a format readable by \l qmllint
13and \l {\QMLLS}.
14
15\e qmlcontextpropertydump is best used via the \l{qmllint-auto}{CMake API}: \l qt_add_qml_module
16creates a global \c dump_qml_context_properties target that invokes \c qmlcontextpropertydump with
17the right arguments. Note that \c dump_qml_context_properties does nothing when a
18dump file already exists. Use the \c clean_qml_context_properties target to delete the
19context property dump. The context property dump file is located in the build folder at
20\c{<build>/.qt/contextPropertyDump.ini}.
21*/