History

Convert all "/**jsdoc" occurrences to "/*@jsdoc"

David Rowe committed 5 years ago

Commit 4d11d1d1 parent 2130dea220 files · +2319 −2319Browse files

Showing the changes to libraries/script-engine/src/WebSocketClass.cpp (1 of 220 files). Show all

Unified · Split

libraries/script-engine/src/WebSocketClass.cpp+7−7
@@ -76,12 +76,12 @@ void WebSocketClass::close(QWebSocketProtocol::CloseCode closeCode, QString reas · 75 unmodified lines
76 _webSocket->close(closeCode, reason);76 _webSocket->close(closeCode, reason);
77}77}
78 78
79/**jsdoc79/*@jsdoc
80 * Called when the connection closes.80 * Called when the connection closes.
81 * @callback WebSocket~onCloseCallback81 * @callback WebSocket~onCloseCallback
82 * @param {WebSocket.CloseData} data - Information on the connection closure.82 * @param {WebSocket.CloseData} data - Information on the connection closure.
83 */83 */
84/**jsdoc84/*@jsdoc
85 * Information on a connection being closed.85 * Information on a connection being closed.
86 * @typedef {object} WebSocket.CloseData86 * @typedef {object} WebSocket.CloseData
87 * @property {WebSocket.CloseCode} code - The reason why the connection was closed.87 * @property {WebSocket.CloseCode} code - The reason why the connection was closed.
@@ -101,12 +101,12 @@ void WebSocketClass::handleOnClose() { · 13 unmodified lines
101 }101 }
102}102}
103 103
104/**jsdoc104/*@jsdoc
105 * Called when an error occurs.105 * Called when an error occurs.
106 * @callback WebSocket~onErrorCallback106 * @callback WebSocket~onErrorCallback
107 * @param {WebSocket.SocketError} error - The error.107 * @param {WebSocket.SocketError} error - The error.
108 */108 */
109/**jsdoc109/*@jsdoc
110 * <p>The type of socket error.</p>110 * <p>The type of socket error.</p>
111 * <table>111 * <table>
112 * <thead>112 * <thead>
@@ -158,12 +158,12 @@ void WebSocketClass::handleOnError(QAbstractSocket::SocketError error) { · 45 unmodified lines
158 }158 }
159}159}
160 160
161/**jsdoc161/*@jsdoc
162 * Triggered when a message is received.162 * Triggered when a message is received.
163 * @callback WebSocket~onMessageCallback163 * @callback WebSocket~onMessageCallback
164 * @param {WebSocket.MessageData} message - The message received.164 * @param {WebSocket.MessageData} message - The message received.
165 */165 */
166/**jsdoc166/*@jsdoc
167 * A message received on a WebSocket connection.167 * A message received on a WebSocket connection.
168 * @typedef {object} WebSocket.MessageData168 * @typedef {object} WebSocket.MessageData
169 * @property {string} data - The message content.169 * @property {string} data - The message content.
@@ -197,7 +197,7 @@ void WebSocketClass::handleOnBinaryMessage(const QByteArray& message) { · 27 unmodified lines
197 }197 }
198}198}
199 199
200/**jsdoc200/*@jsdoc
201 * Called when the connection opens.201 * Called when the connection opens.
202 * @callback WebSocket~onOpenCallback202 * @callback WebSocket~onOpenCallback
203 */203 */