summaryrefslogtreecommitdiff
path: root/src/websockets/doc/src/qtwebsockets-module.qdoc
blob: f1d9ff7956626712b1e0765c09b4ad6e64d05288 (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
// Copyright (C) 2013 Kurt Pattyn <pattyn.kurt@gmail.com>
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
    \module QtWebSockets
    \title Qt WebSockets C++ Classes
    \ingroup modules
    \qtcmakepackage WebSockets
    \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.\QtMinorVersion
    \title Qt WebSockets QML Types
    \ingroup qmlmodules
    \brief Provides QML types for WebSocket-based communication.


    The QML types are accessed by using:
    \qml \QtMinorVersion
    import QtWebSockets 1.\1
    \endqml

    \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.
*/