Skip to content

Commit 3bd85b5

Browse files
Finalize docs for new System.Net.Primitives API-s (#9236)
* Port doc comments for System.Net.Primitives * try to handle generic args + inheritdoc * revert * IPaddress * IPAddress fixes * IPNetwork * docs for the new SocketException constructor * Fix spelling * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * revert deletion of ipString --------- Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
1 parent e79cb20 commit 3bd85b5

File tree

3 files changed

+106
-83
lines changed

3 files changed

+106
-83
lines changed

xml/System.Net.Sockets/SocketException.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -222,9 +222,9 @@
222222
<Parameter Name="message" Type="System.String" Index="1" FrameworkAlternate="net-8.0" />
223223
</Parameters>
224224
<Docs>
225-
<param name="errorCode">To be added.</param>
226-
<param name="message">To be added.</param>
227-
<summary>To be added.</summary>
225+
<param name="errorCode">The error code that indicates the error that occurred.</param>
226+
<param name="message">The message that describes the error.</param>
227+
<summary>Initializes a new instance of the <see cref="T:System.Net.Sockets.SocketException" /> class with the specified error code and message.</summary>
228228
<remarks>To be added.</remarks>
229229
</Docs>
230230
</Member>

xml/System.Net/IPAddress.xml

+20-20
Original file line numberDiff line numberDiff line change
@@ -2090,7 +2090,7 @@
20902090
</Parameters>
20912091
<Docs>
20922092
<param name="ipString">A character span that contains an IP address in dotted-quad notation for IPv4 and in colon-hexadecimal notation for IPv6.</param>
2093-
<param name="ipSpan">To be added.</param>
2093+
<param name="ipSpan">A character span that contains an IP address in dotted-quad notation for IPv4 and in colon-hexadecimal notation for IPv6.</param>
20942094
<summary>Converts an IP address represented as a character span to an <see cref="T:System.Net.IPAddress" /> instance.</summary>
20952095
<returns>The converted IP address.</returns>
20962096
<remarks>To be added.</remarks>
@@ -2301,11 +2301,11 @@
23012301
</Parameter>
23022302
</Parameters>
23032303
<Docs>
2304-
<param name="s">To be added.</param>
2305-
<param name="provider">To be added.</param>
2306-
<param name="result">To be added.</param>
2307-
<summary>To be added.</summary>
2308-
<returns>To be added.</returns>
2304+
<param name="s">The string to parse.</param>
2305+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
2306+
<param name="result">When this method returns, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
2307+
<summary>Tries to parse a string into an <see cref="T:System.Net.IPAddress" />.</summary>
2308+
<returns><see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
23092309
<remarks>To be added.</remarks>
23102310
</Docs>
23112311
</Member>
@@ -2422,11 +2422,11 @@
24222422
<Parameter Name="result" Type="System.Net.IPAddress" RefType="out" Index="2" FrameworkAlternate="net-8.0" />
24232423
</Parameters>
24242424
<Docs>
2425-
<param name="s">To be added.</param>
2426-
<param name="provider">To be added.</param>
2427-
<param name="result">To be added.</param>
2428-
<summary>To be added.</summary>
2429-
<returns>To be added.</returns>
2425+
<param name="s">The span of characters to parse.</param>
2426+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
2427+
<param name="result">When this method returns, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
2428+
<summary>Tries to parse a span of characters into a value.</summary>
2429+
<returns><see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
24302430
<remarks>To be added.</remarks>
24312431
</Docs>
24322432
</Member>
@@ -2561,10 +2561,10 @@
25612561
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" Index="1" FrameworkAlternate="net-8.0" />
25622562
</Parameters>
25632563
<Docs>
2564-
<param name="utf8Destination">To be added.</param>
2565-
<param name="bytesWritten">To be added.</param>
2566-
<summary>To be added.</summary>
2567-
<returns>To be added.</returns>
2564+
<param name="utf8Destination">The span into which to write the IP address as a span of UTF-8 bytes.</param>
2565+
<param name="bytesWritten">>When this method returns, the number of bytes written into the <paramref name="utf8Destination"/>.</param>
2566+
<summary>Tries to format the current IP address into the provided span.</summary>
2567+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
25682568
<remarks>To be added.</remarks>
25692569
</Docs>
25702570
</Member>
@@ -2679,7 +2679,7 @@
26792679
</Parameter>
26802680
</Parameters>
26812681
<Docs>
2682-
<param name="ipString">The string to validate.</param>
2682+
<param name="ipString">The string to parse.</param>
26832683
<param name="address">The <see cref="T:System.Net.IPAddress" /> version of the string.</param>
26842684
<summary>Determines whether a string is a valid IP address.</summary>
26852685
<returns>
@@ -2775,12 +2775,12 @@
27752775
</Parameter>
27762776
</Parameters>
27772777
<Docs>
2778-
<param name="ipString">The byte span to validate.</param>
2778+
<param name="ipString">The byte span to parse.</param>
2779+
<param name="ipSpan">The byte span to parse.</param>
27792780
<param name="address">When this method returns, the <see cref="T:System.Net.IPAddress" /> version of the byte span.</param>
2780-
<param name="ipSpan">To be added.</param>
2781-
<summary>Determines whether the specified byte span represents a valid IP address.</summary>
2781+
<summary>Tries to parse a span of characters into a value.</summary>
27822782
<returns>
2783-
<see langword="true" /> if <paramref name="ipString" /> was able to be parsed as an IP address; otherwise, <see langword="false" />.</returns>
2783+
<see langword="true" /> if <paramref name="ipSpan" /> was able to be parsed as an IP address; otherwise, <see langword="false" />.</returns>
27842784
<remarks>To be added.</remarks>
27852785
</Docs>
27862786
</Member>

0 commit comments

Comments
 (0)