diff options
| author | Venugopal Shivashankar <venugopal.shivashankar@digia.com> | 2015-05-28 22:36:56 +0200 |
|---|---|---|
| committer | Liang Qi <liang.qi@theqtcompany.com> | 2015-06-24 10:04:35 +0000 |
| commit | 8c2c5938b79f64e869a82f742da063e281171e1d (patch) | |
| tree | ca00a08dda3e5f24b308a4e17aff70da6c469e11 /src/websockets/doc/src/index.qdoc | |
| parent | 150db98da8695f74601b1776742e8284602207fe (diff) | |
Doc: Added an overview page and updated the qdocconf
Task-number: QTBUG-41044
Change-Id: I074573e814de63e009744a11054365fb2f25bdb9
Reviewed-by: Liang Qi <liang.qi@theqtcompany.com>
Diffstat (limited to 'src/websockets/doc/src/index.qdoc')
| -rw-r--r-- | src/websockets/doc/src/index.qdoc | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc index 344a859..e0f219c 100644 --- a/src/websockets/doc/src/index.qdoc +++ b/src/websockets/doc/src/index.qdoc @@ -37,11 +37,9 @@ 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. + 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. To use this module in your application, use the following include statement: @@ -59,6 +57,7 @@ \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} \endlist |