summaryrefslogtreecommitdiff
path: root/src/webchannel/doc/src/module.qdoc
blob: 6ff266424de9a13a2d7bafc2abcddfb68cd9aff6 (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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/****************************************************************************
**
** Copyright (C) 2014 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com>
** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \module QtWebChannel
    \title Qt WebChannel C++ Classes
    \ingroup modules
    \qtvariable webchannel
    \since 5.4
    \brief List of C++ classes that provide the Qt WebChannel functionality.

    To use these classes in your application, use the following include
    statement:

    \code
    #include <QtWebChannel/QtWebChannel>
    \endcode

    To link against the module, add this line to your \l qmake \c .pro file:

    \code
    QT += webchannel
    \endcode
*/

/*!
    \qmlmodule QtWebChannel 1.0
    \title Qt WebChannel QML Types
    \since 5.4
    \brief List of QML types that provide WebChannel functionality.

    The QML types are accessed by using:
    \badcode
    import QtWebChannel 1.0
    \endcode
*/