diff options
| author | Kurt Pattyn <pattyn.kurt@gmail.com> | 2013-12-22 17:15:51 +0100 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-12-22 17:16:48 +0100 |
| commit | c481daa1899ebffe6d7d3805fd503aa8d29ad715 (patch) | |
| tree | 13202ffde3aa220d0a9eec7f704494cae3e37d80 /src/imports | |
| parent | 83caeb8ca705e95330f14f8795ffd0bf84cc3a9b (diff) | |
| download | qtwebsockets-c481daa1899ebffe6d7d3805fd503aa8d29ad715.tar.gz | |
Add extra documentation
Change-Id: I1a3c0571faeabf2d05bc144628d186e5ff039014
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Diffstat (limited to 'src/imports')
| -rw-r--r-- | src/imports/qmlwebsockets/qqmlwebsocket.cpp | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/src/imports/qmlwebsockets/qqmlwebsocket.cpp b/src/imports/qmlwebsockets/qqmlwebsocket.cpp index 49b1dfd..9d2ce7f 100644 --- a/src/imports/qmlwebsockets/qqmlwebsocket.cpp +++ b/src/imports/qmlwebsockets/qqmlwebsocket.cpp @@ -39,6 +39,23 @@ ** ****************************************************************************/ +/*! + \qmltype WebSocket + \instantiates QQmlWebSocket + + \inqmlmodule Qt.WebSockets + \brief QML interface to QWebSocket. + + WebSockets is a web technology providing full-duplex communications channels over a single TCP connection. + The WebSocket protocol was standardized by the IETF as RFC 6455 in 2011 (see http://tools.ietf.org/html/rfc6455). +*/ + +/*! + \qmlproperty url QQmlWebSocket::url + Server url to connect to. The url must have one of 2 schemes: {ws://} or {wss://}. + When not supplied, then {ws://} is used. + */ + #include "qqmlwebsocket.h" #include <QtWebSockets/QWebSocket> |