From 624cc2b6164dca225c1d944e9fd265e2a40d340e Mon Sep 17 00:00:00 2001 From: David Cantu Date: Fri, 28 Jun 2019 16:15:07 -0700 Subject: [PATCH 1/7] Added documentation for new APIs released in 3.0 --- xml/System.Net/CookieCollection.xml | 51 +++++++++++++++----- xml/System.Net/FileWebRequest.xml | 45 +++++++++++++++--- xml/System.Net/IPEndPoint.xml | 72 ++++++++++++++++++++++------- 3 files changed, 134 insertions(+), 34 deletions(-) diff --git a/xml/System.Net/CookieCollection.xml b/xml/System.Net/CookieCollection.xml index 0bf81b627ed..b4e8212cbb6 100644 --- a/xml/System.Net/CookieCollection.xml +++ b/xml/System.Net/CookieCollection.xml @@ -257,7 +257,7 @@ - To be added. + Removes all elements from the . To be added. @@ -291,10 +291,18 @@ - To be added. - To be added. - To be added. - To be added. + The to locate in the . + Determines whether the is in the . + if is found in the ; otherwise, is . + + , and match. +The comparison for and is case-insensitive. +The comparison for is case-sensitive. + ]]> + @@ -778,10 +786,20 @@ - To be added. - To be added. - To be added. - To be added. + The to remove form the . + Determines whether the is in the . + if item was successfully removed from the ; otherwise, . This method also returns if item is not found in the original collection. + + , and match. + +The comparison for and is case-insensitive. + +The comparison for is case-sensitive. + ]]> + @@ -860,9 +878,18 @@ - To be added. - To be added. - To be added. + Gets an that can iterate through a . + An instance of an implementation of an interface that can iterate through a . + + only to read data in the collection. Enumerators cannot be used to modify the underlying collection. The enumerator does not have exclusive access to the collection. + + When an enumerator is created, it takes a snapshot of the current state of the collection. If changes are made to the collection, such as adding, modifying, or deleting elements, this snapshot gets out of sync and the enumerator throws an . Two enumerators created from the same collection at the same time can produce different snapshots of the collection. + + ]]> + diff --git a/xml/System.Net/FileWebRequest.xml b/xml/System.Net/FileWebRequest.xml index 2c2f6efdef9..87b8e199481 100644 --- a/xml/System.Net/FileWebRequest.xml +++ b/xml/System.Net/FileWebRequest.xml @@ -717,9 +717,29 @@ - To be added. - To be added. - To be added. + Returns a object for writing data to the file system resource as an asynchronous operation. + The Task object representing the asynchronous operation. + + [!NOTE] + > In the case of asynchronous requests, it is the responsibility of the client application to implement its own time-out mechanism. + ]]> + + + + The stream is being used by a previous call to . + +-or- + +The stream already received a response previous to your request. + + + The property is GET or HEAD. + + + The was aborted. + @@ -799,9 +819,22 @@ - To be added. - To be added. - To be added. + Returns a response to a file system request as an asynchronous operation. + The Task object representing the asynchronous operation. + + [!NOTE] + > In the case of asynchronous requests, it is the responsibility of the client application to implement its own time-out mechanism. + ]]> + + + + The stream is already in use by a previous call to + + + The was aborted. + diff --git a/xml/System.Net/IPEndPoint.xml b/xml/System.Net/IPEndPoint.xml index df1feaf4e24..1f9833a836c 100644 --- a/xml/System.Net/IPEndPoint.xml +++ b/xml/System.Net/IPEndPoint.xml @@ -568,10 +568,12 @@ - To be added. - To be added. - To be added. + A that contains an IP endpoint in dotted-quad notation or network byte order for IPv4 and in colon-hexadecimal notation for IPv6. + Converts an IP network endpoint (address and port) represented as a to an IPEndPoint instance. + An instance. To be added. + is . + is not a valid IP endpoint. @@ -602,10 +604,30 @@ - To be added. - To be added. - To be added. - To be added. + A that contains an IP endpoint in dotted-quad notation or network byte order for IPv4 and in colon-hexadecimal notation for IPv6. + Converts an IP network endpoint (address and port) represented as a to an IPEndPoint instance. + An instance. + + + + is . + is not a valid IP endpoint. @@ -793,10 +815,10 @@ - To be added. - To be added. - To be added. - To be added. + The IP endpoint to validate. + The version of . + Determines whether is a valid IP endpoint. + if was able to be parsed as an IP endpoint; otherwise, . To be added. @@ -829,11 +851,29 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The IP endpoint to validate. + The version of . + Determines whether is a valid IP endpoint. + if was able to be parsed as an IP endpoint; otherwise, . + + + From 0f5457e4d8b89c90fdcc9415829fcf59b89bb697 Mon Sep 17 00:00:00 2001 From: David Cantu Date: Mon, 1 Jul 2019 14:56:17 -0700 Subject: [PATCH 2/7] Addressing PR comments. --- xml/System.Net/CookieCollection.xml | 6 +- xml/System.Net/FileWebRequest.xml | 6 +- xml/System.Net/IPEndPoint.xml | 130 ++++++++++++++++++---------- 3 files changed, 91 insertions(+), 51 deletions(-) diff --git a/xml/System.Net/CookieCollection.xml b/xml/System.Net/CookieCollection.xml index b4e8212cbb6..141f404b088 100644 --- a/xml/System.Net/CookieCollection.xml +++ b/xml/System.Net/CookieCollection.xml @@ -257,7 +257,7 @@ - Removes all elements from the . + Removes all elements from the object. To be added. @@ -293,7 +293,7 @@ The to locate in the . Determines whether the is in the . - if is found in the ; otherwise, is . + if is found in the ; otherwise, . is case-sensitive. The to remove form the . Determines whether the is in the . - if item was successfully removed from the ; otherwise, . This method also returns if item is not found in the original collection. + if was successfully removed from the ; otherwise, . This method also returns if item is not found in the original collection. Returns a object for writing data to the file system resource as an asynchronous operation. - The Task object representing the asynchronous operation. + The object representing the asynchronous operation. The stream is being used by a previous call to . - + -or- The stream already received a response previous to your request. @@ -820,7 +820,7 @@ The stream already received a response previous to your request. Returns a response to a file system request as an asynchronous operation. - The Task object representing the asynchronous operation. + The object representing the asynchronous operation. + + + System.Net.Primitives + 4.1.1.0 + + + netstandard + + + System + + + System.Net + + + To be added. + + [!IMPORTANT] +> Note that this method accepts as valid a value that can be parsed as an Int64, and then treats that Int64 as the long value of an IP address in network byte order, similar to the way that the IPAddress constructor does. This means that this method returns true if the Int64 is parsed successfully, even if it represents an address that's not a valid IP address. For example, if s is "1", this method returns true even though "1" (or 0.0.0.1) is not a valid IP address and you might expect this method to return false. Fixing this bug would break existing apps, so the current behavior will not be changed. Your code can avoid this behavior by ensuring that it only uses this method to parse IP addresses in dotted-decimal format. + +Literal IPv6 addresses require to be enclosed in square brackets [] when passing an endpoint that specifies a port number; otherwise, square braces are not mandatory. + + ]]> + + + @@ -568,9 +606,9 @@ - A that contains an IP endpoint in dotted-quad notation or network byte order for IPv4 and in colon-hexadecimal notation for IPv6. - Converts an IP network endpoint (address and port) represented as a to an IPEndPoint instance. - An instance. + A that contains an IP endpoint in dotted-quad notation or network byte order for IPv4 and in colon-hexadecimal notation for IPv6. + Converts an IP network endpoint (address and port) represented as a to an instance. + The object representation of an IP network endpoint. To be added. is . is not a valid IP endpoint. @@ -605,27 +643,9 @@ A that contains an IP endpoint in dotted-quad notation or network byte order for IPv4 and in colon-hexadecimal notation for IPv6. - Converts an IP network endpoint (address and port) represented as a to an IPEndPoint instance. - An instance. - - - + Converts an IP network endpoint (address and port) represented as a to an instance. + The object representation of an IP network endpoint + To be added. is . is not a valid IP endpoint. @@ -786,6 +806,44 @@ Literal IPv6 addresses require to be enclosed in square brackets [] when passing + + + System.Net.Primitives + 4.1.1.0 + + + netstandard + + + System + + + System.Net + + + To be added. + + [!IMPORTANT] +> Note that this method accepts as valid a value that can be parsed as an Int64, and then treats that Int64 as the long value of an IP address in network byte order, similar to the way that the IPAddress constructor does. This means that this method returns true if the Int64 is parsed successfully, even if it represents an address that's not a valid IP address. For example, if s is "1", this method returns true even though "1" (or 0.0.0.1) is not a valid IP address and you might expect this method to return false. Fixing this bug would break existing apps, so the current behavior will not be changed. Your code can avoid this behavior by ensuring that it only uses this method to parse IP addresses in dotted-decimal format. + +Literal IPv6 addresses require to be enclosed in square brackets [] when passing an endpoint that specifies a port number; otherwise, square braces are not mandatory. + + ]]> + + + @@ -818,7 +876,7 @@ Literal IPv6 addresses require to be enclosed in square brackets [] when passing The IP endpoint to validate. The version of . Determines whether is a valid IP endpoint. - if was able to be parsed as an IP endpoint; otherwise, . + if can be parsed as an IP endpoint; otherwise, . To be added. @@ -854,26 +912,8 @@ Literal IPv6 addresses require to be enclosed in square brackets [] when passing The IP endpoint to validate. The version of . Determines whether is a valid IP endpoint. - if was able to be parsed as an IP endpoint; otherwise, . - - - + if can be parsed as an IP endpoint; otherwise, . + To be added. From 01de1671eab04ceba658542c948e9f0d249a17f9 Mon Sep 17 00:00:00 2001 From: David Cantu Date: Fri, 19 Jul 2019 09:28:04 -0700 Subject: [PATCH 3/7] Addressed more PR comments. --- xml/System.Net/FileWebRequest.xml | 22 ++++++---------------- xml/System.Net/IPEndPoint.xml | 28 +--------------------------- 2 files changed, 7 insertions(+), 43 deletions(-) diff --git a/xml/System.Net/FileWebRequest.xml b/xml/System.Net/FileWebRequest.xml index b62c13e3e20..9f126823bd6 100644 --- a/xml/System.Net/FileWebRequest.xml +++ b/xml/System.Net/FileWebRequest.xml @@ -727,19 +727,13 @@ ]]> - - The stream is being used by a previous call to . + The stream is being used by a previous call to . -or- -The stream already received a response previous to your request. - - - The property is GET or HEAD. - - - The was aborted. - +The stream already received a response previous to your request. + The property is GET or HEAD. + The was aborted. @@ -829,12 +823,8 @@ The stream already received a response previous to your request. ]]> - - The stream is already in use by a previous call to - - - The was aborted. - + The stream is already in use by a previous call to . + The was aborted. diff --git a/xml/System.Net/IPEndPoint.xml b/xml/System.Net/IPEndPoint.xml index cceb00db5c5..c5b7f2a8a75 100644 --- a/xml/System.Net/IPEndPoint.xml +++ b/xml/System.Net/IPEndPoint.xml @@ -541,19 +541,6 @@ - - System.Net.Primitives - 4.1.1.0 - - - netstandard - - - System - - - System.Net - To be added. @@ -644,7 +631,7 @@ Literal IPv6 addresses require to be enclosed in square brackets [] when passing A that contains an IP endpoint in dotted-quad notation or network byte order for IPv4 and in colon-hexadecimal notation for IPv6. Converts an IP network endpoint (address and port) represented as a to an instance. - The object representation of an IP network endpoint + The object representation of an IP network endpoint. To be added. is . is not a valid IP endpoint. @@ -807,19 +794,6 @@ Literal IPv6 addresses require to be enclosed in square brackets [] when passing - - System.Net.Primitives - 4.1.1.0 - - - netstandard - - - System - - - System.Net - To be added. From 254ba7acc8a941bfd83fe0268be863a82d6b6221 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 6 Aug 2019 15:19:21 -0700 Subject: [PATCH 4/7] Update CookieCollection.xml --- xml/System.Net/CookieCollection.xml | 33 ++++++++++++++++------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/xml/System.Net/CookieCollection.xml b/xml/System.Net/CookieCollection.xml index 141f404b088..25d5600dbf6 100644 --- a/xml/System.Net/CookieCollection.xml +++ b/xml/System.Net/CookieCollection.xml @@ -291,9 +291,9 @@ - The to locate in the . - Determines whether the is in the . - if is found in the ; otherwise, . + The cookie to locate in the . + Determines whether the specified cookie is in the . + if the specified cookie is found in the ; otherwise, . , and match. The comparison for and is case-insensitive. The comparison for is case-sensitive. + ]]> @@ -353,9 +354,9 @@ The comparison for is case-sensitive. - The target to which the will be copied. - The zero-based index in the target where copying begins. - Copies the elements of a to an instance of the class, starting at a particular index. + The target array to which the will be copied. + The zero-based index in the target array where copying begins. + Copies the elements of a to the specified array, starting at a particular index. is case-sensitive. The target array to which the will be copied. - The zero-based index in the target where copying begins. + The zero-based index in the target array where copying begins. Copies the elements of this to a array starting at the specified index of the target array. `array` parameter must be one-dimensional with zero-based indexing. + The `array` parameter must be one-dimensional with zero-based indexing. ]]> @@ -523,7 +524,7 @@ The comparison for is case-sensitive. Gets an enumerator that can iterate through a . - An instance of an implementation of an interface that can iterate through a . + An for this collection. is case-sensitive. - The to remove form the . - Determines whether the is in the . + The cookie to remove from the . + Removes the specified cookie from the . if was successfully removed from the ; otherwise, . This method also returns if item is not found in the original collection. is case-sensitive. - Gets an that can iterate through a . - An instance of an implementation of an interface that can iterate through a . + Gets an enumerator that can iterate through the . + An for this collection. is case-sensitive. You should use an only to read data in the collection. Enumerators cannot be used to modify the underlying collection. The enumerator does not have exclusive access to the collection. When an enumerator is created, it takes a snapshot of the current state of the collection. If changes are made to the collection, such as adding, modifying, or deleting elements, this snapshot gets out of sync and the enumerator throws an . Two enumerators created from the same collection at the same time can produce different snapshots of the collection. - + + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. + ]]> @@ -1001,4 +1004,4 @@ The comparison for is case-sensitive. - \ No newline at end of file + From 00ddc1879317fcaa92de97d5ccfa8e3e5e2704f3 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 6 Aug 2019 15:23:37 -0700 Subject: [PATCH 5/7] Update FileWebRequest.xml --- xml/System.Net/FileWebRequest.xml | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/xml/System.Net/FileWebRequest.xml b/xml/System.Net/FileWebRequest.xml index 9f126823bd6..47152ca0bcb 100644 --- a/xml/System.Net/FileWebRequest.xml +++ b/xml/System.Net/FileWebRequest.xml @@ -717,13 +717,16 @@ - Returns a object for writing data to the file system resource as an asynchronous operation. - The object representing the asynchronous operation. + Returns a stream for writing data to the file system resource as an asynchronous operation. + The task object representing the asynchronous operation. [!NOTE] - > In the case of asynchronous requests, it is the responsibility of the client application to implement its own time-out mechanism. + +## Remarks + +> [!NOTE] +> In the case of asynchronous requests, the client application is responsible for implementing its own time-out mechanism. + ]]> @@ -814,12 +817,15 @@ The stream already received a response previous to your request. Returns a response to a file system request as an asynchronous operation. - The object representing the asynchronous operation. + The task object representing the asynchronous operation. [!NOTE] - > In the case of asynchronous requests, it is the responsibility of the client application to implement its own time-out mechanism. + +## Remarks + +> [!NOTE] +> In the case of asynchronous requests, the client application is responsible for implementing its own time-out mechanism. + ]]> @@ -1221,4 +1227,4 @@ The stream already received a response previous to your request. - \ No newline at end of file + From be3c4b3acad4cc2452f08f31d85cf51fad4b3523 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 6 Aug 2019 15:48:39 -0700 Subject: [PATCH 6/7] Update IPEndPoint.xml --- xml/System.Net/IPEndPoint.xml | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/xml/System.Net/IPEndPoint.xml b/xml/System.Net/IPEndPoint.xml index c5b7f2a8a75..343e7aaf1bb 100644 --- a/xml/System.Net/IPEndPoint.xml +++ b/xml/System.Net/IPEndPoint.xml @@ -547,8 +547,8 @@ [!IMPORTANT] -> Note that this method accepts as valid a value that can be parsed as an Int64, and then treats that Int64 as the long value of an IP address in network byte order, similar to the way that the IPAddress constructor does. This means that this method returns true if the Int64 is parsed successfully, even if it represents an address that's not a valid IP address. For example, if s is "1", this method returns true even though "1" (or 0.0.0.1) is not a valid IP address and you might expect this method to return false. Fixing this bug would break existing apps, so the current behavior will not be changed. Your code can avoid this behavior by ensuring that it only uses this method to parse IP addresses in dotted-decimal format. +> Note that this method accepts as valid a value that can be parsed as an , and then treats that as the long value of an IP address in network byte order, similar to the way that the IPAddress constructor does. This means that this method returns true if the Int64 is parsed successfully, even if it represents an address that's not a valid IP address. For example, if s is "1", this method returns true even though "1" (or 0.0.0.1) is not a valid IP address and you might expect this method to return false. Fixing this bug would break existing apps, so the current behavior will not be changed. Your code can avoid this behavior by ensuring that it only uses this method to parse IP addresses in dotted-decimal format. Literal IPv6 addresses require to be enclosed in square brackets [] when passing an endpoint that specifies a port number; otherwise, square braces are not mandatory. @@ -593,8 +594,8 @@ Literal IPv6 addresses require to be enclosed in square brackets [] when passing - A that contains an IP endpoint in dotted-quad notation or network byte order for IPv4 and in colon-hexadecimal notation for IPv6. - Converts an IP network endpoint (address and port) represented as a to an instance. + A read-only span that contains an IP endpoint in dotted-quad notation or network byte order for IPv4 and in colon-hexadecimal notation for IPv6. + Converts an IP network endpoint (address and port) represented as a read-only span to an instance. The object representation of an IP network endpoint. To be added. is . @@ -629,8 +630,8 @@ Literal IPv6 addresses require to be enclosed in square brackets [] when passing - A that contains an IP endpoint in dotted-quad notation or network byte order for IPv4 and in colon-hexadecimal notation for IPv6. - Converts an IP network endpoint (address and port) represented as a to an instance. + A string that contains an IP endpoint in dotted-quad notation or network byte order for IPv4 and in colon-hexadecimal notation for IPv6. + Converts an IP network endpoint (address and port) represented as a string to an instance. The object representation of an IP network endpoint. To be added. is . @@ -800,8 +801,7 @@ Literal IPv6 addresses require to be enclosed in square brackets [] when passing [!IMPORTANT] -> Note that this method accepts as valid a value that can be parsed as an Int64, and then treats that Int64 as the long value of an IP address in network byte order, similar to the way that the IPAddress constructor does. This means that this method returns true if the Int64 is parsed successfully, even if it represents an address that's not a valid IP address. For example, if s is "1", this method returns true even though "1" (or 0.0.0.1) is not a valid IP address and you might expect this method to return false. Fixing this bug would break existing apps, so the current behavior will not be changed. Your code can avoid this behavior by ensuring that it only uses this method to parse IP addresses in dotted-decimal format. +> Note that this method accepts as valid a value that can be parsed as an , and then treats that as the long value of an IP address in network byte order, similar to the way that the IPAddress constructor does. This means that this method returns true if the Int64 is parsed successfully, even if it represents an address that's not a valid IP address. For example, if s is "1", this method returns true even though "1" (or 0.0.0.1) is not a valid IP address and you might expect this method to return false. Fixing this bug would break existing apps, so the current behavior will not be changed. Your code can avoid this behavior by ensuring that it only uses this method to parse IP addresses in dotted-decimal format. Literal IPv6 addresses require to be enclosed in square brackets [] when passing an endpoint that specifies a port number; otherwise, square braces are not mandatory. @@ -848,8 +849,8 @@ Literal IPv6 addresses require to be enclosed in square brackets [] when passing The IP endpoint to validate. - The version of . - Determines whether is a valid IP endpoint. + When this method returns, the version of . + Tries to convert an IP network endpoint (address and port) represented as a read-only span to its equivalent, and returns a value that indicates whether the conversion succeeded. if can be parsed as an IP endpoint; otherwise, . To be added. @@ -884,11 +885,11 @@ Literal IPv6 addresses require to be enclosed in square brackets [] when passing The IP endpoint to validate. - The version of . - Determines whether is a valid IP endpoint. + When this method returns, the version of . + Tries to convert an IP network endpoint (address and port) represented as a string to its equivalent, and returns a value that indicates whether the conversion succeeded. if can be parsed as an IP endpoint; otherwise, . To be added. - \ No newline at end of file + From 182d6b862c7d9f922b8b6299ada48bbe92e700c2 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 6 Aug 2019 21:52:52 -0700 Subject: [PATCH 7/7] fixed cref --- xml/System.Net/CookieCollection.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net/CookieCollection.xml b/xml/System.Net/CookieCollection.xml index 25d5600dbf6..264b71d305f 100644 --- a/xml/System.Net/CookieCollection.xml +++ b/xml/System.Net/CookieCollection.xml @@ -524,7 +524,7 @@ The comparison for is case-sensitive. Gets an enumerator that can iterate through a . - An for this collection. + An for this collection.