summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@theqtcompany.com>2016-04-07 13:47:16 +0200
committerKai Koehne <kai.koehne@theqtcompany.com>2016-04-07 12:46:25 +0000
commita126127f2c2bc1c8f4c7e44ea543057397bbdafa (patch)
tree899967fba5d31eee80d90a413d58e9ed006b33b4 /src
parentbe4bfc5feeb61e97378bee325d36bb74f007fe04 (diff)
downloadqtwebsockets-a126127f2c2bc1c8f4c7e44ea543057397bbdafa.tar.gz
Doc: Avoid auto-linking of WebSocket, WebSockets
Disable the automatic linking of 'WebSocket' to the QML type, and 'WebSockets' to a section in the general documentation. Instead, make the linking explicit where it makes sense. This patch is inspired by 0228a5bd581ae6d672ce5f3 in qtwebengine. Change-Id: I80886360d5f7fdaa68a5e5f6fa982137c7187719 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src')
-rw-r--r--src/imports/qmlwebsockets/qqmlwebsocket.cpp4
-rw-r--r--src/imports/qmlwebsockets/qqmlwebsocketserver.cpp2
-rw-r--r--src/websockets/doc/src/external-resources.qdoc20
3 files changed, 23 insertions, 3 deletions
diff --git a/src/imports/qmlwebsockets/qqmlwebsocket.cpp b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
index ef97413..07ef925 100644
--- a/src/imports/qmlwebsockets/qqmlwebsocket.cpp
+++ b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
@@ -86,9 +86,9 @@
/*!
\qmlsignal WebSocket::statusChanged(Status status)
This signal is emitted when the status of the WebSocket changes.
- the \l {WebSocket::status}{status} argument provides the current status.
+ the \l [QML]{WebSocket::status}{status} argument provides the current status.
- \sa WebSocket::status
+ \sa {QtWebSockets::}{WebSocket::status}
*/
/*!
diff --git a/src/imports/qmlwebsockets/qqmlwebsocketserver.cpp b/src/imports/qmlwebsockets/qqmlwebsocketserver.cpp
index ea666a6..6572a17 100644
--- a/src/imports/qmlwebsockets/qqmlwebsocketserver.cpp
+++ b/src/imports/qmlwebsockets/qqmlwebsocketserver.cpp
@@ -90,7 +90,7 @@ QT_USE_NAMESPACE
/*!
\qmlsignal WebSocketServer::clientConnected(WebSocket webSocket)
- This signal is emitted when a client connects to this server.
+ This signal is emitted when a client connects to this server. \a webSocket is the newly created \l [QML]{WebSocket}.
*/
QQmlWebSocketServer::QQmlWebSocketServer(QObject *parent)
diff --git a/src/websockets/doc/src/external-resources.qdoc b/src/websockets/doc/src/external-resources.qdoc
index be49ded..933ef7f 100644
--- a/src/websockets/doc/src/external-resources.qdoc
+++ b/src/websockets/doc/src/external-resources.qdoc
@@ -103,4 +103,24 @@
/*!
\externalpage https://bugzilla.mozilla.org/show_bug.cgi?id=594502
\title Firefox bug 594502
+
+/*
+ This prevents autolinking of each occurrence of 'WebSocket'
+ To link to the WebSocket QML type, use explicit linking:
+ \l [QML] WebSocket
+ \sa {QtWebSockets::}{WebSocket}
+*/
+/*!
+ \externalpage nolink
+ \title WebSocket
+ \internal
+*/
+
+/*
+ Prevent linking to WebSockets section in "Networking and Connectivity"
+*/
+/*!
+ \externalpage nolink
+ \title WebSockets
+ \internal
*/