Skip to content

Commit 3c03165

Browse files
jozkeetdykstra
andauthored
Add documentation for WebSocketProtocol class and its members. (#3553)
* Add documentation for WebSocketProtocol class and its members. * Apply suggestions from code review Co-Authored-By: Tom Dykstra <[email protected]>
1 parent 85bce73 commit 3c03165

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

xml/System.Net.WebSockets/WebSocketProtocol.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</Base>
1717
<Interfaces />
1818
<Docs>
19-
<summary>To be added.</summary>
19+
<summary>The WebSocket class allows applications to send and receive data after the WebSocket upgrade has completed.</summary>
2020
<remarks>To be added.</remarks>
2121
</Docs>
2222
<Members>
@@ -43,12 +43,12 @@
4343
<Parameter Name="keepAliveInterval" Type="System.TimeSpan" />
4444
</Parameters>
4545
<Docs>
46-
<param name="stream">To be added.</param>
47-
<param name="isServer">To be added.</param>
48-
<param name="subProtocol">To be added.</param>
49-
<param name="keepAliveInterval">To be added.</param>
50-
<summary>To be added.</summary>
51-
<returns>To be added.</returns>
46+
<param name="stream">The stream for the connection.</param>
47+
<param name="isServer"><see langword="true" /> to indicate it's the server-side of the connection; <see langword="false" /> if it's the client-side.</param>
48+
<param name="subProtocol">The agreed upon sub-protocol that was used when creating the connection.</param>
49+
<param name="keepAliveInterval">The keep-alive interval to use, or <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> to disable keep-alives.</param>
50+
<summary>Creates a new WebSocket connection that operates on the specified stream.</summary>
51+
<returns>The new WebSocket connection.</returns>
5252
<remarks>To be added.</remarks>
5353
</Docs>
5454
</Member>

0 commit comments

Comments
 (0)