summaryrefslogtreecommitdiffstats
path: root/src/webenginequick/doc/src/qtwebengine-module.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/webenginequick/doc/src/qtwebengine-module.qdoc')
-rw-r--r--src/webenginequick/doc/src/qtwebengine-module.qdoc25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/webenginequick/doc/src/qtwebengine-module.qdoc b/src/webenginequick/doc/src/qtwebengine-module.qdoc
new file mode 100644
index 000000000..6f50cc2f4
--- /dev/null
+++ b/src/webenginequick/doc/src/qtwebengine-module.qdoc
@@ -0,0 +1,25 @@
+// Copyright (C) 2016 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \module QtWebEngineQuick
+ \title Qt WebEngine Quick C++ Classes
+ \brief Exposes C++ functionality to Qt Quick.
+ \ingroup modules
+ \ingroup qtwebengine-modules
+ \qtvariable webenginequick
+ \qtcmakepackage WebEngineQuick
+
+ The \QWE Quick module exposes C++ functionality to Qt Quick.
+
+ \if !defined(qtforpython)
+ To link against the module, add the following to your qmake project file:
+
+ \snippet qtwebengine_build_snippet.qdoc 0
+
+ For build with CMake use the \c find_package() command to locate the needed module components
+ in the Qt6 package and \c target_link_libraries() to link against the module:
+
+ \snippet qtwebengine_build_snippet.qdoc 2
+ \endif
+*/