aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/src/qtquick.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/quick/doc/src/qtquick.qdoc')
-rw-r--r--src/quick/doc/src/qtquick.qdoc34
1 files changed, 34 insertions, 0 deletions
diff --git a/src/quick/doc/src/qtquick.qdoc b/src/quick/doc/src/qtquick.qdoc
index da370d7828..49bd7c5ac1 100644
--- a/src/quick/doc/src/qtquick.qdoc
+++ b/src/quick/doc/src/qtquick.qdoc
@@ -49,6 +49,40 @@ For those new to QML and Qt Quick, please see
\l{QML Applications}
for an introduction to writing QML applications.
+\section1 Using the Module
+
+\section2 QML API
+
+The QML types in Qt Quick are available through the \c QtQuick import. To use the
+types, add the following import statement to your .qml file:
+
+\qml
+import QtQml
+\endqml
+
+\section2 C++ API
+
+Using the \l{Qt Quick C++ Classes}{C++ API} requires linking against the module
+library, either directly or through other dependencies. Several build tools
+have dedicated support for this, including \l{CMake Documentation}{CMake} and
+\l{qmake}.
+
+\section3 Building with CMake
+
+Use the \c find_package() command to locate the needed module components in the
+Qt6 package:
+
+\snippet code/doc_src_qtquick.cmake 0
+
+See also the \l{Build with CMake} overview.
+
+\section3 Building with qmake
+
+To configure the module for building with qmake, add the module as a value of
+the QT variable in the project's .pro file:
+
+\snippet code/doc_src_qtquick.pro 0
+
\section1 Important Concepts in Qt Quick
Qt Quick provides everything needed to create a rich application with a fluid