From 65e36a8bfffabcefa71576f3a9fa526fc6c67fd4 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez Date: Tue, 16 Apr 2019 13:40:48 -0700 Subject: [PATCH 1/3] Port System.Net.WebSockets triple slash comments to Docs --- .../ValueWebSocketReceiveResult.xml | 8 ++++---- xml/System.Net.WebSockets/WebSocket.xml | 12 ++++++------ 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml b/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml index b47f2aaff79..b83eccf460b 100644 --- a/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml +++ b/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml @@ -49,10 +49,10 @@ - To be added. - To be added. - To be added. - To be added. + The number of bytes received. + The type of message that was received. + Whether this is the final message. + Creates an instance of the value type. To be added. diff --git a/xml/System.Net.WebSockets/WebSocket.xml b/xml/System.Net.WebSockets/WebSocket.xml index 3895df8bf27..8ceb90c7375 100644 --- a/xml/System.Net.WebSockets/WebSocket.xml +++ b/xml/System.Net.WebSockets/WebSocket.xml @@ -400,12 +400,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The for the connection. + if this is the server-side of the connection; if it's the client side. + The agreed upon sub-protocol that was used when creating the connection. + The keep-alive interval to use, or to disable keep-alives. + Creates a that operates on a representing a web socket connection. + The created . To be added. From 4efe7ac417059d8563a0708f236632a68a58dd24 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 23 Apr 2019 10:41:12 -0700 Subject: [PATCH 2/3] Apply suggestions from code review Suggestions provided by davidsh and karelz. Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com> --- .../ValueWebSocketReceiveResult.xml | 10 +++++----- xml/System.Net.WebSockets/WebSocket.xml | 4 ++-- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml b/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml index b83eccf460b..dd881fdc5af 100644 --- a/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml +++ b/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml @@ -49,10 +49,10 @@ - The number of bytes received. - The type of message that was received. - Whether this is the final message. - Creates an instance of the value type. + Indicates the number of bytes that the WebSocket received. + Indicates whether the current message is a UTF-8 message or a binary message. + Indicates whether the message has been received completely. + An instance of this class represents the result of performing a single ReceiveAsync operation on a WebSocket. To be added. @@ -132,4 +132,4 @@ - \ No newline at end of file + diff --git a/xml/System.Net.WebSockets/WebSocket.xml b/xml/System.Net.WebSockets/WebSocket.xml index 8ceb90c7375..bd393f0f7ae 100644 --- a/xml/System.Net.WebSockets/WebSocket.xml +++ b/xml/System.Net.WebSockets/WebSocket.xml @@ -401,7 +401,7 @@ The for the connection. - if this is the server-side of the connection; if it's the client side. + if this is the server-side of the connection; if it is the client-side. The agreed upon sub-protocol that was used when creating the connection. The keep-alive interval to use, or to disable keep-alives. Creates a that operates on a representing a web socket connection. @@ -933,4 +933,4 @@ - \ No newline at end of file + From 523a3e52af33b1a43dea23b8dd5ad9c646ab7bdc Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Fri, 26 Apr 2019 11:31:50 -0700 Subject: [PATCH 3/3] Apply suggestions from code review Suggestions by mairaw Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml | 8 ++++---- xml/System.Net.WebSockets/WebSocket.xml | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml b/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml index dd881fdc5af..351b6267206 100644 --- a/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml +++ b/xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml @@ -49,10 +49,10 @@ - Indicates the number of bytes that the WebSocket received. - Indicates whether the current message is a UTF-8 message or a binary message. - Indicates whether the message has been received completely. - An instance of this class represents the result of performing a single ReceiveAsync operation on a WebSocket. + The number of bytes that the received. + One of the enumeration values that indicates whether the current message is a UTF-8 message or a binary message. + to indicate the messsage has been received completely; otherwise, . + Initializes a new instance of the struct. An instance of this struct represents the result of performing a single ReceiveAsync operation on a . To be added. diff --git a/xml/System.Net.WebSockets/WebSocket.xml b/xml/System.Net.WebSockets/WebSocket.xml index bd393f0f7ae..fa71189284c 100644 --- a/xml/System.Net.WebSockets/WebSocket.xml +++ b/xml/System.Net.WebSockets/WebSocket.xml @@ -400,12 +400,12 @@ - The for the connection. - if this is the server-side of the connection; if it is the client-side. + The stream for the connection. + to indicate it's the server-side of the connection; if it's the client-side. The agreed upon sub-protocol that was used when creating the connection. The keep-alive interval to use, or to disable keep-alives. - Creates a that operates on a representing a web socket connection. - The created . + Creates a new object that operates on the specified stream, which represents a web socket connection. + The new web socket. To be added.