From 2648b07882137c06cec2b7eef606f2e25515d742 Mon Sep 17 00:00:00 2001 From: David Cantu Date: Tue, 1 Oct 2019 17:11:35 -0700 Subject: [PATCH 1/4] Added documentation for APIs in System.Net namespace introduced in 2.x --- xml/System.Net/FtpWebResponse.xml | 14 ++++-- xml/System.Net/HttpVersion.xml | 4 +- xml/System.Net/IPAddress.xml | 74 ++++++++++++++++++++++--------- 3 files changed, 65 insertions(+), 27 deletions(-) diff --git a/xml/System.Net/FtpWebResponse.xml b/xml/System.Net/FtpWebResponse.xml index 816f8d463c2..d1543512379 100644 --- a/xml/System.Net/FtpWebResponse.xml +++ b/xml/System.Net/FtpWebResponse.xml @@ -247,9 +247,17 @@ System.String - To be added. - To be added. - To be added. + Always throws a . + Always throws a . + + and classes. There is no reason to use it. + + ]]> + + Content type information is not implemented for FTP. diff --git a/xml/System.Net/HttpVersion.xml b/xml/System.Net/HttpVersion.xml index 41cb108ad0e..2393e07cb6d 100644 --- a/xml/System.Net/HttpVersion.xml +++ b/xml/System.Net/HttpVersion.xml @@ -102,7 +102,7 @@ System.Version - To be added. + Defines a instance for an unknown HTTP version. To be added. @@ -196,7 +196,7 @@ System.Version - To be added. + Defines a instance for HTTP 2.0. To be added. diff --git a/xml/System.Net/IPAddress.xml b/xml/System.Net/IPAddress.xml index 738ea9394f5..7e330a4ebc2 100644 --- a/xml/System.Net/IPAddress.xml +++ b/xml/System.Net/IPAddress.xml @@ -196,9 +196,22 @@ - To be added. - To be added. - To be added. + The byte span value of the IP address. + Initializes a new instance of the class with the address specified as a byte span. + + is created with the property set to `address`. + + If the length of `address` is 4, this method constructs an IPv4 address; otherwise, an IPv6 address with a scope of 0 is constructed. + + The byte span is assumed to be in network byte order with the most significant byte first in index position 0. + + ]]> + + + contains a bad IP address. @@ -285,10 +298,25 @@ - To be added. - To be added. - To be added. - To be added. + The byte span value of the IP address. + The long value of the scope identifier. + Initializes a new instance of the class with the address specified as a byte span and the specified scope identifier. + + + + + contains a bad IP address. + + < 0 +- or - + > 0x00000000FFFFFFFF @@ -1686,10 +1714,12 @@ - To be added. - To be added. - To be added. + A character span that contains an IP address in dotted-quad notation for IPv4 and in colon-hexadecimal notation for IPv6. + Converts an IP address represented as a character span to an IPAddress instance. + An instance. To be added. + + is not a valid IP address. @@ -1917,10 +1947,10 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, the IP address as a span of characters. + When this method returns, the number of characters written into the span. + Tries to format the current IP address into the provided span. + if the formatting was successful; otherwise, . To be added. @@ -1954,10 +1984,10 @@ - To be added. - To be added. - To be added. - To be added. + The byte span to validate. + The version of the byte span. + Determines whether a byte span represents a valid IP address. + if was able to be parsed as an IP address; otherwise, . To be added. @@ -2044,10 +2074,10 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, the IP address as a span of bytes. + When this method returns, the number of bytes written into the span. + Tries to write the current IP address into a span of bytes. + if the IP address is sucessfully written to the given span; otherwise, . To be added. From c0d7a4926582a8df39b2bfd9c0ed18ac623082cf Mon Sep 17 00:00:00 2001 From: David Cantu Date: Wed, 20 Nov 2019 16:58:03 -0800 Subject: [PATCH 2/4] Apply some suggestions from code review Co-Authored-By: Maira Wenzel Co-Authored-By: Cory Nelson --- xml/System.Net/FtpWebResponse.xml | 9 +++++---- xml/System.Net/IPAddress.xml | 14 ++++++++------ 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/xml/System.Net/FtpWebResponse.xml b/xml/System.Net/FtpWebResponse.xml index d1543512379..c402bdaa5c8 100644 --- a/xml/System.Net/FtpWebResponse.xml +++ b/xml/System.Net/FtpWebResponse.xml @@ -247,17 +247,18 @@ System.String - Always throws a . - Always throws a . + Throws a in all cases. + Throws a in all cases. and classes. There is no reason to use it. + +This property is provided only for compatibility with other implementations of the and classes. ]]> - Content type information is not implemented for FTP. + In all cases. diff --git a/xml/System.Net/IPAddress.xml b/xml/System.Net/IPAddress.xml index 7e330a4ebc2..5d6b591c977 100644 --- a/xml/System.Net/IPAddress.xml +++ b/xml/System.Net/IPAddress.xml @@ -196,7 +196,7 @@ - The byte span value of the IP address. + The byte representation of the IP address, in network byte order. Initializes a new instance of the class with the address specified as a byte span. contains a bad IP address. < 0 -- or - + +-or- + > 0x00000000FFFFFFFF @@ -1715,8 +1717,8 @@ A character span that contains an IP address in dotted-quad notation for IPv4 and in colon-hexadecimal notation for IPv6. - Converts an IP address represented as a character span to an IPAddress instance. - An instance. + Converts an IP address represented as a character span to an instance. + The converted IP address. To be added. is not a valid IP address. @@ -1985,8 +1987,8 @@ The byte span to validate. - The version of the byte span. - Determines whether a byte span represents a valid IP address. + When this method returns, the version of the byte span. + Determines whether the specified byte span represents a valid IP address. if was able to be parsed as an IP address; otherwise, . To be added. From 592b8db59a09c0bb34d0e998bd998a5a41a966c6 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Thu, 21 Nov 2019 17:07:51 -0800 Subject: [PATCH 3/4] avoid CI edit --- xml/System.Net/IPAddress.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/xml/System.Net/IPAddress.xml b/xml/System.Net/IPAddress.xml index 5d6b591c977..445dcf019a6 100644 --- a/xml/System.Net/IPAddress.xml +++ b/xml/System.Net/IPAddress.xml @@ -2079,7 +2079,8 @@ When this method returns, the IP address as a span of bytes. When this method returns, the number of bytes written into the span. Tries to write the current IP address into a span of bytes. - if the IP address is sucessfully written to the given span; otherwise, . + + if the IP address is sucessfully written to the given span; otherwise, . To be added. From e274e0cb1dd0637f04305bf2118198f5947c8f1d Mon Sep 17 00:00:00 2001 From: David Cantu Date: Fri, 22 Nov 2019 16:31:21 -0800 Subject: [PATCH 4/4] Address moving paragraph from remarks to param tag --- xml/System.Net/IPAddress.xml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/xml/System.Net/IPAddress.xml b/xml/System.Net/IPAddress.xml index 445dcf019a6..a0b002a25e8 100644 --- a/xml/System.Net/IPAddress.xml +++ b/xml/System.Net/IPAddress.xml @@ -196,7 +196,7 @@ - The byte representation of the IP address, in network byte order. + The byte representation of the IP address, in network byte order, with the most significant byte first in index position 0. Initializes a new instance of the class with the address specified as a byte span.