/****************************************************************************
**
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \page qtwebchannel-index.html
    \since 5.4
    \title Qt WebChannel
    \brief Bridges the gap between Qt applications and HTML/JavaScript.

    Qt WebChannel enables peer-to-peer communication between a server (QML/C++
    application) and a client (HTML/JavaScript or QML application). It is
    supported out of the box by \l{Qt WebEngine}. In addition it can work on all
    browsers that support \l{Qt WebSockets}{WebSockets}, enabling Qt WebChannel
    clients to run in any JavaScript environment (including QML). This requires
    the implementation of a custom transport based on Qt WebSockets.

    The module provides a JavaScript library for seamless integration of C++
    and QML applications with HTML/JavaScript and QML clients. The clients must use the
    JavaScript library to access the serialized QObjects published by the host
    applications.

    \section1 Getting Started

    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

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

    \section1 Licenses

    Qt WebChannel is available under commercial licenses from \l{The Qt Company}.
    In addition, it is available under free software licenses.
    These free software licenses are
    \l{GNU Lesser General Public License, version 3}, or
    the \l{GNU General Public License, version 2}.
    See \l{Qt Licensing} for further details.

    \section1 API Reference

    \list
    \li \l{Qt WebChannel JavaScript API}{JavaScript API}
    \li \l{Qt WebChannel C++ Classes}{C++ API}
    \li \l{Qt WebChannel QML Types}{QML API}
    \endlist

    \section1 Examples

    \list
    \li \l{Qt WebChannel Examples}{Examples}
    \endlist
*/
