Skip to content

Commit 86fce5f

Browse files
carlossanlopmairaw
authored andcommitted
Port System.Net.WebSockets triple slash comments to Docs (#2319)
* Port System.Net.WebSockets triple slash comments to Docs * Apply suggestions from code review Suggestions provided by davidsh and karelz. Co-Authored-By: carlossanlop <[email protected]> * Apply suggestions from code review Suggestions by mairaw Co-Authored-By: carlossanlop <[email protected]>
1 parent 65adb64 commit 86fce5f

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@
4949
<Parameter Name="endOfMessage" Type="System.Boolean" />
5050
</Parameters>
5151
<Docs>
52-
<param name="count">To be added.</param>
53-
<param name="messageType">To be added.</param>
54-
<param name="endOfMessage">To be added.</param>
55-
<summary>To be added.</summary>
52+
<param name="count">The number of bytes that the <see cref="T:System.Net.WebSockets.WebSocket" /> received.</param>
53+
<param name="messageType">One of the enumeration values that indicates whether the current message is a UTF-8 message or a binary message.</param>
54+
<param name="endOfMessage"><see langword="true" /> to indicate the messsage has been received completely; otherwise, <see langword="false" />.</param>
55+
<summary>Initializes a new instance of the <see cref="T:System.Net.WebSockets.ValueWebSocketReceiveResult" /> struct. An instance of this struct represents the result of performing a single <c>ReceiveAsync</c> operation on a <see cref="T:System.Net.WebSockets.WebSocket" />.</summary>
5656
<remarks>To be added.</remarks>
5757
</Docs>
5858
</Member>
@@ -132,4 +132,4 @@
132132
</Docs>
133133
</Member>
134134
</Members>
135-
</Type>
135+
</Type>

xml/System.Net.WebSockets/WebSocket.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -400,12 +400,12 @@
400400
<Parameter Name="keepAliveInterval" Type="System.TimeSpan" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
401401
</Parameters>
402402
<Docs>
403-
<param name="stream">To be added.</param>
404-
<param name="isServer">To be added.</param>
405-
<param name="subProtocol">To be added.</param>
406-
<param name="keepAliveInterval">To be added.</param>
407-
<summary>To be added.</summary>
408-
<returns>To be added.</returns>
403+
<param name="stream">The stream for the connection.</param>
404+
<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>
405+
<param name="subProtocol">The agreed upon sub-protocol that was used when creating the connection.</param>
406+
<param name="keepAliveInterval">The keep-alive interval to use, or <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> to disable keep-alives.</param>
407+
<summary>Creates a new <see cref="T:System.Net.WebSockets.WebSocket" /> object that operates on the specified stream, which represents a web socket connection.</summary>
408+
<returns>The new web socket.</returns>
409409
<remarks>To be added.</remarks>
410410
</Docs>
411411
</Member>
@@ -933,4 +933,4 @@
933933
</Docs>
934934
</Member>
935935
</Members>
936-
</Type>
936+
</Type>

0 commit comments

Comments
 (0)