Improve the integration of QtWebsockets into general Qt docs

1.) The websocket qml types page is now hooked into Qt's QML Type by Module
page.

2.) Correct incorrectly documented import statement for Qt.WebSockets
module in QML.

3.) Add missing \since tags (see QTBUG-36775).

Change-Id: I1321db70215fcd16cfbd77dd71a459244241d8a3
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>

diff --git a/src/imports/qmlwebsockets/qqmlwebsocket.cpp b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
index edd48c4..08d39f6 100644 (file)
--- a/src/imports/qmlwebsockets/qqmlwebsocket.cpp
+++ b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
@@ -34,6 +34,7 @@
 /*!
     \qmltype WebSocket
     \instantiates QQmlWebSocket
+    \since 5.3
 
     \inqmlmodule Qt.WebSockets
     \ingroup websockets-qml

diff --git a/src/imports/qmlwebsockets/qqmlwebsocketserver.cpp b/src/imports/qmlwebsockets/qqmlwebsocketserver.cpp
index e5b2b0f..6425fe2 100644 (file)
--- a/src/imports/qmlwebsockets/qqmlwebsocketserver.cpp
+++ b/src/imports/qmlwebsockets/qqmlwebsocketserver.cpp
@@ -39,6 +39,7 @@ QT_USE_NAMESPACE
 /*!
     \qmltype WebSocketServer
     \instantiates QQmlWebSocketServer
+    \since 5.3
 
     \inqmlmodule Qt.WebSockets
     \ingroup websockets-qml

diff --git a/src/websockets/doc/src/qtwebsockets-module.qdoc b/src/websockets/doc/src/qtwebsockets-module.qdoc
index 02d31d1..dc7009b 100644 (file)
--- a/src/websockets/doc/src/qtwebsockets-module.qdoc
+++ b/src/websockets/doc/src/qtwebsockets-module.qdoc
@@ -48,14 +48,15 @@
 */
 
 /*!
-    \page qtwebsockets-qml-types.html
+    \qmlmodule Qt.WebSockets 1.0
     \title Qt WebSockets QML Types
-    \brief List of QML types that provide WebSockets communication.
+    \ingroup qmlmodules
+    \brief Provides QML types for WebSockets communication.
 
     \annotatedlist websockets-qml
 
     The QML types are accessed by using:
     \code
-    import QtWebSockets 1.0
+    import Qt.WebSockets 1.0
     \endcode
 */

diff --git a/src/websockets/qmaskgenerator.cpp b/src/websockets/qmaskgenerator.cpp
index 1715709..b6c0d34 100644 (file)
--- a/src/websockets/qmaskgenerator.cpp
+++ b/src/websockets/qmaskgenerator.cpp
@@ -35,6 +35,7 @@
     \class QMaskGenerator
 
     \inmodule QtWebSockets
+    \since 5.3
 
     \brief The QMaskGenerator class provides an abstract base for custom 32-bit mask generators.
 

diff --git a/src/websockets/qwebsocket.cpp b/src/websockets/qwebsocket.cpp
index 051c776..9cd0ff4 100644 (file)
--- a/src/websockets/qwebsocket.cpp
+++ b/src/websockets/qwebsocket.cpp
@@ -35,6 +35,7 @@
     \class QWebSocket
 
     \inmodule QtWebSockets
+    \since 5.3
     \brief Implements a TCP socket that talks the WebSocket protocol.
 
     WebSockets is a web technology providing full-duplex communications channels over

diff --git a/src/websockets/qwebsocketcorsauthenticator.cpp b/src/websockets/qwebsocketcorsauthenticator.cpp
index ec2537c..68c626e 100644 (file)
--- a/src/websockets/qwebsocketcorsauthenticator.cpp
+++ b/src/websockets/qwebsocketcorsauthenticator.cpp
@@ -35,6 +35,7 @@
     \class QWebSocketCorsAuthenticator
 
     \inmodule QtWebSockets
+    \since 5.3
     \brief The QWebSocketCorsAuthenticator class provides an authenticator object for
     Cross Origin Requests (CORS).
 

diff --git a/src/websockets/qwebsocketprotocol.cpp b/src/websockets/qwebsocketprotocol.cpp
index 697f16f..210a805 100644 (file)
--- a/src/websockets/qwebsocketprotocol.cpp
+++ b/src/websockets/qwebsocketprotocol.cpp
@@ -42,6 +42,7 @@ QT_BEGIN_NAMESPACE
   \namespace QWebSocketProtocol
   \inmodule QtWebSockets
   \brief Contains constants related to the WebSocket standard.
+  \since 5.3
 */
 
 /*!

diff --git a/src/websockets/qwebsocketserver.cpp b/src/websockets/qwebsocketserver.cpp
index 6c70d8e..59cfd89 100644 (file)
--- a/src/websockets/qwebsocketserver.cpp
+++ b/src/websockets/qwebsocketserver.cpp
@@ -35,6 +35,7 @@
     \class QWebSocketServer
 
     \inmodule QtWebSockets
+    \since 5.3
 
     \brief Implements a WebSocket-based server.