summaryrefslogtreecommitdiff
path: root/src/websockets/doc/src/index.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/websockets/doc/src/index.qdoc')
-rw-r--r--src/websockets/doc/src/index.qdoc23
1 files changed, 15 insertions, 8 deletions
diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc
index 1d05585..0d28036 100644
--- a/src/websockets/doc/src/index.qdoc
+++ b/src/websockets/doc/src/index.qdoc
@@ -1,7 +1,7 @@
/****************************************************************************
**
** Copyright (C) 2013 Kurt Pattyn <pattyn.kurt@gmail.com>
-** Contact: http://www.qt-project.org/legal
+** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
@@ -10,15 +10,15 @@
** 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 Digia. For licensing terms and
-** conditions see http://qt.digia.com/licensing. For further information
-** use the contact form at http://qt.digia.com/contact-us.
+** 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
+** 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$
@@ -31,10 +31,17 @@
\title Qt WebSockets
\brief Provides an implementation of the WebSocket protocol.
- The QtWebSockets module implements the WebSocket protocol as specified in
- \l {http://tools.ietf.org/html/rfc6455} {RFC 6455}.
- It solely depends on Qt (no external dependencies).
+ 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.
+ The Qt WebSockets module implements the WebSocket protocol as specified in
+ \l {http://tools.ietf.org/html/rfc6455} {RFC 6455}. It provides C++ and QML
+ interfaces that enable Qt applications to act as a server that can process
+ WebSocket-based requests, or a client that can consume data received from
+ the server, or both.
To use this module in your application, use the following include
statement: