Add clarification in documentation

Change-Id: Ib616c4c932cb2797036d2d821af7726fcfe2f877
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>

diff --git a/src/websockets/qwebsocket.cpp b/src/websockets/qwebsocket.cpp
index 22722c2..943af56 100644 (file)
--- a/src/websockets/qwebsocket.cpp
+++ b/src/websockets/qwebsocket.cpp
@@ -80,6 +80,8 @@
 /*!
   \fn void QWebSocket::connected()
   \brief Emitted when a connection is successfully established.
+  A connection is successfully established when the socket is connected
+  and the handshake was successful.
   \sa open(), disconnected()
 */
 /*!
@@ -116,6 +118,9 @@ not been filled in with new information when the signal returns.
     This signal is emitted whenever QWebSocket's state changes.
     The \a state parameter is the new state.
 
+    \note QAbstractSocket::ConnectedState is emitted after the handshake has
+    with the server has succeeded.
+
     QAbstractSocket::SocketState is not a registered metatype, so for queued
     connections, you will have to register it with Q_REGISTER_METATYPE() and
     qRegisterMetaType().