diff options
Diffstat (limited to 'src/websockets/doc/src/index.qdoc')
| -rw-r--r-- | src/websockets/doc/src/index.qdoc | 96 |
1 files changed, 36 insertions, 60 deletions
diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc index 81a2cb4..e3fce1e 100644 --- a/src/websockets/doc/src/index.qdoc +++ b/src/websockets/doc/src/index.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2013 Kurt Pattyn <pattyn.kurt@gmail.com> +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page qtwebsockets-index.html @@ -31,61 +7,61 @@ \title Qt WebSockets \brief Provides an implementation of the WebSocket protocol. - WebSocket is a web-based protocol designed to enable two-way communication - between a client application and a remote host. It enables the two entities - to send data back and forth if the initial handshake succeeds. WebSocket is - the solution for applications that struggle to get real-time data feeds - with less network latency and minimum data exchange. + WebSocket is a web-based protocol designed to enable a two-way interactive + communication session between a client application and a remote host. It + enables the two entities to send data back and forth if the initial + handshake succeeds. The Qt WebSockets module provides C++ and QML interfaces that enable Qt applications to act as a server that can process WebSocket requests, or a client that can consume data received from the server, or both. - \section1 Getting Started + \section1 Using the Module - To include the definitions of the module's classes, use the following directive: + \section2 QML API - \code - #include <QtWebSockets/QtWebSockets> - \endcode + \include {module-use.qdocinc} {using the qml api} {QtWebSockets} - To import the QML types into your application, use the following import statement in your .qml file: + \section2 C++ API - \qml \QtMinorVersion - import QtWebSockets 1.\1 - \endqml + \include {module-use.qdocinc} {using the c++ api} - To link against the module, add this line to your qmake .pro file: + \section3 Building with CMake - \code - QT += websockets - \endcode + \include {module-use.qdocinc} {building with cmake} {WebSockets} - \section1 Licenses + \section3 Building with qmake - Qt WebSockets is available under commercial licenses from \l{The Qt Company}. - In addition, it is available under free software licenses. Since Qt 5.4, - 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. + \include {module-use.qdocinc} {building_with_qmake} {websockets} + + \section1 Examples - \section1 Reference Documentation \list - \li \l{Qt WebSockets Overview}{Overview} - \li \l{Qt WebSockets C++ Classes}{C++ Classes} - \li \l{Qt WebSockets QML Types}{QML Types} + \li \l {Qt WebSockets Examples} \endlist - \section1 Examples + \section1 Reference - The module provides the following \l{Qt WebSockets Examples}{Examples} as a guide to using - the API. + \list + \li \l {Qt WebSockets Overview} {Overview} + \li \l {Qt WebSockets C++ Classes} {C++ Classes} + \li \l {Qt WebSockets QML Types} {QML Types} + \endlist \section1 Conformance + \list - \li \l {Testing Qt WebSockets} + \li \l {Testing Qt WebSockets} \endlist + + \section1 Licenses + + Qt WebSockets is available under commercial licenses from \l{The Qt Company}. + In addition, it is available under free software licenses. Since Qt 5.4, + 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. */ /*! @@ -98,5 +74,5 @@ \l {Autobahn|Testsuite installation documentation} to set up the test suite. - \include README testsuite + \include README.qdocinc testsuite */ |