diff options
author | Nico Vertriest <nico.vertriest@qt.io> | 2019-03-15 13:52:46 +0100 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2019-06-18 13:48:53 +0000 |
commit | 34c8622dbaafaa67c15a221a6c90390419c28063 (patch) | |
tree | 0ae3e723cee5f8651b67c4a739c43d83e90d5dbf /src | |
parent | 142d9798d262a41c09a9c43f3ae3a82c771fc800 (diff) |
Doc: Complete parameter description several methods
Change-Id: Ib9f98683faf2b3a4041371c80a31de1f0902261d
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/imports/qmlwebsockets/qqmlwebsocket.cpp | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/imports/qmlwebsockets/qqmlwebsocket.cpp b/src/imports/qmlwebsockets/qqmlwebsocket.cpp index 37a2fad..7f862e0 100644 --- a/src/imports/qmlwebsockets/qqmlwebsocket.cpp +++ b/src/imports/qmlwebsockets/qqmlwebsocket.cpp @@ -87,31 +87,33 @@ /*! \qmlsignal WebSocket::textMessageReceived(QString message) This signal is emitted when a text message is received. + \a message contains the bytes received. */ /*! \qmlsignal WebSocket::binaryMessageReceived(QString message) \since 5.8 This signal is emitted when a binary message is received. + \a message contains the bytes received. */ /*! \qmlsignal WebSocket::statusChanged(Status status) This signal is emitted when the status of the WebSocket changes. - the \l [QML]{WebSocket::status}{status} argument provides the current status. + The \a status argument provides the current status. \sa {QtWebSockets::}{WebSocket::status} */ /*! \qmlmethod void WebSocket::sendTextMessage(string message) - Sends \c message to the server. + Sends \a message to the server. */ /*! \qmlmethod void WebSocket::sendBinaryMessage(ArrayBuffer message) \since 5.8 - Sends \c message to the server. + Sends the parameter \a message to the server. */ #include "qqmlwebsocket.h" |