Added QWebSockets module documentation
authorKurt Pattyn <pattyn.kurt@gmail.com>
Sun, 25 Aug 2013 16:53:43 +0000 (18:53 +0200)
committerKurt Pattyn <pattyn.kurt@gmail.com>
Sun, 25 Aug 2013 16:53:43 +0000 (18:53 +0200)
doc/src/qwebsockets.qdoc [new file with mode: 0644]

diff --git a/doc/src/qwebsockets.qdoc b/doc/src/qwebsockets.qdoc
new file mode 100644 (file)
index 0000000..49bc0f0
--- /dev/null
@@ -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.
+ */