summaryrefslogtreecommitdiff
path: root/src/websockets/doc/src/qtwebsockets-module.qdoc
blob: c1f7958a15e54d9a8ca1ca23b69f0864784c1eb6 (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
61
62
63
64
65
66
/****************************************************************************
**
** Copyright (C) 2013 Kurt Pattyn <pattyn.kurt@gmail.com>
** Contact: https://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$
**
****************************************************************************/
/*!
    \module QtWebSockets
    \title Qt WebSockets C++ Classes
    \ingroup modules
    \qtvariable websockets
    \since 5.3
    \brief List of C++ classes that enable WebSocket-based communication.

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

    \code
    #include <QtWebSockets/QtWebSockets>
    \endcode

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

    \code
    QT += websockets
    \endcode
*/

/*!
    \qmlmodule QtWebSockets 1.1
    \title Qt WebSockets QML Types
    \ingroup qmlmodules
    \brief Provides QML types for WebSocket-based communication.


    The QML types are accessed by using:
    \code
    import QtWebSockets 1.1
    \endcode

    \note Prior to Qt 5.5, the import statement was \c{import Qt.WebSockets 1.0}
    (notice the dot between \c Qt and \c WebSockets). The old statement is still
    supported for backwards compatibility, but it cannot be mixed with the new
    statement within the same project.
*/