summaryrefslogtreecommitdiff
path: root/src/websockets/doc/qwebsockets.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/websockets/doc/qwebsockets.qdoc')
-rw-r--r--src/websockets/doc/qwebsockets.qdoc8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/websockets/doc/qwebsockets.qdoc b/src/websockets/doc/qwebsockets.qdoc
new file mode 100644
index 0000000..49bc0f0
--- /dev/null
+++ b/src/websockets/doc/qwebsockets.qdoc
@@ -0,0 +1,8 @@
+/*!
+ \module QWebSockets
+ \title QWebSockets module
+
+ The QWebSockets module implements the WebSocket protocol as specified in \l {http://tools.ietf.org/html/rfc6455} {RFC 6455}.
+ It solely depends on Qt (no external depencies).
+ The module contains 2 main classes: QWebSocket and QWebSocketServer, with which one can create client- and server applications.
+ */