summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-02-24 15:59:42 +0100
committerVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-02-25 10:42:45 +0000
commita2d4e9e069139787e0b3e0d9f5b1af31f1863316 (patch)
tree26a9af9b559eb989e211882e791f81e4d974e46a /src
parentfcd4c98922bd1a1a97ea264bd45e48cfa356c254 (diff)
downloadqtwebsockets-a2d4e9e069139787e0b3e0d9f5b1af31f1863316.tar.gz
Doc: Added introductory text about WebSocket
Also removed an unnecessary \annotatedlist entry in the QML module page. Change-Id: I1af566d3cc784766b4df474e2471e0885ab5e471 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/websockets/doc/src/index.qdoc13
-rw-r--r--src/websockets/doc/src/qtwebsockets-module.qdoc5
2 files changed, 12 insertions, 6 deletions
diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc
index a277e69..0d28036 100644
--- a/src/websockets/doc/src/index.qdoc
+++ b/src/websockets/doc/src/index.qdoc
@@ -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:
diff --git a/src/websockets/doc/src/qtwebsockets-module.qdoc b/src/websockets/doc/src/qtwebsockets-module.qdoc
index 0383475..acbe2ac 100644
--- a/src/websockets/doc/src/qtwebsockets-module.qdoc
+++ b/src/websockets/doc/src/qtwebsockets-module.qdoc
@@ -30,7 +30,7 @@
\ingroup modules
\qtvariable websockets
\since 5.3
- \brief List of C++ classes that provide WebSockets communication.
+ \brief List of C++ classes that enable WebSocket-based communication.
To use these classes in your application, use the following include
statement:
@@ -51,9 +51,8 @@
\qmlmodule QtWebSockets 1.0
\title Qt WebSockets QML Types
\ingroup qmlmodules
- \brief Provides QML types for WebSockets communication.
+ \brief Provides QML types for WebSocket-based communication.
- \annotatedlist websockets-qml
The QML types are accessed by using:
\code