aboutsummaryrefslogtreecommitdiffstats
path: root/tests/manual/qmlextensionplugins/doc/src/qmlpluginex.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'tests/manual/qmlextensionplugins/doc/src/qmlpluginex.qdoc')
-rw-r--r--tests/manual/qmlextensionplugins/doc/src/qmlpluginex.qdoc43
1 files changed, 43 insertions, 0 deletions
diff --git a/tests/manual/qmlextensionplugins/doc/src/qmlpluginex.qdoc b/tests/manual/qmlextensionplugins/doc/src/qmlpluginex.qdoc
new file mode 100644
index 0000000000..80f39e36ce
--- /dev/null
+++ b/tests/manual/qmlextensionplugins/doc/src/qmlpluginex.qdoc
@@ -0,0 +1,43 @@
+// Copyright (C) 2021 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \title QML Plugin Example
+ \example qmlextensionplugins
+
+ \brief This example creates a C++ plugin extension by subclassing QQmlEngineExtensionPlugin.
+
+ \image qml-plugins-example.png
+
+ To run this example, use the following commands on the prompt:
+
+ \if defined(onlinedocs)
+ \tab {build-qt-app}{tab-cmake}{CMake}{checked}
+ \tab {build-qt-app}{tab-qmake}{qmake}{}
+ \tabcontent {tab-cmake}
+ \else
+ \section1 Using CMake
+ \endif
+ \badcode \QtVersion
+ cmake -DCMAKE_PREFIX_PATH=path/to/Qt/\1/your_platform -S <source-dir> -B <build-dir> -G Ninja
+ cd path/to/build/dir
+ ninja
+ qml -I imports plugins.qml
+ \endcode
+ For more information about building on the command line using CMake,
+ see \l {Building projects on the command line}.
+ \if defined(onlinedocs)
+ \endtabcontent
+ \tabcontent {tab-qmake}
+ \else
+ \section1 Using qmake
+ \endif
+ \badcode
+ qmake
+ make
+ qml -I imports plugins.qml
+ \endcode
+ \if defined(onlinedocs)
+ \endtabcontent
+ \endif
+*/