Skip to content

Commit c0af378

Browse files
committed
adjust the ReceiveNode docstrings
1 parent 2044b4b commit c0af378

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

javascript/ql/src/semmle/javascript/frameworks/WebSocket.qll

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,8 @@ module ClientWebSocket {
9393

9494
/**
9595
* A handler that receives a message using the WebSocket API.
96-
* The "ws" library implements a superset of the WebSocket API, and this class therefore models both WebSocket and "ws".
96+
* The WebSocket API is used both by the WebSocket library in browsers, and the same API is also implemented as part of the "ws" library.
97+
* This class therefore models both the WebSocket library, and a subset of the "ws" library.
9798
*/
9899
private class WebSocketReceiveNode extends ClientWebSocket::ReceiveNode {
99100
WebSocketReceiveNode() {
@@ -108,7 +109,8 @@ module ClientWebSocket {
108109
}
109110

110111
/**
111-
* A handler that receives a message using the API from the "ws" library.
112+
* A handler that receives a message using the API from the "ws" library.
113+
* The "ws" library additionally implements the WebSocket API, which is modeled in the `WebSocketReceiveNode` class.
112114
*/
113115
private class WSReceiveNode extends ClientWebSocket::ReceiveNode {
114116
WSReceiveNode () {

0 commit comments

Comments
 (0)