Skip to content

Port System.Net.WebSockets triple slash comments to Docs #2319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 27, 2019
Merged

Port System.Net.WebSockets triple slash comments to Docs #2319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
65e36a8
Port System.Net.WebSockets triple slash comments to Docs
carlossanlop Apr 16, 2019
4efe7ac
Apply suggestions from code review
carlossanlop Apr 23, 2019
523a3e5
Apply suggestions from code review
mairaw Apr 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions xml/System.Net.WebSockets/ValueWebSocketReceiveResult.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@
<Parameter Name="endOfMessage" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="count">To be added.</param>
<param name="messageType">To be added.</param>
<param name="endOfMessage">To be added.</param>
<summary>To be added.</summary>
<param name="count">The number of bytes that the <see cref="T:System.Net.WebSockets.WebSocket" /> received.</param>
<param name="messageType">One of the enumeration values that indicates whether the current message is a UTF-8 message or a binary message.</param>
<param name="endOfMessage"><see langword="true" /> to indicate the messsage has been received completely; otherwise, <see langword="false" />.</param>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -132,4 +132,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>
14 changes: 7 additions & 7 deletions xml/System.Net.WebSockets/WebSocket.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,12 +400,12 @@
<Parameter Name="keepAliveInterval" Type="System.TimeSpan" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<param name="isServer">To be added.</param>
<param name="subProtocol">To be added.</param>
<param name="keepAliveInterval">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="stream">The stream for the connection.</param>
<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>
<param name="subProtocol">The agreed upon sub-protocol that was used when creating the connection.</param>
<param name="keepAliveInterval">The keep-alive interval to use, or <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> to disable keep-alives.</param>
<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>
<returns>The new web socket.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -933,4 +933,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>