Link qml documentation and make it visible in creator

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

diff --git a/src/imports/qmlwebsockets/qqmlwebsocket.cpp b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
index 94d20e0..f48b4b3 100644 (file)
--- a/src/imports/qmlwebsockets/qqmlwebsocket.cpp
+++ b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
@@ -44,6 +44,7 @@
     \instantiates QQmlWebSocket
 
     \inqmlmodule Qt.WebSockets
+    \ingroup websockets-qml
     \brief QML interface to QWebSocket.
 
     WebSockets is a web technology providing full-duplex communications channels over a single TCP connection.

diff --git a/src/websockets/doc/qtwebsockets.qdocconf b/src/websockets/doc/qtwebsockets.qdocconf
index 320db69..ab2ca4e 100644 (file)
--- a/src/websockets/doc/qtwebsockets.qdocconf
+++ b/src/websockets/doc/qtwebsockets.qdocconf
@@ -27,13 +27,13 @@ qhp.QtWebSockets.subprojects.classes.sortPages      = true
 
 qhp.QtWebSockets.subprojects.qml.title              = QML Types
 qhp.QtWebSockets.subprojects.qml.indexTitle         = Qt WebSockets QML Types
-qhp.QtWebSockets.subprojects.qml.selectors          = fake:headerfile
+qhp.QtWebSockets.subprojects.qml.selectors          = fake:qmlclass
 qhp.QtWebSockets.subprojects.qml.sortPages          = true
 
-#qhp.QtWebSockets.subprojects.examples.title         = Examples
-#qhp.QtWebSockets.subprojects.examples.indexTitle    = Qt WebSockets Examples
-#qhp.QtWebSockets.subprojects.examples.selectors     = class fake:example
-#qhp.QtWebSockets.subprojects.examples.sortPages     = true
+qhp.QtWebSockets.subprojects.examples.title         = Examples
+qhp.QtWebSockets.subprojects.examples.indexTitle    = Qt WebSockets Examples
+qhp.QtWebSockets.subprojects.examples.selectors     = fake:example
+qhp.QtWebSockets.subprojects.examples.sortPages     = true
 
 
 tagfile                                             = ../../../doc/qtwebsockets/qtwebsockets.tags

diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc
index 9f221e5..2f4812f 100644 (file)
--- a/src/websockets/doc/src/index.qdoc
+++ b/src/websockets/doc/src/index.qdoc
@@ -52,6 +52,7 @@
     \section1 Related information
     \list
     \li \l{Qt WebSockets C++ Classes}{C++ Classes}
+    \li \l{Qt WebSockets QML Types}{QML Types}
     \li \l{Qt WebSockets Examples}{Examples}
     \endlist
 */

diff --git a/src/websockets/doc/src/qtwebsockets-module.qdoc b/src/websockets/doc/src/qtwebsockets-module.qdoc
index c1d1451..c4dea41 100644 (file)
--- a/src/websockets/doc/src/qtwebsockets-module.qdoc
+++ b/src/websockets/doc/src/qtwebsockets-module.qdoc
@@ -45,3 +45,11 @@
     QT += websockets
     \endcode
 */
+
+/*!
+    \page qtwebsockets-qml-types.html
+    \title Qt WebSockets QML Types
+    \brief List of QML types that provide WebSockets communication.
+
+    \annotatedlist websockets-qml
+*/