Skip to content

Commit f411ac3

Browse files
authored
Add documentation for System.Net.WebSockets APIs introduced in 2.x (#3555)
* Add documentation for System.Net.WebSockets APIs introduced in 2.x * Apply suggestions from code review Co-Authored-By: Maira Wenzel <[email protected]> * Fix invalid cross references
1 parent a133853 commit f411ac3

File tree

3 files changed

+20
-18
lines changed

3 files changed

+20
-18
lines changed

xml/System.Net.WebSockets/ClientWebSocketOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,8 @@
278278
<ReturnType>System.Net.Security.RemoteCertificateValidationCallback</ReturnType>
279279
</ReturnValue>
280280
<Docs>
281-
<summary>To be added.</summary>
282-
<value>To be added.</value>
281+
<summary>Gets or sets the callback to validate a server certificate.</summary>
282+
<value>A callback function to validate the server certificate.</value>
283283
<remarks>To be added.</remarks>
284284
</Docs>
285285
</Member>

xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@
7777
<ReturnType>System.Int32</ReturnType>
7878
</ReturnValue>
7979
<Docs>
80-
<summary>To be added.</summary>
81-
<value>To be added.</value>
80+
<summary>Gets the number of bytes that the <see cref="T:System.Net.WebSockets.WebSocket" /> received.</summary>
81+
<value>The number of bytes that the <see cref="T:System.Net.WebSockets.WebSocket" /> received.</value>
8282
<remarks>To be added.</remarks>
8383
</Docs>
8484
</Member>
@@ -102,8 +102,9 @@
102102
<ReturnType>System.Boolean</ReturnType>
103103
</ReturnValue>
104104
<Docs>
105-
<summary>To be added.</summary>
106-
<value>To be added.</value>
105+
<summary>Gets whether the message has been received completely.</summary>
106+
<value>
107+
<see langword="true"/> if the message was received completely; otherwise, <see langword="false"/>.</value>
107108
<remarks>To be added.</remarks>
108109
</Docs>
109110
</Member>
@@ -127,8 +128,8 @@
127128
<ReturnType>System.Net.WebSockets.WebSocketMessageType</ReturnType>
128129
</ReturnValue>
129130
<Docs>
130-
<summary>To be added.</summary>
131-
<value>To be added.</value>
131+
<summary>Gets the type of the current message.</summary>
132+
<value>One of the enumeration values that specifies if the current message is a UTF-8, binary, or close message.</value>
132133
<remarks>To be added.</remarks>
133134
</Docs>
134135
</Member>

xml/System.Net.WebSockets/WebSocket.xml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -683,10 +683,10 @@
683683
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
684684
</Parameters>
685685
<Docs>
686-
<param name="buffer">To be added.</param>
687-
<param name="cancellationToken">To be added.</param>
688-
<summary>To be added.</summary>
689-
<returns>To be added.</returns>
686+
<param name="buffer">The application buffer that is the storage location for the received data.</param>
687+
<param name="cancellationToken">The cancellation token to use to cancel the receive operation.</param>
688+
<summary>Receives data from the <see cref="T:System.Net.WebSockets.WebSocket" /> connection asynchronously.</summary>
689+
<returns>The task object representing the asynchronous operation. The <see cref="P:System.Threading.Tasks.ValueTask`1.Result" /> property on the task object returns a <see cref="T:System.Net.WebSockets.ValueWebSocketReceiveResult" /> object that represents the received data.</returns>
690690
<remarks>To be added.</remarks>
691691
</Docs>
692692
</Member>
@@ -810,12 +810,13 @@
810810
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
811811
</Parameters>
812812
<Docs>
813-
<param name="buffer">To be added.</param>
814-
<param name="messageType">To be added.</param>
815-
<param name="endOfMessage">To be added.</param>
816-
<param name="cancellationToken">To be added.</param>
817-
<summary>To be added.</summary>
818-
<returns>To be added.</returns>
813+
<param name="buffer">The buffer to be sent over the connection.</param>
814+
<param name="messageType">One of the enumeration values that indicates whether the application is sending a binary or text message.</param>
815+
<param name="endOfMessage">
816+
<see langword="true" /> to indicate the data in "buffer" is the last part of a message; otherwise, <see langword="false" />.</param>
817+
<param name="cancellationToken">The cancellation token to use to cancel the send operation.</param>
818+
<summary>Sends data over the <see cref="T:System.Net.WebSockets.WebSocket" /> connection asynchronously.</summary>
819+
<returns>The task object representing the asynchronous operation.</returns>
819820
<remarks>To be added.</remarks>
820821
</Docs>
821822
</Member>

0 commit comments

Comments
 (0)