summaryrefslogtreecommitdiff
path: root/src/imports
diff options
context:
space:
mode:
authorKurt Pattyn <pattyn.kurt@gmail.com>2014-01-13 11:28:21 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-01-13 12:18:10 +0100
commitc15e979b02bec88baecb464b8e526e7d876d30e1 (patch)
tree6b9e37cfbe8fdd7a651054a01d3c5cd773ffcf57 /src/imports
parent2160f1215533130d0bfa16ad7b7bf20c88ac8028 (diff)
downloadqtwebsockets-c15e979b02bec88baecb464b8e526e7d876d30e1.tar.gz
Update documentation
Change-Id: I98cab390cbb0f19741d6fa4ae5b0ada8d19d1f5f Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Diffstat (limited to 'src/imports')
-rw-r--r--src/imports/qmlwebsockets/qqmlwebsocket.cpp10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/imports/qmlwebsockets/qqmlwebsocket.cpp b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
index d2f1016..8a87218 100644
--- a/src/imports/qmlwebsockets/qqmlwebsocket.cpp
+++ b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
@@ -47,14 +47,16 @@
\ingroup websockets-qml
\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).
+ WebSockets is a web technology providing full-duplex communications channels over a
+ single TCP connection.
+ The WebSocket protocol was standardized by the IETF as
+ \l {http://tools.ietf.org/html/rfc6455} {RFC 6455} in 2011.
*/
/*!
\qmlproperty QUrl WebSocket::url
- Server url to connect to. The url must have one of 2 schemes: {ws://} or {wss://}.
- When not supplied, then {ws://} is used.
+ Server url to connect to. The url must have one of 2 schemes: \e ws:// or \e wss://.
+ When not supplied, then \e ws:// is used.
*/
/*!