summaryrefslogtreecommitdiff
path: root/src/websockets/doc
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@digia.com>2014-09-26 12:06:10 +0200
committerAlex Blasche <alexander.blasche@digia.com>2014-09-28 19:52:58 +0200
commitf6175568bb32b87a3d6cd55382fa1c8e1a1de2b4 (patch)
tree0c5bc96f39f7c7cbef8e9e7faa314b118f519904 /src/websockets/doc
parent4301d626f8e6e2dabf3a71205eb632f001827a7f (diff)
downloadqtwebsockets-f6175568bb32b87a3d6cd55382fa1c8e1a1de2b4.tar.gz
Improve the integration of QtWebsockets into general Qt docsv5.4.0-beta1
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>
Diffstat (limited to 'src/websockets/doc')
-rw-r--r--src/websockets/doc/src/qtwebsockets-module.qdoc7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/websockets/doc/src/qtwebsockets-module.qdoc b/src/websockets/doc/src/qtwebsockets-module.qdoc
index 02d31d1..dc7009b 100644
--- 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
*/