From a126127f2c2bc1c8f4c7e44ea543057397bbdafa Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Thu, 7 Apr 2016 13:47:16 +0200 Subject: Doc: Avoid auto-linking of WebSocket, WebSockets MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Topi Reiniö --- src/imports/qmlwebsockets/qqmlwebsocket.cpp | 4 ++-- src/imports/qmlwebsockets/qqmlwebsocketserver.cpp | 2 +- src/websockets/doc/src/external-resources.qdoc | 20 ++++++++++++++++++++ 3 files changed, 23 insertions(+), 3 deletions(-) (limited to 'src') 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 */ -- cgit v1.2.1