summaryrefslogtreecommitdiff
path: root/src/websockets/qwebsocket.cpp
diff options
context:
space:
mode:
authorKurt Pattyn <pattyn.kurt@gmail.com>2013-12-22 17:15:51 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-12-22 17:16:48 +0100
commitc481daa1899ebffe6d7d3805fd503aa8d29ad715 (patch)
tree13202ffde3aa220d0a9eec7f704494cae3e37d80 /src/websockets/qwebsocket.cpp
parent83caeb8ca705e95330f14f8795ffd0bf84cc3a9b (diff)
downloadqtwebsockets-c481daa1899ebffe6d7d3805fd503aa8d29ad715.tar.gz
Add extra documentation
Change-Id: I1a3c0571faeabf2d05bc144628d186e5ff039014 Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Diffstat (limited to 'src/websockets/qwebsocket.cpp')
-rw-r--r--src/websockets/qwebsocket.cpp10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/websockets/qwebsocket.cpp b/src/websockets/qwebsocket.cpp
index d8378b4..3c1c71f 100644
--- a/src/websockets/qwebsocket.cpp
+++ b/src/websockets/qwebsocket.cpp
@@ -46,14 +46,14 @@
\brief Implements a TCP socket that talks the websocket protocol.
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).
+ The WebSocket protocol was standardized by the IETF as \l {http://tools.ietf.org/html/rfc6455} {RFC 6455} in 2011.
It can both be used in a client application and server application.
This class was modeled after QAbstractSocket.
\sa QAbstractSocket, QTcpSocket
- \sa echoclient.html
+ \sa {QWebSocket client example}
*/
/*!
@@ -226,9 +226,9 @@ QT_BEGIN_NAMESPACE
/*!
* \brief Creates a new QWebSocket with the given \a origin, the \a version of the protocol to use and \a parent.
*
- * The \a origin of the client is as specified in http://tools.ietf.org/html/rfc6454.
- * (The \a origin is not required for non-web browser clients (see RFC 6455)).
- * \note Currently only V13 (RFC 6455) is supported
+ * The \a origin of the client is as specified \l {http://tools.ietf.org/html/rfc6454} {RFC 6454}.
+ * (The \a origin is not required for non-web browser clients (see \l {http://tools.ietf.org/html/rfc6455} {RFC 6455})).
+ * \note Currently only V13 (\l {http://tools.ietf.org/html/rfc6455} {RFC 6455}) is supported
*/
QWebSocket::QWebSocket(const QString &origin, QWebSocketProtocol::Version version, QObject *parent) :
QObject(parent),