summaryrefslogtreecommitdiffstats
path: root/src/webenginequick/doc/src/qtwebengine-module.qdoc
blob: 6f50cc2f4ee2f3ebc12579ad23ba7f7692873d15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
*/