Update documentation

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

diff --git a/src/imports/qmlwebsockets/qqmlwebsocket.cpp b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
index d2f1016..8a87218 100644 (file)
--- 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.
   */
 
 /*!

diff --git a/src/websockets/qwebsocketprotocol.cpp b/src/websockets/qwebsocketprotocol.cpp
index cd95438..3b5c52d 100644 (file)
--- a/src/websockets/qwebsocketprotocol.cpp
+++ b/src/websockets/qwebsocketprotocol.cpp
@@ -115,6 +115,33 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
+    \enum QWebSocketProtocol::OpCode
+
+    \inmodule QtWebSockets
+
+    The frame opcodes as defined by the WebSockets standard
+
+    \value OC_CONTINUE      Continuation frame
+    \value OC_TEXT          Text frame
+    \value OC_BINARY        Binary frame
+    \value OC_RESERVED_3    Reserved
+    \value OC_RESERVED_4    Reserved
+    \value OC_RESERVED_5    Reserved
+    \value OC_RESERVED_6    Reserved
+    \value OC_RESERVED_7    Reserved
+    \value OC_CLOSE         Close frame
+    \value OC_PING          Ping frame
+    \value OC_PONG          Pong frame
+    \value OC_RESERVED_B    Reserved
+    \value OC_RESERVED_C    Reserved
+    \value OC_RESERVED_D    Reserved
+    \value OC_RESERVED_E    Reserved
+    \value OC_RESERVED_F    Reserved
+
+    \internal
+*/
+
+/*!
   \fn QWebSocketProtocol::isOpCodeReserved(OpCode code)
   Checks if \a code is a valid OpCode