Skip to content

Commit f51cd41

Browse files
jozkeeRon Petrusha
authored andcommitted
Added documentation for System.Net.Sockets APIs targeted for 3.0 (#2767)
* Added documentation for System.Net.Sockets APIs targeted for 3.0 * Addressed comments Removed "%2A" from properties. On ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken), removed unnecessary exceptions. * Addressing more commnets: * standarizing summaries of SendPacketElements.ctors * Adding note to SafeSocketHandle, related to dotnet/corefx#39677
1 parent d20148e commit f51cd41

File tree

7 files changed

+388
-143
lines changed

7 files changed

+388
-143
lines changed

xml/System.Net.Sockets/AddressFamily.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@
300300
</ReturnValue>
301301
<MemberValue>32</MemberValue>
302302
<Docs>
303-
<summary>To be added.</summary>
303+
<summary>Controller Area Network address.</summary>
304304
</Docs>
305305
</Member>
306306
<Member MemberName="DataKit">
@@ -920,7 +920,7 @@
920920
</ReturnValue>
921921
<MemberValue>30</MemberValue>
922922
<Docs>
923-
<summary>To be added.</summary>
923+
<summary>Netlink address.</summary>
924924
</Docs>
925925
</Member>
926926
<Member MemberName="NetworkDesigners">
@@ -1060,7 +1060,7 @@
10601060
</ReturnValue>
10611061
<MemberValue>31</MemberValue>
10621062
<Docs>
1063-
<summary>To be added.</summary>
1063+
<summary>Low-level Packet address.</summary>
10641064
</Docs>
10651065
</Member>
10661066
<Member MemberName="Pup">

xml/System.Net.Sockets/NetworkStream.xml

Lines changed: 236 additions & 72 deletions
Large diffs are not rendered by default.

xml/System.Net.Sockets/ProtocolFamily.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@
261261
</ReturnValue>
262262
<MemberValue>32</MemberValue>
263263
<Docs>
264-
<summary>To be added.</summary>
264+
<summary>Controller Area Network protocol.</summary>
265265
</Docs>
266266
</Member>
267267
<Member MemberName="DataKit">
@@ -815,7 +815,7 @@
815815
</ReturnValue>
816816
<MemberValue>30</MemberValue>
817817
<Docs>
818-
<summary>To be added.</summary>
818+
<summary>Netlink protocol.</summary>
819819
</Docs>
820820
</Member>
821821
<Member MemberName="NetworkDesigners">
@@ -940,7 +940,7 @@
940940
</ReturnValue>
941941
<MemberValue>31</MemberValue>
942942
<Docs>
943-
<summary>To be added.</summary>
943+
<summary>Low-level Packet protocol.</summary>
944944
</Docs>
945945
</Member>
946946
<Member MemberName="Pup">

xml/System.Net.Sockets/SafeSocketHandle.xml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,16 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
18-
<remarks>To be added.</remarks>
17+
<summary>Represents a wrapper class for a socket handle.</summary>
18+
<remarks>
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
23+
This class is derived from <xref:Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid>. A value of 0 or -1 is an invalid socket handle.
24+
25+
]]></format>
26+
</remarks>
1927
</Docs>
2028
<Members>
2129
<Member MemberName=".ctor">
@@ -35,9 +43,9 @@
3543
<Parameter Name="ownsHandle" Type="System.Boolean" Index="1" FrameworkAlternate="netcore-3.0" />
3644
</Parameters>
3745
<Docs>
38-
<param name="preexistingHandle">To be added.</param>
39-
<param name="ownsHandle">To be added.</param>
40-
<summary>To be added.</summary>
46+
<param name="preexistingHandle">The pre-existing handle to use.</param>
47+
<param name="ownsHandle"><see langword="true" /> to reliably release the handle during the finalization phase; <see langword="false" /> to prevent reliable release (not recommended).</param>
48+
<summary>Initializes a new instance of the <see cref="T:System.Net.Sockets.SafeSocketHandle" /> class.</summary>
4149
<remarks>To be added.</remarks>
4250
</Docs>
4351
</Member>

xml/System.Net.Sockets/SendPacketsElement.xml

Lines changed: 120 additions & 54 deletions
Large diffs are not rendered by default.

xml/System.Net.Sockets/Socket.xml

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8341,9 +8341,16 @@ The GetHashCode method returns a hash code of this instance. This value can be u
83418341
<ReturnType>System.Net.Sockets.SafeSocketHandle</ReturnType>
83428342
</ReturnValue>
83438343
<Docs>
8344-
<summary>To be added.</summary>
8345-
<value>To be added.</value>
8346-
<remarks>To be added.</remarks>
8344+
<summary>Gets a <see cref="T:System.Net.Sockets.SafeSocketHandle" /> that represents the socket handle that the current <see cref="T:System.Net.Sockets.Socket" /> object encapsulates.</summary>
8345+
<value>A socket handle exposed in a safe manner for the socket that the current <see cref="T:System.Net.Sockets.Socket" /> object encapsulates.</value>
8346+
<remarks>
8347+
<format type="text/markdown"><![CDATA[
8348+
8349+
> [!IMPORTANT]
8350+
> Using the <xref:System.Net.Sockets.SafeSocketHandle> to operate on the socket directly may result in an undocumented state.
8351+
8352+
]]></format>
8353+
</remarks>
83478354
</Docs>
83488355
</Member>
83498356
<Member MemberName="Select">

xml/System.Net.Sockets/SocketOptionName.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1425,7 +1425,7 @@
14251425
</ReturnValue>
14261426
<MemberValue>17</MemberValue>
14271427
<Docs>
1428-
<summary>To be added.</summary>
1428+
<summary>The number of seconds a TCP connection will wait for a keepalive response before sending another keepalive probe.</summary>
14291429
</Docs>
14301430
</Member>
14311431
<Member MemberName="TcpKeepAliveRetryCount">
@@ -1451,7 +1451,7 @@
14511451
</ReturnValue>
14521452
<MemberValue>16</MemberValue>
14531453
<Docs>
1454-
<summary>To be added.</summary>
1454+
<summary>The number of TCP keep alive probes that will be sent before the connection is terminated.</summary>
14551455
</Docs>
14561456
</Member>
14571457
<Member MemberName="TcpKeepAliveTime">
@@ -1477,7 +1477,7 @@
14771477
</ReturnValue>
14781478
<MemberValue>3</MemberValue>
14791479
<Docs>
1480-
<summary>To be added.</summary>
1480+
<summary>The number of seconds a TCP connection will remain alive/idle before keepalive probes are sent to the remote.</summary>
14811481
</Docs>
14821482
</Member>
14831483
<Member MemberName="Type">

0 commit comments

Comments
 (0)