From 892090f60d8c8968016f4681ee98bcc3acb60327 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 15 Sep 2020 14:20:45 -0700 Subject: [PATCH 01/31] Automatic port of System.OperatingSystem docs for RC2 (#4852) Co-authored-by: carlossanlop --- xml/System/OperatingSystem.xml | 149 ++++++++++++++++++--------------- 1 file changed, 83 insertions(+), 66 deletions(-) diff --git a/xml/System/OperatingSystem.xml b/xml/System/OperatingSystem.xml index a8bce535e97..3c86df15733 100644 --- a/xml/System/OperatingSystem.xml +++ b/xml/System/OperatingSystem.xml @@ -270,8 +270,9 @@ - To be added. - To be added. + Indicates whether the current application is running on Android. + + if the current application is running on Android; otherwise. To be added. @@ -302,12 +303,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The major release number. + The minor release number. + The build release number. + The revision release number. + Check for the Android version (returned by uname) with a >= version comparison. This is used to guard APIs that were added in the given Android release. + + if the current application is running on an Android version that is at least what was specified in the parameters; otherwise. To be added. @@ -334,8 +336,8 @@ - To be added. - To be added. + Indicates whether the current application is running as WASM in a browser. + if the current application is running as WASM in a browser; otherwise. To be added. @@ -362,8 +364,9 @@ - To be added. - To be added. + Indicates whether the current application is running on FreeBSD. + + if the current application is running on FreeBSD; otherwise. To be added. @@ -394,12 +397,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The major release number. + The minor release number. + The build release number. + The revision release number. + Check for the FreeBSD version (returned by uname) with a >= version comparison. This is used to guard APIs that were added in the given FreeBSD release. + + if the current application is running on a FreeBSD version that is at least what was specified in the parameters; otherwise. To be added. @@ -426,8 +430,9 @@ - To be added. - To be added. + Indicates whether the current application is running on iOS. + + if the current application is running on iOS; otherwise. To be added. @@ -457,11 +462,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The major release number. + The minor release number. + The build release number. + Check for the iOS version (returned by libobjc.get_operatingSystemVersion) with a >= version comparison. This is used to guard APIs that were added in the given iOS release. + + if the current application is running on an iOS version that is at least what was specified in the parameters; otherwise. To be added. @@ -488,8 +494,9 @@ - To be added. - To be added. + Indicates whether the current application is running on Linux. + + if the current application is running on Linux; otherwise. To be added. @@ -516,8 +523,9 @@ - To be added. - To be added. + Indicates whether the current application is running on macOS. + + if the current application is running on macOS; otherwise. To be added. @@ -547,11 +555,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The major release number. + The minor release number. + The build release number. + Check for the macOS version (returned by libobjc.get_operatingSystemVersion) with a >= version comparison. This is used to guard APIs that were added in the given macOS release. + + if the current application is running on an macOS version that is at least what was specified in the parameters; otherwise. To be added. @@ -580,9 +589,10 @@ - To be added. - To be added. - To be added. + The case-insensitive platform name. Examples: Browser, Linux, FreeBSD, Android, iOS, macOS, tvOS, watchOS, Windows. + Indicates whether the current application is running on the specified platform. + + if the current application is running on the specified platform; otherwise. To be added. @@ -614,13 +624,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The case-insensitive platform name. Examples: Browser, Linux, FreeBSD, Android, iOS, macOS, tvOS, watchOS, Windows. + The major release number. + The minor release number (optional). + The build release number (optional). + The revision release number (optional). + Check for the OS with a >= version comparison. This is used to guard APIs that were added in the given OS release. + + if the current application is running on the specified platform and is at least in the version specified in the parameters; otherwise. To be added. @@ -647,8 +658,9 @@ - To be added. - To be added. + Indicates whether the current application is running on tvOS. + + if the current application is running on tvOS; otherwise. To be added. @@ -678,11 +690,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The major release number. + The minor release number. + The build release number. + Check for the tvOS version (returned by libobjc.get_operatingSystemVersion) with a >= version comparison. This is used to guard APIs that were added in the given tvOS release. + + if the current application is running on a tvOS version that is at least what was specified in the parameters; otherwise. To be added. @@ -709,8 +722,9 @@ - To be added. - To be added. + Indicates whether the current application is running on watchOS. + + if the current application is running on watchOS; otherwise. To be added. @@ -740,11 +754,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The major release number. + The minor release number. + The build release number. + Check for the watchOS version (returned by libobjc.get_operatingSystemVersion) with a >= version comparison. This is used to guard APIs that were added in the given watchOS release. + + if the current application is running on a watchOS version that is at least what was specified in the parameters; otherwise. To be added. @@ -771,8 +786,9 @@ - To be added. - To be added. + Indicates whether the current application is running on Windows. + + if the current application is running on Windows; otherwise. To be added. @@ -803,12 +819,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The major release number. + The minor release number. + The build release number. + The revision release number. + Check for the Windows version (returned by RtlGetVersion) with a >= version comparison. This is used to guard APIs that were added in the given Windows release. + + if the current application is running on a Windows version that is at least what was specified in the parameters; otherwise. To be added. From 7fa415cba97528c35cf6533c4e208f65b259a723 Mon Sep 17 00:00:00 2001 From: Tarek Mahmoud Sayed Date: Tue, 15 Sep 2020 16:06:52 -0700 Subject: [PATCH 02/31] Add Missing System.Diagnostics docs (#4856) * Add Missing System.Diagnostics docs * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Diagnostics/ActivityCreationOptions`1.xml | 10 +++++----- xml/System.Diagnostics/SampleActivity`1.xml | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/xml/System.Diagnostics/ActivityCreationOptions`1.xml b/xml/System.Diagnostics/ActivityCreationOptions`1.xml index e677f549b10..e4c5d75e1a5 100644 --- a/xml/System.Diagnostics/ActivityCreationOptions`1.xml +++ b/xml/System.Diagnostics/ActivityCreationOptions`1.xml @@ -124,8 +124,8 @@ The possible generic type parameters are callbacks. + The Activity tags collection. To be added. @@ -187,9 +187,9 @@ The possible generic type parameters are callbacks. + The trace Id. + If the parent is an and not equal to the value, then the trace Id inside the parent will be the value returned from this property. If it is equal to the value, a new trace Id will get generated and returned from this property. diff --git a/xml/System.Diagnostics/SampleActivity`1.xml b/xml/System.Diagnostics/SampleActivity`1.xml index 42d34d7ca82..1f46c7d2d25 100644 --- a/xml/System.Diagnostics/SampleActivity`1.xml +++ b/xml/System.Diagnostics/SampleActivity`1.xml @@ -22,10 +22,10 @@ System.Diagnostics.ActivitySamplingResult - To be added. - To be added. - To be added. - To be added. + The type of the requested parent to create the Activity object with. Should be either a string or an instance. + The Activity creation options used by callbacks to decide creating the Activity object or not. + A delegate that defines the signature of the callbacks used in the sampling process. + An object containing the sampling results, which indicate the amount of data to collect for the related . To be added. From 5825ea01adce04c3561f01cedc691405c339bfc3 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 16 Sep 2020 10:52:45 -0700 Subject: [PATCH 03/31] Automatically port System.Diagnostics docs for RC2 (#4853) * Automatically port System.Diagnostics docs for RC2 * Update xml/System.Diagnostics/ActivitySamplingResult.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Update xml/System.Diagnostics/Process.xml Co-authored-by: carlossanlop Co-authored-by: Tarek Mahmoud Sayed --- xml/System.Diagnostics/ActivityContext.xml | 22 ++++++++++--------- xml/System.Diagnostics/ActivityListener.xml | 8 +++---- .../ActivitySamplingResult.xml | 10 ++++----- xml/System.Diagnostics/Process.xml | 8 +++---- 4 files changed, 25 insertions(+), 23 deletions(-) diff --git a/xml/System.Diagnostics/ActivityContext.xml b/xml/System.Diagnostics/ActivityContext.xml index 61ecb82469a..c72c60f88b5 100644 --- a/xml/System.Diagnostics/ActivityContext.xml +++ b/xml/System.Diagnostics/ActivityContext.xml @@ -51,7 +51,7 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR A trace identifier. A span identifier. - To be added. + Contain details about the trace. Carries system-specific configuration data. Indicates if the context is propagated from a remote parent. Construct a new activity context instance using the specified arguments. @@ -249,11 +249,12 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR - To be added. - To be added. - To be added. - To be added. + The W3C trace parent header. + The trace state. + Parses a W3C trace context headers to an object. + The object created from the parsing operation. To be added. + The trace parent is invalid. @@ -361,11 +362,12 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR - To be added. - To be added. - To be added. - To be added. - To be added. + The W3C trace parent header. + The W3C trace state. + When this method returns , the object created from the parsing operation. + Tries to parse the W3C trace context headers to an object. + + if the parsing was successful; otherwise. To be added. diff --git a/xml/System.Diagnostics/ActivityListener.xml b/xml/System.Diagnostics/ActivityListener.xml index 8049ba8db9b..e5fa9689650 100644 --- a/xml/System.Diagnostics/ActivityListener.xml +++ b/xml/System.Diagnostics/ActivityListener.xml @@ -121,8 +121,8 @@ System.Diagnostics.SampleActivity<System.Diagnostics.ActivityContext> - To be added. - To be added. + Gets or sets the callback that is used to decide if creating objects with a specific data state is allowed. + A sample activity instance. To be added. @@ -142,8 +142,8 @@ System.Diagnostics.SampleActivity<System.String> - To be added. - To be added. + Gets or sets the callback that is used to decide if creating objects with a specific data state is allowed. + A sample activity instance. To be added. diff --git a/xml/System.Diagnostics/ActivitySamplingResult.xml b/xml/System.Diagnostics/ActivitySamplingResult.xml index ae1cadc7996..ce338b8cef4 100644 --- a/xml/System.Diagnostics/ActivitySamplingResult.xml +++ b/xml/System.Diagnostics/ActivitySamplingResult.xml @@ -13,7 +13,7 @@ System.Enum - To be added. + Enumeration values used by to indicate the amount of data to collect for the related . Requesting more data causes a greater performance overhead. To be added. @@ -34,7 +34,7 @@ 2 - To be added. + The activity object should be populated with all the propagation information and also all other properties such as Links, Tags, and Events. Using this value causes to return . @@ -54,7 +54,7 @@ 3 - To be added. + The activity object should be populated the same as the case. Additionally, Activity.Recorded is set to . For activities using the W3C trace ids, this sets a flag bit in the ID that will be propagated downstream requesting that the trace is recorded everywhere. @@ -74,7 +74,7 @@ 0 - To be added. + The activity object does not need to be created. @@ -94,7 +94,7 @@ 1 - To be added. + The activity object needs to be created. It will have a Name, a Source, an Id and Baggage. Other properties are unnecessary and will be ignored by this listener. diff --git a/xml/System.Diagnostics/Process.xml b/xml/System.Diagnostics/Process.xml index 34778603de7..0b4f26e7d17 100644 --- a/xml/System.Diagnostics/Process.xml +++ b/xml/System.Diagnostics/Process.xml @@ -5230,10 +5230,10 @@ The file specified in the could not be found. - To be added. - To be added. - To be added. - To be added. + The name of a document or application file to run in the process. + The command-line arguments to pass when starting the process. + Starts a process resource by specifying the name of an application and a set of command line arguments. + A new that is associated with the process resource, or if no process resource is started. To be added. From 489aec69a0c3198ae06c1148fe798357857a3f3e Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 16 Sep 2020 10:57:13 -0700 Subject: [PATCH 04/31] Automatic port of RegexParse* documentation (#4850) * Automatic port of RegexParse* documentation * Update xml/System.Text.RegularExpressions/RegexParseError.xml * Apply suggestions from code review * Update RegexParseException * Update xml/System.Text.RegularExpressions/RegexParseException.xml * Update xml/System.Text.RegularExpressions/RegexParseException.xml Co-authored-by: carlossanlop Co-authored-by: Prashanth Govindarajan --- .../RegexParseError.xml | 76 ++++++++++--------- .../RegexParseException.xml | 21 +++-- 2 files changed, 52 insertions(+), 45 deletions(-) diff --git a/xml/System.Text.RegularExpressions/RegexParseError.xml b/xml/System.Text.RegularExpressions/RegexParseError.xml index 4801ee53707..8a19355fdfc 100644 --- a/xml/System.Text.RegularExpressions/RegexParseError.xml +++ b/xml/System.Text.RegularExpressions/RegexParseError.xml @@ -13,8 +13,16 @@ System.Enum - To be added. - To be added. + Specifies the detailed underlying reason why a is thrown when a regular expression contains a parsing error. + + . + + ]]> + @@ -34,7 +42,7 @@ 17 - To be added. + An alternation construct in a regular expression contains a comment. @@ -54,7 +62,7 @@ 2 - To be added. + An alternation in a regular expression has a malformed condition. @@ -74,7 +82,7 @@ 18 - To be added. + An alternation construct in a regular expression contains a malformed reference. @@ -94,7 +102,7 @@ 16 - To be added. + An alternation construct in a regular expression uses a named capture. @@ -114,7 +122,7 @@ 1 - To be added. + An alternation in a regular expression has too many conditions. @@ -134,7 +142,7 @@ 19 - To be added. + An alternation construct in a regular expression contains an undefined reference. @@ -154,7 +162,7 @@ 20 - To be added. + The group name of a captured group in a regular expression is invalid. @@ -174,7 +182,7 @@ 21 - To be added. + A regular expression defines a numbered subexpression named zero. @@ -194,7 +202,7 @@ 23 - To be added. + A character class in a regular expression with an exclusion group is not the last part of the character class. @@ -214,7 +222,7 @@ 26 - To be added. + A regular expression has a non-escaped left parenthesis, or misses a closing right parenthesis. @@ -234,7 +242,7 @@ 30 - To be added. + A regular expression has a non-escaped right parenthesis, or misses an opening left parenthesis. @@ -254,7 +262,7 @@ 8 - To be added. + A hexadecimal escape sequence in a regular expression does not have enough digits, or contains invalid digits. @@ -274,7 +282,7 @@ 15 - To be added. + A grouping construct in a regular expression is invalid or malformed. @@ -294,7 +302,7 @@ 3 - To be added. + A Unicode property escape in a regular expression is invalid or unknown. @@ -314,7 +322,7 @@ 12 - To be added. + A named reference in a regular expression is malformed. @@ -334,7 +342,7 @@ 4 - To be added. + A Unicode property escape is malformed. @@ -354,7 +362,7 @@ 7 - To be added. + A control character in a regular expression is missing. @@ -374,7 +382,7 @@ 28 - To be added. + Repeated quantifiers on another quantifier inside a regular expression are not grouped in parentheses. @@ -394,7 +402,7 @@ 29 - To be added. + A quantifier in a regular expression is in a position where it cannot quantify anything, like at the beginning of a regular expression or in a group. @@ -414,7 +422,7 @@ 9 - To be added. + A captured group or a quantifier in a regular expression is not within range, that is, it is larger than . @@ -434,7 +442,7 @@ 24 - To be added. + A character class in a regular expression contains an inverse character range, like z-a instead of a-z. @@ -454,7 +462,7 @@ 27 - To be added. + A quantifier range in a regular expression is inverse, like {10,1} instead of (1,10}. @@ -474,7 +482,7 @@ 25 - To be added. + A character-class in a regular expression contains a short-hand class that is not allowed inside a character class. @@ -494,7 +502,7 @@ 10 - To be added. + A used named reference in a regular expression is not defined. @@ -514,7 +522,7 @@ 11 - To be added. + A used numbered reference in a regular expression is not defined. @@ -534,7 +542,7 @@ 13 - To be added. + A regular expression ends with a non-escaped ending backslash. @@ -554,7 +562,7 @@ 0 - To be added. + An unknown regular expression parse error. @@ -574,7 +582,7 @@ 6 - To be added. + A control character in a regular expression is not recognized. @@ -594,7 +602,7 @@ 5 - To be added. + An escape character or sequence in a regular expression is invalid. @@ -614,7 +622,7 @@ 31 - To be added. + A unicode property in a regular expression is not recognized, or invalid. @@ -634,7 +642,7 @@ 22 - To be added. + A regular expression has a non-escaped left square bracket, or misses a closing right square bracket. @@ -654,7 +662,7 @@ 14 - To be added. + A comment in a regular expression is not terminated. diff --git a/xml/System.Text.RegularExpressions/RegexParseException.xml b/xml/System.Text.RegularExpressions/RegexParseException.xml index 12d6ddfacb7..c6ce884abd4 100644 --- a/xml/System.Text.RegularExpressions/RegexParseException.xml +++ b/xml/System.Text.RegularExpressions/RegexParseException.xml @@ -14,7 +14,7 @@ - To be added. + An exception as a result of a parse error in a regular expression, with detailed information in the and properties. To be added. @@ -34,9 +34,8 @@ System.Text.RegularExpressions.RegexParseError - To be added. - To be added. - To be added. + Gets the error that happened during parsing. + The error that occured during parsing. @@ -59,10 +58,11 @@ - To be added. - To be added. - To be added. - To be added. + The object that holds the serialized object data. + The contextual information about the source or destination. + Sets the object with the parameter name and additional exception information. + + is . @@ -81,9 +81,8 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the zero-based character offset in the regular expression pattern where the parse error occurs. + The offset at which the parse error occurs. From 9c3535668e4a310e63261599a3838c1780570b15 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 16 Sep 2020 23:24:59 +0200 Subject: [PATCH 05/31] Add ssl API added between preview 7 and 8 (#4860) --- xml/System.Net.Http/WinHttpHandler.xml | 5 ++- .../ServerOptionsSelectionCallback.xml | 20 ++++++---- .../SslClientHelloInfo.xml | 6 +-- .../SslServerAuthenticationOptions.xml | 4 +- xml/System.Net.Security/SslStream.xml | 39 ++++++++++++++----- .../SslStreamCertificateContext.xml | 15 ++++--- 6 files changed, 60 insertions(+), 29 deletions(-) diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index c6696bf5bdd..f7535d25ef1 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -416,8 +416,9 @@ When this property is set to `true`, all HTTP redirect responses from the server System.Boolean - To be added. - To be added. + Gets or sets a value that indicates whether additional HTTP/2 connections can be established to the same server when the maximum number of concurrent streams is reached on all existing connections. + + if additional HTTP/2 connections are allowed to be created; otherwise, . To be added. diff --git a/xml/System.Net.Security/ServerOptionsSelectionCallback.xml b/xml/System.Net.Security/ServerOptionsSelectionCallback.xml index 01777d0026d..2bd10be3fd3 100644 --- a/xml/System.Net.Security/ServerOptionsSelectionCallback.xml +++ b/xml/System.Net.Security/ServerOptionsSelectionCallback.xml @@ -22,12 +22,18 @@ System.Threading.Tasks.ValueTask<System.Net.Security.SslServerAuthenticationOptions> - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The TLS stream on which the authentication happens. + Information from the Client Hello message. + The information that was passed when registering the callback. + The token to monitor for cancellation requests. + The asynchronous callback to select session properties based on name requested by client. + A server authentication property bag. + + + diff --git a/xml/System.Net.Security/SslClientHelloInfo.xml b/xml/System.Net.Security/SslClientHelloInfo.xml index 93b422c17e3..3b74b46e602 100644 --- a/xml/System.Net.Security/SslClientHelloInfo.xml +++ b/xml/System.Net.Security/SslClientHelloInfo.xml @@ -40,7 +40,7 @@ System.String - To be added. + The host server specified by the client. To be added. To be added. @@ -61,8 +61,8 @@ System.Security.Authentication.SslProtocols - To be added. - To be added. + Gets or sets the TLS/SSL protocols offered by client. + A bitwise combination of the enumeration values that specify the TLS or SSL protocols. To be added. diff --git a/xml/System.Net.Security/SslServerAuthenticationOptions.xml b/xml/System.Net.Security/SslServerAuthenticationOptions.xml index c10b577d983..13a95a62c67 100644 --- a/xml/System.Net.Security/SslServerAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslServerAuthenticationOptions.xml @@ -332,8 +332,8 @@ System.Net.Security.SslStreamCertificateContext - To be added. - To be added. + Gets or sets the server certificate context. + The server certificate context. To be added. diff --git a/xml/System.Net.Security/SslStream.xml b/xml/System.Net.Security/SslStream.xml index 38bab49fabc..7a876b7e023 100644 --- a/xml/System.Net.Security/SslStream.xml +++ b/xml/System.Net.Security/SslStream.xml @@ -1399,7 +1399,7 @@ ]]> - Either or is and is not set in the constructor. + Either or or is and is not set in the constructor. is . The authentication failed and left this object in an unusable state. @@ -1438,12 +1438,33 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The callback delegate. + The state object to pass to when the callback is invoked. + The token to monitor for cancellation requests. + Called by servers to authenticate the server and optionally the client in a client-server connection as an asynchronous operation. The authentication process uses information returned by . + The task object representing the asynchronous operation. + + , and this is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector. + + ]]> + + + Either or or is and is not set in the constructor. + The authentication failed and left this object in an unusable state. + Authentication has already occurred. + + -or- + + Client authentication using this was tried previously. + + -or- + + Authentication is already in progress. + This object has been closed. @@ -4346,8 +4367,8 @@ This property gets the cipher suite that is going to be used in the communicatio System.String - To be added. - To be added. + Gets the name of the server the client is trying to connect to. That name is used for server certificate validation. It can be a DNS name or an IP address. + The name of the server the client is trying to connect to. To be added. diff --git a/xml/System.Net.Security/SslStreamCertificateContext.xml b/xml/System.Net.Security/SslStreamCertificateContext.xml index 214959e62e9..26e224c1085 100644 --- a/xml/System.Net.Security/SslStreamCertificateContext.xml +++ b/xml/System.Net.Security/SslStreamCertificateContext.xml @@ -14,7 +14,7 @@ - To be added. + Represents a set of certificates used for building a certificate chain. To be added. @@ -38,12 +38,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The server certificate. + The certificates to chain. + + to indicate that the missing certificates can be downloaded; otherwise, . + Attempts to build the certificate chain from the provided certificates. + The certificate context with the newly created certificate chain. To be added. + + doesn't have an associated private key. From 537f13c66bf0e0476a8c0963ed8e37429807a080 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 16 Sep 2020 14:26:20 -0700 Subject: [PATCH 06/31] Automatic port of Reflection RC2 documentation (#4851) --- .../SignatureCallingConvention.xml | 5 ++--- xml/System.Reflection/MethodInfo.xml | 10 +++++----- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/xml/System.Reflection.Metadata/SignatureCallingConvention.xml b/xml/System.Reflection.Metadata/SignatureCallingConvention.xml index 60a9d63b7c7..7f4cf95baf3 100644 --- a/xml/System.Reflection.Metadata/SignatureCallingConvention.xml +++ b/xml/System.Reflection.Metadata/SignatureCallingConvention.xml @@ -21,8 +21,7 @@ Specifies how arguments in a given signature are passed from the caller to the callee. The underlying values of the fields in this type correspond to the representation in the leading signature byte represented by a structure. - - + To be added. @@ -177,7 +176,7 @@ 9 - To be added. + Indicates that the specifics of the unmanaged calling convention are encoded as modopts. diff --git a/xml/System.Reflection/MethodInfo.xml b/xml/System.Reflection/MethodInfo.xml index a2c662c8284..be9b2510438 100644 --- a/xml/System.Reflection/MethodInfo.xml +++ b/xml/System.Reflection/MethodInfo.xml @@ -323,9 +323,9 @@ For a list of the invariant conditions for other terms used in generic reflectio - To be added. + The type of the delegate to create. Creates a delegate of type from this method. - To be added. + The delegate for this method. To be added. @@ -364,10 +364,10 @@ For a list of the invariant conditions for other terms used in generic reflectio - To be added. - To be added. + The type of the delegate to create. + The object targeted by the delegate. Creates a delegate of type with the specified target from this method. - To be added. + The delegate for this method. To be added. From 6402a8220876195f76093ec4c4d73f6da94dacad Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Thu, 17 Sep 2020 14:25:53 +0200 Subject: [PATCH 07/31] Revert "Add ssl API added between preview 7 and 8 (#4860)" (#4868) This reverts commit 10d2b8868138aece790b469e23ce4bd3e2b82904. --- xml/System.Net.Http/WinHttpHandler.xml | 5 +-- .../ServerOptionsSelectionCallback.xml | 20 ++++------ .../SslClientHelloInfo.xml | 6 +-- .../SslServerAuthenticationOptions.xml | 4 +- xml/System.Net.Security/SslStream.xml | 39 +++++-------------- .../SslStreamCertificateContext.xml | 15 +++---- 6 files changed, 29 insertions(+), 60 deletions(-) diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index f7535d25ef1..c6696bf5bdd 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -416,9 +416,8 @@ When this property is set to `true`, all HTTP redirect responses from the server System.Boolean - Gets or sets a value that indicates whether additional HTTP/2 connections can be established to the same server when the maximum number of concurrent streams is reached on all existing connections. - - if additional HTTP/2 connections are allowed to be created; otherwise, . + To be added. + To be added. To be added. diff --git a/xml/System.Net.Security/ServerOptionsSelectionCallback.xml b/xml/System.Net.Security/ServerOptionsSelectionCallback.xml index 2bd10be3fd3..01777d0026d 100644 --- a/xml/System.Net.Security/ServerOptionsSelectionCallback.xml +++ b/xml/System.Net.Security/ServerOptionsSelectionCallback.xml @@ -22,18 +22,12 @@ System.Threading.Tasks.ValueTask<System.Net.Security.SslServerAuthenticationOptions> - The TLS stream on which the authentication happens. - Information from the Client Hello message. - The information that was passed when registering the callback. - The token to monitor for cancellation requests. - The asynchronous callback to select session properties based on name requested by client. - A server authentication property bag. - - - + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. diff --git a/xml/System.Net.Security/SslClientHelloInfo.xml b/xml/System.Net.Security/SslClientHelloInfo.xml index 3b74b46e602..93b422c17e3 100644 --- a/xml/System.Net.Security/SslClientHelloInfo.xml +++ b/xml/System.Net.Security/SslClientHelloInfo.xml @@ -40,7 +40,7 @@ System.String - The host server specified by the client. + To be added. To be added. To be added. @@ -61,8 +61,8 @@ System.Security.Authentication.SslProtocols - Gets or sets the TLS/SSL protocols offered by client. - A bitwise combination of the enumeration values that specify the TLS or SSL protocols. + To be added. + To be added. To be added. diff --git a/xml/System.Net.Security/SslServerAuthenticationOptions.xml b/xml/System.Net.Security/SslServerAuthenticationOptions.xml index 13a95a62c67..c10b577d983 100644 --- a/xml/System.Net.Security/SslServerAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslServerAuthenticationOptions.xml @@ -332,8 +332,8 @@ System.Net.Security.SslStreamCertificateContext - Gets or sets the server certificate context. - The server certificate context. + To be added. + To be added. To be added. diff --git a/xml/System.Net.Security/SslStream.xml b/xml/System.Net.Security/SslStream.xml index 7a876b7e023..38bab49fabc 100644 --- a/xml/System.Net.Security/SslStream.xml +++ b/xml/System.Net.Security/SslStream.xml @@ -1399,7 +1399,7 @@ ]]> - Either or or is and is not set in the constructor. + Either or is and is not set in the constructor. is . The authentication failed and left this object in an unusable state. @@ -1438,33 +1438,12 @@ - The callback delegate. - The state object to pass to when the callback is invoked. - The token to monitor for cancellation requests. - Called by servers to authenticate the server and optionally the client in a client-server connection as an asynchronous operation. The authentication process uses information returned by . - The task object representing the asynchronous operation. - - , and this is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector. - - ]]> - - - Either or or is and is not set in the constructor. - The authentication failed and left this object in an unusable state. - Authentication has already occurred. - - -or- - - Client authentication using this was tried previously. - - -or- - - Authentication is already in progress. - This object has been closed. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. @@ -4367,8 +4346,8 @@ This property gets the cipher suite that is going to be used in the communicatio System.String - Gets the name of the server the client is trying to connect to. That name is used for server certificate validation. It can be a DNS name or an IP address. - The name of the server the client is trying to connect to. + To be added. + To be added. To be added. diff --git a/xml/System.Net.Security/SslStreamCertificateContext.xml b/xml/System.Net.Security/SslStreamCertificateContext.xml index 26e224c1085..214959e62e9 100644 --- a/xml/System.Net.Security/SslStreamCertificateContext.xml +++ b/xml/System.Net.Security/SslStreamCertificateContext.xml @@ -14,7 +14,7 @@ - Represents a set of certificates used for building a certificate chain. + To be added. To be added. @@ -38,15 +38,12 @@ - The server certificate. - The certificates to chain. - - to indicate that the missing certificates can be downloaded; otherwise, . - Attempts to build the certificate chain from the provided certificates. - The certificate context with the newly created certificate chain. + To be added. + To be added. + To be added. + To be added. + To be added. To be added. - - doesn't have an associated private key. From 4ae1d768ce5277a9a5819b99e5bd58fc1ee031cc Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Mon, 21 Sep 2020 16:34:53 +0200 Subject: [PATCH 08/31] Add ssl API added between preview 7 and 8 #2 (#4869) * Add ssl API added between preview 7 and 8 * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Update xml/System.Net.Security/SslStream.xml * Apply @wfurt comments * Add missing remark headers * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Jan Jahoda Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Net.Http/WinHttpHandler.xml | 5 ++- .../ServerOptionsSelectionCallback.xml | 21 ++++++---- .../SslClientHelloInfo.xml | 15 +++++-- .../SslServerAuthenticationOptions.xml | 4 +- xml/System.Net.Security/SslStream.xml | 39 +++++++++++++----- .../SslStreamCertificateContext.xml | 40 +++++++++++++++---- 6 files changed, 92 insertions(+), 32 deletions(-) diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index c6696bf5bdd..f7535d25ef1 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -416,8 +416,9 @@ When this property is set to `true`, all HTTP redirect responses from the server System.Boolean - To be added. - To be added. + Gets or sets a value that indicates whether additional HTTP/2 connections can be established to the same server when the maximum number of concurrent streams is reached on all existing connections. + + if additional HTTP/2 connections are allowed to be created; otherwise, . To be added. diff --git a/xml/System.Net.Security/ServerOptionsSelectionCallback.xml b/xml/System.Net.Security/ServerOptionsSelectionCallback.xml index 01777d0026d..d7377faa00e 100644 --- a/xml/System.Net.Security/ServerOptionsSelectionCallback.xml +++ b/xml/System.Net.Security/ServerOptionsSelectionCallback.xml @@ -22,12 +22,19 @@ System.Threading.Tasks.ValueTask<System.Net.Security.SslServerAuthenticationOptions> - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The TLS stream on which the authentication happens. + Information from the Client Hello message. + The information that was passed when registering the callback. + The token to monitor for cancellation requests. + Represents the asynchronous callback method that will select session properties based on the name requested by the client. + A server authentication property bag. + + + diff --git a/xml/System.Net.Security/SslClientHelloInfo.xml b/xml/System.Net.Security/SslClientHelloInfo.xml index 93b422c17e3..e1657f12a3e 100644 --- a/xml/System.Net.Security/SslClientHelloInfo.xml +++ b/xml/System.Net.Security/SslClientHelloInfo.xml @@ -40,9 +40,16 @@ System.String - To be added. + Gets the host server specified by the client. To be added. - To be added. + + + @@ -61,8 +68,8 @@ System.Security.Authentication.SslProtocols - To be added. - To be added. + Gets the TLS/SSL protocols offered by client. + A bitwise combination of the enumeration values that specify the TLS or SSL protocols. To be added. diff --git a/xml/System.Net.Security/SslServerAuthenticationOptions.xml b/xml/System.Net.Security/SslServerAuthenticationOptions.xml index c10b577d983..13a95a62c67 100644 --- a/xml/System.Net.Security/SslServerAuthenticationOptions.xml +++ b/xml/System.Net.Security/SslServerAuthenticationOptions.xml @@ -332,8 +332,8 @@ System.Net.Security.SslStreamCertificateContext - To be added. - To be added. + Gets or sets the server certificate context. + The server certificate context. To be added. diff --git a/xml/System.Net.Security/SslStream.xml b/xml/System.Net.Security/SslStream.xml index 38bab49fabc..7a876b7e023 100644 --- a/xml/System.Net.Security/SslStream.xml +++ b/xml/System.Net.Security/SslStream.xml @@ -1399,7 +1399,7 @@ ]]> - Either or is and is not set in the constructor. + Either or or is and is not set in the constructor. is . The authentication failed and left this object in an unusable state. @@ -1438,12 +1438,33 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The callback delegate. + The state object to pass to when the callback is invoked. + The token to monitor for cancellation requests. + Called by servers to authenticate the server and optionally the client in a client-server connection as an asynchronous operation. The authentication process uses information returned by . + The task object representing the asynchronous operation. + + , and this is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector. + + ]]> + + + Either or or is and is not set in the constructor. + The authentication failed and left this object in an unusable state. + Authentication has already occurred. + + -or- + + Client authentication using this was tried previously. + + -or- + + Authentication is already in progress. + This object has been closed. @@ -4346,8 +4367,8 @@ This property gets the cipher suite that is going to be used in the communicatio System.String - To be added. - To be added. + Gets the name of the server the client is trying to connect to. That name is used for server certificate validation. It can be a DNS name or an IP address. + The name of the server the client is trying to connect to. To be added. diff --git a/xml/System.Net.Security/SslStreamCertificateContext.xml b/xml/System.Net.Security/SslStreamCertificateContext.xml index 214959e62e9..8a79e6b43ed 100644 --- a/xml/System.Net.Security/SslStreamCertificateContext.xml +++ b/xml/System.Net.Security/SslStreamCertificateContext.xml @@ -14,8 +14,18 @@ - To be added. - To be added. + Represents a set of certificates used for building a certificate chain. + + can be used across multiple streams to save chain construction and improve performance. + +]]> + @@ -38,12 +48,26 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The server certificate. + Supplementary certificates used to build the certificate chain. + + to indicate that the missing certificates can be downloaded from the network; to indicate that only available X509Certificate stores should be searched for missing certificates. + Attempts to build the certificate chain from the provided certificates. + The certificate context with the newly created certificate chain. + To be added. + . + +> [!IMPORTANT] +> The target certificate must include a private key. + +]]> + + + + doesn't have an associated private key. From 6e3ad7eba2b007894f60c40367efa55bb76a8274 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Mon, 21 Sep 2020 16:35:33 +0200 Subject: [PATCH 09/31] Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback (#4861) * Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback * Apply PR comments * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Jan Jahoda Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Net.Http/SocketsHttpConnectionContext.xml | 6 +++--- xml/System.Net.Http/SocketsHttpHandler.xml | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/xml/System.Net.Http/SocketsHttpConnectionContext.xml b/xml/System.Net.Http/SocketsHttpConnectionContext.xml index 7b7a0694d2e..1460df1babc 100644 --- a/xml/System.Net.Http/SocketsHttpConnectionContext.xml +++ b/xml/System.Net.Http/SocketsHttpConnectionContext.xml @@ -14,7 +14,7 @@ - To be added. + Represents the context passed to the for a instance. . To be added. @@ -34,7 +34,7 @@ System.Net.DnsEndPoint - To be added. + Gets the DNS endpoint to be used by the to establish the connection. To be added. To be added. @@ -55,7 +55,7 @@ System.Net.Http.HttpRequestMessage - To be added. + Gets the initial request message that is causing the connection to be created. To be added. To be added. diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 79d6b57b50b..c446ed3e770 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -158,8 +158,8 @@ If this change is undesirable, you can configure your application to use the old System.Func<System.Net.Http.SocketsHttpConnectionContext,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<System.IO.Stream>> - To be added. - To be added. + Gets or sets a custom callback used to open new connections. + A callback method to create a stream. To be added. From 3f7feaa9bbce09d090e3fb359c4c63e4f255ab4f Mon Sep 17 00:00:00 2001 From: Tarek Mahmoud Sayed Date: Mon, 21 Sep 2020 10:28:27 -0700 Subject: [PATCH 10/31] Add a remark to AddEvent method (#4871) * Add a remark to AddEvent method * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Diagnostics/Activity.xml | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/xml/System.Diagnostics/Activity.xml b/xml/System.Diagnostics/Activity.xml index b372b2a33a5..9eeeb8f413b 100644 --- a/xml/System.Diagnostics/Activity.xml +++ b/xml/System.Diagnostics/Activity.xml @@ -172,7 +172,17 @@ This key/value pair is included in the collection returned by the Adds the specified activity event to the events list. for convenient chaining. - To be added. + + . + + ]]> + + From f3eb70d3fd2aa9edfb5756984ff5e59505cedf71 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 21 Sep 2020 15:39:22 -0700 Subject: [PATCH 11/31] Automatic port of CryptoStream docs (#4888) Co-authored-by: carlossanlop --- xml/System.Security.Cryptography/CryptoStream.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Security.Cryptography/CryptoStream.xml b/xml/System.Security.Cryptography/CryptoStream.xml index 41a375e7c4e..5f09ab50177 100644 --- a/xml/System.Security.Cryptography/CryptoStream.xml +++ b/xml/System.Security.Cryptography/CryptoStream.xml @@ -880,9 +880,9 @@ - To be added. - To be added. - To be added. + The token to monitor for cancellation requests. The default value is . + Asynchronously updates the underlying data source or repository with the current state of the buffer, then clears the buffer. + A task that represents the asynchronous flush operation. To be added. From 6b424402e62fa0d87c97cde17d1b941be1c820be Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 21 Sep 2020 15:59:14 -0700 Subject: [PATCH 12/31] Automatic port of System.Buffers docs (#4882) Co-authored-by: carlossanlop --- xml/System.Buffers/ReadOnlySequence`1.xml | 7 ++++--- xml/System.Buffers/SequenceReader`1.xml | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/xml/System.Buffers/ReadOnlySequence`1.xml b/xml/System.Buffers/ReadOnlySequence`1.xml index a5b3d6657a9..10fb99bd565 100644 --- a/xml/System.Buffers/ReadOnlySequence`1.xml +++ b/xml/System.Buffers/ReadOnlySequence`1.xml @@ -351,10 +351,11 @@ The consumer is expected to manage the lifetime of memory until - To be added. - To be added. - To be added. + The of which to get the offset. + Returns the offset of a within this sequence from the start. + The offset from the start of the sequence. To be added. + The position is out of range. diff --git a/xml/System.Buffers/SequenceReader`1.xml b/xml/System.Buffers/SequenceReader`1.xml index 934c5b685c5..488cda0b7a6 100644 --- a/xml/System.Buffers/SequenceReader`1.xml +++ b/xml/System.Buffers/SequenceReader`1.xml @@ -972,7 +972,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do The delimiter to look for. to move past the if found. - To be added. + The read data, if any. Try to read everything up to the given . if the was found; otherwise, . From 25a02ac13fb984354b611d7cad8fa331f6804dc7 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 21 Sep 2020 17:01:45 -0700 Subject: [PATCH 13/31] resolve isprefix conflict --- xml/System.Globalization/CompareInfo.xml | 99 +++++++++++++++++------- 1 file changed, 70 insertions(+), 29 deletions(-) diff --git a/xml/System.Globalization/CompareInfo.xml b/xml/System.Globalization/CompareInfo.xml index 8a887fed8a3..9ad3ca363e5 100644 --- a/xml/System.Globalization/CompareInfo.xml +++ b/xml/System.Globalization/CompareInfo.xml @@ -2222,13 +2222,23 @@ Use - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The read-only span of characters to search within. + The read-only span of characters containing the substring to locate within . + The to use during the search. + When this method returns, contains the number of characters of that matched the desired value. This may be different than the length of if a linguistic comparison is performed. Set to 0 if is not found within . + Searches for the first occurrence of a substring within a source string. + The zero-based index into where the substring first appears; or a negative value if cannot be found within . + + overloads which don't take a `matchLength` argument. Call this overload only if you require the match length information. + + ]]> + + + contains an unsupported combination of flags. @@ -3097,14 +3107,24 @@ Use - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The read-only span of characters to search within. + The read-only span of characters containing the prefix to attempt to match at the start of . + The to use during the match. + When this method returns, contains the number of characters of that matched the desired prefix. This may be different than the length of if a linguistic comparison is performed. Set to 0 if the prefix did not match. + Determines whether a string starts with a specific prefix. + + if occurs at the start of ; otherwise, . + + overloads which don't take a `matchLength` argument. Call this overload only if you require the match length information. + + ]]> + + + contains an unsupported combination of flags. @@ -3557,13 +3577,24 @@ Use - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The read-only span of characters to search within. + The read-only span of characters containing the suffix to attempt to match at the end of . + The to use during the match. + When this method returns, contains the number of characters of that matched the desired suffix. This may be different than the length of if a linguistic comparison is performed. Set to 0 if the suffix did not match. + Determines whether a string ends with a specific suffix. + + if occurs at the end of ; otherwise, . + + overloads which don't take a `matchLength` argument. Call this overload only if you require the match length information. + + ]]> + + + contains an unsupported combination of flags. @@ -4219,13 +4250,23 @@ Use - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The read-only span of characters to search within. + The read-only span of characters containing the substring to locate within . + The to use during the search. + When this method returns, contains the number of characters of that matched the desired value. This may be different than the length of if a linguistic comparison is performed. Set to 0 if is not found within . + Searches for the last occurrence of a substring within a source string. + The zero-based index into where the substring last appears; or a negative number if cannot be found within . + + overloads which don't take a `matchLength` argument. Call this overload only if you require the match length information. + + ]]> + + + contains an unsupported combination of flags. From 1c0cd1756e9bc7d8fde406659faf8034ed534769 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 21 Sep 2020 17:02:01 -0700 Subject: [PATCH 14/31] Automatic port of System.Data.Common docs (#4885) Co-authored-by: carlossanlop --- xml/System.Data.Common/DbTransaction.xml | 42 +++++++++++++----------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/xml/System.Data.Common/DbTransaction.xml b/xml/System.Data.Common/DbTransaction.xml index e7ca466e62a..cc542133547 100644 --- a/xml/System.Data.Common/DbTransaction.xml +++ b/xml/System.Data.Common/DbTransaction.xml @@ -507,8 +507,8 @@ - To be added. - To be added. + The name of the savepoint to release. + Destroys a savepoint previously defined in the current transaction. This allows the system to reclaim some resources before the transaction ends. To be added. @@ -534,10 +534,10 @@ - To be added. - To be added. - To be added. - To be added. + The name of the savepoint to release. + An optional token to cancel the asynchronous operation. The default value is . + Destroys a savepoint previously defined in the current transaction. This allows the system to reclaim some resources before the transaction ends. + A representing the asynchronous operation. To be added. @@ -605,8 +605,8 @@ - To be added. - To be added. + The name of the savepoint to roll back to. + Rolls back all commands that were executed after the specified savepoint was established. To be added. @@ -674,10 +674,10 @@ - To be added. - To be added. - To be added. - To be added. + The name of the savepoint to roll back to. + An optional token to cancel the asynchronous operation. The default value is . + Rolls back all commands that were executed after the specified savepoint was established. + A representing the asynchronous operation. To be added. @@ -703,8 +703,8 @@ - To be added. - To be added. + The name of the savepoint to be created. + Creates a savepoint in the transaction. This allows all commands that are executed after the savepoint was established to be rolled back, restoring the transaction state to what it was at the time of the savepoint. To be added. @@ -730,10 +730,10 @@ - To be added. - To be added. - To be added. - To be added. + The name of the savepoint to be created. + An optional token to cancel the asynchronous operation. The default value is . + Creates a savepoint in the transaction. This allows all commands that are executed after the savepoint was established to be rolled back, restoring the transaction state to what it was at the time of the savepoint. + A representing the asynchronous operation. To be added. @@ -756,8 +756,10 @@ System.Boolean - To be added. - To be added. + Gets a value that indicates whether this instance supports database savepoints. + If , the methods , and as well as their synchronous counterparts are expected to throw . + + if this instance supports database savepoints; otherwise, . To be added. From 4934e67ddf2767f613ff88f92acb2e053a5a50ff Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 21 Sep 2020 17:55:13 -0700 Subject: [PATCH 15/31] Automatic port of *PipeServerStreamAcl docs (#4880) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Automatic port of *PipeServerStreamAcl docs * Apply suggestions from code review Co-authored-by: Prashanth Govindarajan Co-authored-by: David Cantú * Apply suggestions from code review Co-authored-by: David Cantú * Apply suggestions from code review * Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml * Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml Co-authored-by: carlossanlop Co-authored-by: Prashanth Govindarajan Co-authored-by: David Cantú --- .../AnonymousPipeServerStreamAcl.xml | 30 +++++++--- .../NamedPipeServerStreamAcl.xml | 58 ++++++++++++++----- 2 files changed, 68 insertions(+), 20 deletions(-) diff --git a/xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml b/xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml index 9baffa53a7b..8fc50e85e06 100644 --- a/xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml +++ b/xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml @@ -40,13 +40,29 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + One of the enumeration values that determines the direction of the pipe. Anonymous pipes are unidirectional, so direction cannot be set to . + One of the enumeration values that determines whether the underlying handle can be inherited by child processes. + The size of the buffer. This value must be greater than or equal to 0. + An object that determines the access control and audit security for the pipe. + Creates a new instance of the class with the specified pipe direction, inheritability mode, buffer size, and pipe security. + A new anonymous pipe server stream instance. + + constructor directly. + + ]]> + + + is . + + is not set to a valid enum value. + + -or- + + is less than 0. diff --git a/xml/System.IO.Pipes/NamedPipeServerStreamAcl.xml b/xml/System.IO.Pipes/NamedPipeServerStreamAcl.xml index 82c804fd6fc..2fe6e3b6fb2 100644 --- a/xml/System.IO.Pipes/NamedPipeServerStreamAcl.xml +++ b/xml/System.IO.Pipes/NamedPipeServerStreamAcl.xml @@ -45,19 +45,51 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The name of the pipe. + One of the enumeration values that determines the direction of the pipe. + The maximum number of server instances that share the same name. You can pass for this value. + One of the enumeration values that determines the transmission mode of the pipe. + One of the enumeration values that determines how to open or create the pipe. + The input buffer size. + The output buffer size. + An object that determines the access control and audit security for the pipe. + One of the enumeration values that determines whether the underlying handle can be inherited by child processes. + One of the enumeration values that specifies the access rights of the pipe. + Creates a new instance of the class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, recommended in and out buffer sizes, pipe security, inheritability mode, and pipe access rights. + A new named pipe server stream instance. + + , the passed `pipeSecurity` is ignored and the returned object is created using a custom instance assigned to the current Windows user as its only owner with full control of the pipe. + + ]]> + + + is . + + is empty. + + is . + + contains an invalid flag. + +-or- + + or is less than zero. + +-or- + + is not a valid number: it should be greater than or equal to 1 and less than or equal to 254, or should be set to the value of . + +-or- + + contains an invalid enum value. + +-or- + + is 'anonymous', which is reserved. From d132c2d2c371f665315226b598f50a1e267d51cb Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 21 Sep 2020 17:55:40 -0700 Subject: [PATCH 16/31] Automatic port of *OSPlatformAttribute docs (#4883) * Automatic port of *OSPlatformAttribute docs * Missing TargetPlatformAttribute constructor parameter description. * Apply suggestions from code review Co-authored-by: Buyaa * Update xml/System.Runtime.Versioning/SupportedOSPlatformAttribute.xml Co-authored-by: carlossanlop Co-authored-by: Buyaa --- .../SupportedOSPlatformAttribute.xml | 17 +++++++++++++---- .../TargetPlatformAttribute.xml | 4 ++-- .../UnsupportedOSPlatformAttribute.xml | 16 ++++++++++++---- 3 files changed, 27 insertions(+), 10 deletions(-) diff --git a/xml/System.Runtime.Versioning/SupportedOSPlatformAttribute.xml b/xml/System.Runtime.Versioning/SupportedOSPlatformAttribute.xml index 283fb87abe3..c0d7ecab1b8 100644 --- a/xml/System.Runtime.Versioning/SupportedOSPlatformAttribute.xml +++ b/xml/System.Runtime.Versioning/SupportedOSPlatformAttribute.xml @@ -20,8 +20,17 @@ - To be added. - To be added. + Indicates that an API is supported for a specified platform or operating system. If a version is specified, the API cannot be called from an earlier version. Multiple attributes can be applied to indicate support on multiple operating systems. + + or use guards to prevent calls to APIs on unsupported operating systems. + A given platform should only be specified once. + + ]]> + @@ -40,8 +49,8 @@ - To be added. - To be added. + The supported OS platform name, optionally including a version. + Initializes a new instance of the attribute class for the specified supported OS platform. To be added. diff --git a/xml/System.Runtime.Versioning/TargetPlatformAttribute.xml b/xml/System.Runtime.Versioning/TargetPlatformAttribute.xml index 924c35f96d0..d8600e7d751 100644 --- a/xml/System.Runtime.Versioning/TargetPlatformAttribute.xml +++ b/xml/System.Runtime.Versioning/TargetPlatformAttribute.xml @@ -40,8 +40,8 @@ - To be added. - Initializes a new instance of the class. + The target OS platform name. + Initializes a new instance of the attribute class for the specified target OS platform. To be added. diff --git a/xml/System.Runtime.Versioning/UnsupportedOSPlatformAttribute.xml b/xml/System.Runtime.Versioning/UnsupportedOSPlatformAttribute.xml index 1fd772d23f5..58de7359ba6 100644 --- a/xml/System.Runtime.Versioning/UnsupportedOSPlatformAttribute.xml +++ b/xml/System.Runtime.Versioning/UnsupportedOSPlatformAttribute.xml @@ -20,8 +20,16 @@ - To be added. - To be added. + Marks APIs that were removed or are unsupported in a given operating system version. + + + @@ -40,8 +48,8 @@ - To be added. - To be added. + The unsupported OS platform name, optionally including a version. + Initializes a new instance of the attribute class for the specified unsupported OS platform. To be added. From 46cdcbb0767f044b7e97a314a9e139bc4f3b4b79 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 21 Sep 2020 22:06:22 -0700 Subject: [PATCH 17/31] Document System.Enum (#4894) Co-authored-by: carlossanlop --- xml/System/Enum.xml | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/xml/System/Enum.xml b/xml/System/Enum.xml index 0ced977e822..7afa1a12a3f 100644 --- a/xml/System/Enum.xml +++ b/xml/System/Enum.xml @@ -701,10 +701,10 @@ - To be added. - To be added. - To be added. - To be added. + The type of the enumeration. + The value of a particular enumerated constant in terms of its underlying type. + Retrieves the name of the constant in the specified enumeration type that has the specified value. + A string containing the name of the enumerated constant in whose value is ; or if no such constant is found. To be added. @@ -816,9 +816,9 @@ - To be added. - To be added. - To be added. + The type of the enumeration. + Retrieves an array of the names of the constants in a specified enumeration type. + A string array of the names of the constants in . To be added. @@ -1064,9 +1064,9 @@ - To be added. - To be added. - To be added. + The type of the enumeration. + Retrieves an array of the values of the constants in a specified enumeration type. + An array that contains the values of the constants in . To be added. @@ -1288,10 +1288,11 @@ thisInstance And flag = flag - To be added. - To be added. - To be added. - To be added. + The type of the enumeration. + The value or name of a constant in . + Returns a boolean telling whether a given integral value, or its name as a string, exists in a specified enumeration. + + if a given integral value, or its name as a string, exists in a specified enumeration; otherwise. To be added. From c3e0e6cfc27b68f3550d358ae9b5d481fdf96bfa Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 21 Sep 2020 22:07:04 -0700 Subject: [PATCH 18/31] Document Half.op_Explicit APIs (#4893) * Document Half.op_Explicit APIs * Equals Co-authored-by: carlossanlop --- xml/System/Half.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/xml/System/Half.xml b/xml/System/Half.xml index bf15334030e..0b5fb89d9cd 100644 --- a/xml/System/Half.xml +++ b/xml/System/Half.xml @@ -148,7 +148,7 @@ - To be added. + A half-precision floating point number to compare to this instance. Compares this instance for equality with . if the current object is equal to ; otherwise, . @@ -174,7 +174,7 @@ - To be added. + The object to compare to this instance. Returns a value that indicates whether this instance is equal to the specified . if is an instance of and equals the value of this instance; otherwise, . @@ -544,7 +544,7 @@ The double-precision floating point value to convert to . An explicit operator to convert a value to a . - To be added. + The representation of the specified double-precision floating point . To be added. @@ -569,7 +569,7 @@ The half-precision floating point value to convert to . An explicit operator to convert a value to a . - To be added. + The representation of the specified half-precision floating point . To be added. @@ -594,7 +594,7 @@ The half-precision floating point value to convert to . An explicit operator to convert a value to a . - To be added. + The representation of the specified half-precision floating point . To be added. @@ -619,7 +619,7 @@ The single-precision floating point value to convert to . An explicit operator to convert a value to a . - To be added. + The representation of the specified single-precision floating point . To be added. From 8c65a796df20e7a0470268b5a9b6eab38f5f7550 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 21 Sep 2020 22:14:16 -0700 Subject: [PATCH 19/31] Automatic port of Rune.CompareTo EII (#4891) Co-authored-by: carlossanlop --- xml/System.Text/Rune.xml | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/xml/System.Text/Rune.xml b/xml/System.Text/Rune.xml index 5dc4bb5bd89..563851753b2 100644 --- a/xml/System.Text/Rune.xml +++ b/xml/System.Text/Rune.xml @@ -1694,10 +1694,20 @@ For more information, see - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Compares the current instance to the specified object. + A signed integer indicating the position of this instance in the sort order in relation to :
- Less than zero: This instance precedes . +
- Zero: The instance has the same position in the sort order as . +
- Greater than zero: This instance follows . + + instance is cast to an interface. + + ]]> + From 4bc44c6e2959f343eacd4eebe10be3826cd7d1bd Mon Sep 17 00:00:00 2001 From: Jeremy Barton Date: Tue, 22 Sep 2020 10:41:51 -0700 Subject: [PATCH 20/31] Add missing docs for AsnContentException. (#4895) --- .../AsnContentException.xml | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/xml/System.Formats.Asn1/AsnContentException.xml b/xml/System.Formats.Asn1/AsnContentException.xml index 48f0aa82269..f44c069d2ec 100644 --- a/xml/System.Formats.Asn1/AsnContentException.xml +++ b/xml/System.Formats.Asn1/AsnContentException.xml @@ -14,7 +14,7 @@ - To be added. + The exception that is thrown when an encoded ASN.1 value cannot be successfully decoded. To be added. @@ -31,7 +31,7 @@ - To be added. + Initializes a new instance of the class, using the default message. To be added. @@ -51,8 +51,8 @@ - To be added. - To be added. + The error message that explains the reason for the exception. + Initializes a new instance of the class, using the provided message. To be added. @@ -73,9 +73,9 @@ - To be added. - To be added. - To be added. + The object that holds the serialized object data. + The contextual information about the source or destination. + Initializes a new instance of the class with serialized data. To be added. @@ -96,9 +96,9 @@ - To be added. - To be added. - To be added. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception. + Initializes a new instance of the class, using the provided message and exception that is the cause of this exception. To be added. From 7ee0284d7241346925c760e1ebbdb4f289c58aea Mon Sep 17 00:00:00 2001 From: Jeremy Barton Date: Tue, 22 Sep 2020 10:46:12 -0700 Subject: [PATCH 21/31] Add missing documentation for S.S.Cryptography (#4892) * Add missing documentation for S.S.Cryptography * Apply feedback --- .../ContentInfo.xml | 19 +++++++------ .../SignedCms.xml | 13 +++++---- .../X509Certificate2.xml | 27 +++++++++++++++---- .../X509SubjectKeyIdentifierExtension.xml | 7 ++--- 4 files changed, 43 insertions(+), 23 deletions(-) diff --git a/xml/System.Security.Cryptography.Pkcs/ContentInfo.xml b/xml/System.Security.Cryptography.Pkcs/ContentInfo.xml index b311f450e3e..2db44c1f45e 100644 --- a/xml/System.Security.Cryptography.Pkcs/ContentInfo.xml +++ b/xml/System.Security.Cryptography.Pkcs/ContentInfo.xml @@ -283,14 +283,12 @@ - An array of byte values that represents the encoded message from which to retrieve the outer content type. - The static method retrieves the outer content type of the encoded message represented by an array of byte values. - If the method succeeds, the method returns an object that contains the outer content type of the specified encoded message. - - If the method fails, it throws an exception. + An array of byte values that represents the encoded CMS ContentInfo message from which to retrieve the outer content type. + Retrieves the outer content type of an encoded CMS ContentInfo message. + The outer content type of the specified encoded CMS ContentInfo message. To be added. - A null reference was passed to a method that does not accept it as a valid argument. - An error occurred during a cryptographic operation. + is . + cannot be decoded as a valid CMS ContentInfo value. @@ -312,10 +310,11 @@ - To be added. - To be added. - To be added. + A read-only span of byte values that represents the encoded CMS ContentInfo message from which to retrieve the outer content type. + Retrieves the outer content type of an encoded CMS ContentInfo message. + The outer content type of the specified encoded CMS ContentInfo message. To be added. + cannot be decoded as a valid CMS ContentInfo value. diff --git a/xml/System.Security.Cryptography.Pkcs/SignedCms.xml b/xml/System.Security.Cryptography.Pkcs/SignedCms.xml index f83bde332d8..dedf8c1acbe 100644 --- a/xml/System.Security.Cryptography.Pkcs/SignedCms.xml +++ b/xml/System.Security.Cryptography.Pkcs/SignedCms.xml @@ -844,8 +844,8 @@ The following permissions are required to access the signature key: - Array of byte values that represents the encoded CMS/PKCS #7 message to be decoded. - The method decodes an encoded message. Upon successful decoding, the decoded information can be retrieved from the properties of the object. + An array of byte values that represents the encoded CMS/PKCS#7 message to be decoded. + Decodes an encoded message. - A null reference was passed to a method that does not accept it as a valid argument. - A cryptographic operation could not be completed. + is . + could not be decoded successfully. @@ -891,9 +891,12 @@ The following permissions are required to access the signature key: - To be added. To be added. + A read-only span of byte values that represents the encoded CMS/PKCS#7 message to be decoded. + Decodes an encoded message. To be added. + could not be decoded successfully. + diff --git a/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml b/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml index a710d53169b..828d3d5a90c 100644 --- a/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml +++ b/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml @@ -819,11 +819,28 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The name of a certificate file. + The password required to access the X.509 certificate data. + A bitwise combination of the enumeration values that control where and how to import the certificate. + Initializes a new instance of the class using a certificate file name, a password, and a key storage flag. + + [!IMPORTANT] +> Never hard code a password within your source code. Hard-coded passwords can be retrieved from an assembly using the [Ildasm.exe (IL Disassembler)](/dotnet/framework/tools/ildasm-exe-il-disassembler), a hex editor, or by simply opening up the assembly in a text editor such as Notepad.exe. + +If you create an certificate by specifying a PKCS7 signed file store for `fileName`, the is created for the certificate that signed the store rather than for any of the certificates within the store. + + ]]> + + An error with the certificate occurs. For example: + +- The certificate file does not exist. + +- The certificate is invalid. + +- The certificate's password is incorrect. diff --git a/xml/System.Security.Cryptography.X509Certificates/X509SubjectKeyIdentifierExtension.xml b/xml/System.Security.Cryptography.X509Certificates/X509SubjectKeyIdentifierExtension.xml index 60e241a3da2..ccc3c14fac8 100644 --- a/xml/System.Security.Cryptography.X509Certificates/X509SubjectKeyIdentifierExtension.xml +++ b/xml/System.Security.Cryptography.X509Certificates/X509SubjectKeyIdentifierExtension.xml @@ -168,9 +168,10 @@ - To be added. - To be added. - To be added. + A read-only span of bytes that represents data to use to create the extension. + + if the extension is critical; otherwise, . + Initializes a new instance of the class using a read-only span of bytes and a value that identifies whether the extension is critical. To be added. From 9473f33c87a7143ffd607e0f8222c2d0c3d4fb08 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 22 Sep 2020 10:46:41 -0700 Subject: [PATCH 22/31] Automatic port of System.Threading.ExecutionContext.Restore doc (#4887) * Automatic port of System.Threading.ExecutionContext.Restore doc * Update xml/System.Threading/ExecutionContext.xml Co-authored-by: Prashanth Govindarajan * Apply suggestions from code review Co-authored-by: carlossanlop Co-authored-by: Prashanth Govindarajan --- xml/System.Threading/ExecutionContext.xml | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/xml/System.Threading/ExecutionContext.xml b/xml/System.Threading/ExecutionContext.xml index 170bf78be96..8dc781b8c22 100644 --- a/xml/System.Threading/ExecutionContext.xml +++ b/xml/System.Threading/ExecutionContext.xml @@ -359,9 +359,17 @@ - To be added. - To be added. - To be added. + The ExecutionContext to set. + Restores a captured execution context on to the current thread. + + + From 393174adc3bb6b84156f9221c13b551da10df82b Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 22 Sep 2020 12:14:33 -0700 Subject: [PATCH 23/31] Automatic port of explicit interface implementation of System.Net.Http.HttpRequestOptions (#4881) * Automatic port of explicit interface implementations for System.Net.Http.HttpRequestOptions * Apply suggestions from code review Co-authored-by: Jan Jahoda Co-authored-by: carlossanlop Co-authored-by: Jan Jahoda --- xml/System.Net.Http/HttpRequestOptions.xml | 227 ++++++++++++++++----- 1 file changed, 176 insertions(+), 51 deletions(-) diff --git a/xml/System.Net.Http/HttpRequestOptions.xml b/xml/System.Net.Http/HttpRequestOptions.xml index 76da1ef464c..de5c2db5e59 100644 --- a/xml/System.Net.Http/HttpRequestOptions.xml +++ b/xml/System.Net.Http/HttpRequestOptions.xml @@ -109,9 +109,17 @@ - To be added. - To be added. - To be added. + The object to add to the . + Adds an item to the . + + instance is cast to an interface. + + ]]> + @@ -134,8 +142,16 @@ - To be added. - To be added. + Removes all items from the . + + instance is cast to an interface. + + ]]> + @@ -160,10 +176,19 @@ - To be added. - To be added. - To be added. - To be added. + The object to locate in the . + Determines whether the contains a specific value. + + if is found in the ; otherwise, . + + instance is cast to an interface. + + ]]> + @@ -189,10 +214,18 @@ - To be added. - To be added. - To be added. - To be added. + The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. + The zero-based index in at which copying begins. + Copies the elements of the to an , starting at a particular index. + + instance is cast to an interface. + + ]]> + @@ -214,9 +247,17 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of elements contained in the . + The number of elements contained in the . + + instance is cast to an interface. + + ]]> + @@ -238,9 +279,18 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the is read-only. + + if the is read-only; otherwise, . + + instance is cast to an interface. + + ]]> + @@ -265,10 +315,19 @@ - To be added. - To be added. - To be added. - To be added. + The object to remove from the . + Removes the first occurrence of a specific object from the . + + if was successfully removed from the ; otherwise, . This method also returns if is not found in the original . + + instance is cast to an interface. + + ]]> + @@ -294,10 +353,18 @@ - To be added. - To be added. - To be added. - To be added. + The object to use as the key of the element to add. + The object to use as the value of the element to add. + Adds an element with the provided key and value to the . + + instance is cast to an interface. + + ]]> + @@ -322,10 +389,19 @@ - To be added. - To be added. - To be added. - To be added. + The key to locate in the . + Determines whether the contains an element with the specified key. + + if the contains an element with the key; otherwise, . + + instance is cast to an interface. + + ]]> + @@ -350,10 +426,18 @@ - To be added. - To be added. - To be added. - To be added. + The key of the element to get or set. + Gets or sets the element with the specified key. + The element with the specified key. + + instance is cast to an interface. + + ]]> + @@ -375,9 +459,17 @@ System.Collections.Generic.ICollection<System.String> - To be added. - To be added. - To be added. + Gets an containing the keys of the . + An containing the keys of the object that implements . + + instance is cast to an interface. + + ]]> + @@ -402,10 +494,19 @@ - To be added. - To be added. - To be added. - To be added. + The key of the element to remove. + Removes the element with the specified key from the . + + if the element is successfully removed; otherwise, . This method also returns if was not found in the original . + + instance is cast to an interface. + + ]]> + @@ -454,9 +555,17 @@ System.Collections.Generic.ICollection<System.Object> - To be added. - To be added. - To be added. + Gets an containing the values in the . + An containing the values in the object that implements . + + instance is cast to an interface. + + ]]> + @@ -479,9 +588,17 @@ - To be added. - To be added. - To be added. + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the collection. + + instance is cast to an interface. + + ]]> + @@ -504,9 +621,17 @@ - To be added. - To be added. - To be added. + Returns an enumerator that iterates through a collection. + An object that can be used to iterate through the collection. + + instance is cast to an interface. + + ]]> + From 7f0edcd33328aaa1663850cb09d4142590e80911 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 22 Sep 2020 13:42:59 -0700 Subject: [PATCH 24/31] Document Type.IsAssignableTo (#4898) Co-authored-by: carlossanlop --- xml/System/Type.xml | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/xml/System/Type.xml b/xml/System/Type.xml index ddff120b04c..baa371a1741 100644 --- a/xml/System/Type.xml +++ b/xml/System/Type.xml @@ -10881,7 +10881,7 @@ GetType(Array).IsAssignableFrom(type) The type to compare with the current type. - Determines whether an instance of a specified type can be assigned to a variable of the current type. + Determines whether an instance of a specified type can be assigned to a variable of the current type. if any of the following conditions is true: @@ -10971,9 +10971,21 @@ GetType(Array).IsAssignableFrom(type) - To be added. - To be added. - To be added. + The type to compare with the current type. + Determines whether the current type can be assigned to a variable of the specified . + if any of the following conditions is true: + +- The current instance and represent the same type. + +- The current type is derived either directly or indirectly from . The current type is derived directly from if it inherits from ; the current type is derived indirectly from if it inherits from a succession of one or more classes that inherit from . + +- is an interface that the current type implements. + +- The current type is a generic type parameter, and represents one of the constraints of the current type. + +- The current type represents a value type, and represents Nullable<c> (Nullable(Of c) in Visual Basic). + + if none of these conditions are true, or if or is . To be added. From 66fabc5d79a1611b09d1a5d9b8a09a65788b9de3 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 22 Sep 2020 13:43:12 -0700 Subject: [PATCH 25/31] Document System.PlatformID.Other (#4897) Co-authored-by: carlossanlop --- xml/System/PlatformID.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System/PlatformID.xml b/xml/System/PlatformID.xml index 0ef0c858c55..10bb6085a35 100644 --- a/xml/System/PlatformID.xml +++ b/xml/System/PlatformID.xml @@ -132,7 +132,7 @@ 7 - To be added. + Any other operating system. This includes Browser (WASM). From 286066bf8a52a86fa5a566cde8196205ab12f6ef Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Tue, 22 Sep 2020 22:51:37 +0200 Subject: [PATCH 26/31] HTTP Version Selection (#4870) * Sync docs with source comments * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Add values Co-authored-by: Jan Jahoda Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Net.Http/HttpClient.xml | 12 ++++++-- xml/System.Net.Http/HttpRequestMessage.xml | 4 +-- xml/System.Net.Http/HttpVersionPolicy.xml | 35 +++++++++++++++++++--- 3 files changed, 42 insertions(+), 9 deletions(-) diff --git a/xml/System.Net.Http/HttpClient.xml b/xml/System.Net.Http/HttpClient.xml index 2b181b67acf..6b552d1700c 100644 --- a/xml/System.Net.Http/HttpClient.xml +++ b/xml/System.Net.Http/HttpClient.xml @@ -541,9 +541,15 @@ The `DefaultRequestVersion` property can be changed as long as the System.Net.Http.HttpVersionPolicy - To be added. - To be added. - To be added. + Gets or sets the default version policy for implicitly created requests in convenience methods, for example, and . + The HttpVersionPolicy used when the HTTP connection is established. + + or overloads that accept an . + ]]> + diff --git a/xml/System.Net.Http/HttpRequestMessage.xml b/xml/System.Net.Http/HttpRequestMessage.xml index 6e94249e420..0cb09ed3d26 100644 --- a/xml/System.Net.Http/HttpRequestMessage.xml +++ b/xml/System.Net.Http/HttpRequestMessage.xml @@ -569,8 +569,8 @@ The following table lists the default message version based on the version of .N System.Net.Http.HttpVersionPolicy - To be added. - To be added. + Gets or sets the policy that determines how is interpreted and how the final HTTP version is negotiated with the server. + The HttpVersionPolicy used when the HTTP connection is established. To be added. diff --git a/xml/System.Net.Http/HttpVersionPolicy.xml b/xml/System.Net.Http/HttpVersionPolicy.xml index ffe11c7b5b4..6692d6d767b 100644 --- a/xml/System.Net.Http/HttpVersionPolicy.xml +++ b/xml/System.Net.Http/HttpVersionPolicy.xml @@ -13,7 +13,7 @@ System.Enum - To be added. + Specifies behaviors for selecting and negotiating the HTTP version for a request. To be added. @@ -34,7 +34,15 @@ 2 - To be added. + Only use the requested version. + + + @@ -54,7 +62,17 @@ 1 - To be added. + Use the highest available version, downgrading only to the requested version but not below. + + . + +This option allows use of a prenegotiated clear text connection for the requested version but not for a higher version. + + ]]> + @@ -74,7 +92,16 @@ 0 - To be added. + Use the requested version or downgrade to a lower one. This is the default behavior. + + . Otherwise, the version downgrades to HTTP/1.1. + +This option does not allow use of a prenegotiated clear text connection, for example, H2C. + ]]> + From 3cc1ed8d24aab038a0ee775082e07c88f0b83d8f Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Tue, 22 Sep 2020 22:53:02 +0200 Subject: [PATCH 27/31] HttpClient sync operations (#4776) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Draft for @manickap * Apply suggestions from code review Co-authored-by: Marie Píchová <11718369+ManickaP@users.noreply.github.com> * Format verification * Format verification * Fix links * Fix links * Fix xml tag * Fix links * Fix links * Fix links * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Fix links * Add CreateContentReadStream * Fix links * Add System.Net.Http.DelegatingHandler.Send * Fix links * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Remove "Synchronous" information from summary * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Fix the exception description Co-authored-by: Jan Jahoda Co-authored-by: Marie Píchová <11718369+ManickaP@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Net.Http/ByteArrayContent.xml | 32 +++-- xml/System.Net.Http/DelegatingHandler.xml | 19 ++- xml/System.Net.Http/HttpClient.xml | 132 +++++++++++++++--- xml/System.Net.Http/HttpClientHandler.xml | 33 ++++- xml/System.Net.Http/HttpContent.xml | 64 ++++++--- xml/System.Net.Http/HttpMessageHandler.xml | 9 +- xml/System.Net.Http/HttpMessageInvoker.xml | 29 +++- .../MessageProcessingHandler.xml | 17 ++- xml/System.Net.Http/MultipartContent.xml | 34 +++-- xml/System.Net.Http/ReadOnlyMemoryContent.xml | 17 ++- xml/System.Net.Http/SocketsHttpHandler.xml | 17 ++- xml/System.Net.Http/StreamContent.xml | 34 +++-- 12 files changed, 340 insertions(+), 97 deletions(-) diff --git a/xml/System.Net.Http/ByteArrayContent.xml b/xml/System.Net.Http/ByteArrayContent.xml index a2e84f09999..816dc8a58d6 100644 --- a/xml/System.Net.Http/ByteArrayContent.xml +++ b/xml/System.Net.Http/ByteArrayContent.xml @@ -156,10 +156,17 @@ - To be added. - To be added. - To be added. - To be added. + The cancellation token to cancel the operation. + Creates an HTTP content stream for reading. It uses the memory from the as a backing store. + The HTTP content stream. + + + @@ -226,11 +233,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The target stream. + Optional information about the transport, like the channel binding token. This parameter can be . + The cancellation token to cancel the operation. + Serializes and writes the byte array provided in the constructor to an HTTP content stream. + + + diff --git a/xml/System.Net.Http/DelegatingHandler.xml b/xml/System.Net.Http/DelegatingHandler.xml index df6a7a407a5..8b1049bd50f 100644 --- a/xml/System.Net.Http/DelegatingHandler.xml +++ b/xml/System.Net.Http/DelegatingHandler.xml @@ -221,11 +221,20 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The HTTP request message to send to the server. + A cancellation token to cancel operation. + Sends an HTTP request to the inner handler to send to the server. + An HTTP response message. + + method is mainly used by the system and not by applications. When this method is called, it calls the method on the inner handler. + + ]]> + diff --git a/xml/System.Net.Http/HttpClient.xml b/xml/System.Net.Http/HttpClient.xml index 6b552d1700c..38f01b2e321 100644 --- a/xml/System.Net.Http/HttpClient.xml +++ b/xml/System.Net.Http/HttpClient.xml @@ -2692,10 +2692,31 @@ The is not an absolute URI. - To be added. - To be added. - To be added. - To be added. + The HTTP request message to send. + Sends an HTTP request with the specified request. + An HTTP response message. + + + + The is . + The HTTP version is 2.0 or higher or the version policy is set to . + + -or- + +The custom class derived from does not override the method. + + -or- + +The custom does not override the method. + The request message was already sent by the instance. + The request failed due to an underlying issue such as network connectivity, DNS failure, or server certificate validation. + If the exception nests the : + The request failed due to timeout. @@ -2721,11 +2742,32 @@ The is not an absolute URI. - To be added. - To be added. - To be added. - To be added. - To be added. + The HTTP request message to send. + One of the enumeration values that specifies when the operation should complete (as soon as a response is available or after reading the response content). + Sends an HTTP request. + The HTTP response message. + + + + The is . + The HTTP version is 2.0 or higher or the version policy is set to . + + -or- + + The custom class derived from does not override the method. + + -or- + +The custom does not override the method. + The request message was already sent by the instance. + The request failed due to an underlying issue such as network connectivity, DNS failure, or server certificate validation. + If the exception nests the : + The request failed due to timeout. @@ -2751,11 +2793,36 @@ The is not an absolute URI. - To be added. - To be added. - To be added. - To be added. - To be added. + The HTTP request message to send. + The token to cancel the operation. + Sends an HTTP request with the specified request and cancellation token. + The HTTP response message. + + + + The is . + The HTTP version is 2.0 or higher or the version policy is set to . + + -or- + + The custom class derived from does not override the method. + + -or- + +The custom does not override the method. + The request message was already sent by the instance. + The request failed due to an underlying issue such as network connectivity, DNS failure, or server certificate validation. + The request was canceled. + + -or- + + If the exception nests the : + The request failed due to timeout. @@ -2782,12 +2849,37 @@ The is not an absolute URI. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The HTTP request message to send. + One of the enumeration values that specifies when the operation should complete (as soon as a response is available or after reading the response content). + The token to cancel the operation. + Sends an HTTP request with the specified request, completion option and cancellation token. + The HTTP response message. + + + + The is . + The HTTP version is 2.0 or higher or the version policy is set to . + + -or- + + The custom class derived from does not override the method. + + -or- + +The custom does not override the method. + The request message was already sent by the instance. + The request failed due to an underlying issue such as network connectivity, DNS failure, or server certificate validation. + The request was canceled. + + -or- + + If the exception nests the : + The request failed due to timeout. diff --git a/xml/System.Net.Http/HttpClientHandler.xml b/xml/System.Net.Http/HttpClientHandler.xml index 6ae34049e83..31074d7f171 100644 --- a/xml/System.Net.Http/HttpClientHandler.xml +++ b/xml/System.Net.Http/HttpClientHandler.xml @@ -862,11 +862,34 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA - To be added. - To be added. - To be added. - To be added. - To be added. + The HTTP request message. + A cancellation token to cancel the operation. + Creates an instance of based on the information provided in the . + The HTTP response message. + + + + The was . + For HTTP/2 and higher or when requesting version upgrade is enabled by . + + -or- + + If using custom class derived from not overriding method. + + -or- + + If using custom not overriding method. + The request was canceled. + + -or- + + If the exception nests the : + The request failed due to timeout. diff --git a/xml/System.Net.Http/HttpContent.xml b/xml/System.Net.Http/HttpContent.xml index b7f25ab9047..db44e5b6157 100644 --- a/xml/System.Net.Http/HttpContent.xml +++ b/xml/System.Net.Http/HttpContent.xml @@ -88,11 +88,19 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The target stream. + Information about the transport (for example, the channel binding token). This parameter may be . + The cancellation token to cancel the operation. + Serializes the HTTP content into a stream of bytes and copies it to . + + + + The was . @@ -737,9 +745,16 @@ - To be added. - To be added. - To be added. + Serializes the HTTP content and returns a stream that represents the content. + The stream that represents the HTTP content. + + + @@ -764,10 +779,17 @@ - To be added. - To be added. - To be added. - To be added. + The cancellation token to cancel the operation. + Serializes the HTTP content and returns a stream that represents the content. + The stream that represents the HTTP content. + + + @@ -964,11 +986,19 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The target stream. + Information about the transport (for example, the channel binding token). This parameter may be . + The cancellation token to cancel the operation. + When overridden in a derived class, serializes the HTTP content to a stream. Otherwise, throws a . + + + + The method is not overridden in the derived class. diff --git a/xml/System.Net.Http/HttpMessageHandler.xml b/xml/System.Net.Http/HttpMessageHandler.xml index 4f730e0a0e9..3f9176205a6 100644 --- a/xml/System.Net.Http/HttpMessageHandler.xml +++ b/xml/System.Net.Http/HttpMessageHandler.xml @@ -196,11 +196,12 @@ - To be added. - To be added. - To be added. - To be added. + The HTTP request message to send. + The cancellation token to cancel operation. + When overridden in a derived class, sends an HTTP request with the specified request and cancellation token. Otherwise, throws a . + The HTTP response message. To be added. + The method is not overridden in the derived class. diff --git a/xml/System.Net.Http/HttpMessageInvoker.xml b/xml/System.Net.Http/HttpMessageInvoker.xml index 90ed3048543..92586fbff04 100644 --- a/xml/System.Net.Http/HttpMessageInvoker.xml +++ b/xml/System.Net.Http/HttpMessageInvoker.xml @@ -230,11 +230,30 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The HTTP request message to send. + The cancellation token to cancel operation. + Sends an HTTP request with the specified request and cancellation token. + The HTTP response message. + + or methods on the class. + + ]]> + + The was . + For HTTP/2 and higher or when requesting version upgrade is enabled by . + + -or- + + If using custom class derived from not overriding method. + + -or- + + If using custom not overriding method. diff --git a/xml/System.Net.Http/MessageProcessingHandler.xml b/xml/System.Net.Http/MessageProcessingHandler.xml index e39716b183d..251fe4ea6fd 100644 --- a/xml/System.Net.Http/MessageProcessingHandler.xml +++ b/xml/System.Net.Http/MessageProcessingHandler.xml @@ -226,11 +226,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The HTTP request message to send to the server. + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + Sends an HTTP request to the inner handler to send to the server. + The HTTP response message. + + + diff --git a/xml/System.Net.Http/MultipartContent.xml b/xml/System.Net.Http/MultipartContent.xml index 2aee3a22cb0..2b29c753104 100644 --- a/xml/System.Net.Http/MultipartContent.xml +++ b/xml/System.Net.Http/MultipartContent.xml @@ -212,10 +212,19 @@ - To be added. - To be added. - To be added. - To be added. + The cancellation token to cancel the operation. + Serializes the HTTP content to a stream using the multipart/* encoding. + The HTTP content stream that represents the multipart/* encoded HTTP content. + + to use a custom stream that contains an array, with each HTTP content entity and its boundary encoded and serialized to a instance. + +This operation blocks until all of the content has been written to the memory stream. + + ]]> + @@ -434,11 +443,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The target stream. + Information about the transport (for example, the channel binding token). This parameter may be . + The cancellation token to cancel the operation. + Serializes the multipart HTTP content to a stream. + + + diff --git a/xml/System.Net.Http/ReadOnlyMemoryContent.xml b/xml/System.Net.Http/ReadOnlyMemoryContent.xml index 6741e9496ae..2f57c60c4b9 100644 --- a/xml/System.Net.Http/ReadOnlyMemoryContent.xml +++ b/xml/System.Net.Http/ReadOnlyMemoryContent.xml @@ -134,11 +134,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The target stream. + Information about the transport (for example, the channel binding token). This parameter may be . + The cancellation token to cancel the operation. + Serializes the multipart HTTP content to a stream. + + + diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index c446ed3e770..83deb87932a 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -746,11 +746,20 @@ Draining occurs when a request is cancelled or a response is disposed prior to f - To be added. - To be added. - To be added. - To be added. + The HTTP request message to send. + The cancellation token. + Sends an HTTP request. + The HTTP response message. To be added. +For HTTP/2 and higher or when requesting version upgrade is enabled by . + + -or- + + If using custom class derived from not overriding method. + + -or- + + If using custom not overriding method. diff --git a/xml/System.Net.Http/StreamContent.xml b/xml/System.Net.Http/StreamContent.xml index fb2ecd95a90..c49823b033e 100644 --- a/xml/System.Net.Http/StreamContent.xml +++ b/xml/System.Net.Http/StreamContent.xml @@ -149,10 +149,19 @@ The object calls - To be added. - To be added. - To be added. - To be added. + The cancellation token to cancel the operation. + Writes the HTTP stream content to a memory stream. + The HTTP content stream. + + method buffers the content to a memory stream. Derived classes can override this behavior if there's a better way to retrieve the content as stream. For example, a byte array or a string could use a more efficient mechanism, such as wrapping a read-only around the bytes or string. + + ]]> + @@ -264,11 +273,18 @@ The object calls - To be added. - To be added. - To be added. - To be added. - To be added. + The target stream. + Information about the transport (for example, the channel binding token). This parameter may be . + The cancellation token to cancel the operation. + Serializes the multipart HTTP content to a stream. + + + From 25bd53d851b7741d93146f7ec6625e8049cb7ca7 Mon Sep 17 00:00:00 2001 From: Anirudh Agnihotry Date: Tue, 22 Sep 2020 15:21:03 -0700 Subject: [PATCH 28/31] adding docs for missing 5.0 apis for system.Runtime.CompilerServices.Unsafe (#4902) * adding docs for missing 5.0 apis * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- .../CppInlineNamespaceAttribute.xml | 13 +++++++++---- .../ModuleInitializerAttribute.xml | 12 ++++++++++-- .../PreserveBaseOverridesAttribute.xml | 4 ++-- .../SkipLocalsInitAttribute.xml | 2 +- xml/System.Runtime.CompilerServices/Unsafe.xml | 6 +++--- 5 files changed, 25 insertions(+), 12 deletions(-) diff --git a/xml/System.Runtime.CompilerServices/CppInlineNamespaceAttribute.xml b/xml/System.Runtime.CompilerServices/CppInlineNamespaceAttribute.xml index 01d47cabc4a..067363128e2 100644 --- a/xml/System.Runtime.CompilerServices/CppInlineNamespaceAttribute.xml +++ b/xml/System.Runtime.CompilerServices/CppInlineNamespaceAttribute.xml @@ -20,8 +20,13 @@ - To be added. - To be added. + Defines the inline namespace in C++/CLI. + + + @@ -40,8 +45,8 @@ - To be added. - To be added. + The dotted name of the defined namespace. + Initializes a new instance of the class with the specified dotted namespace name. To be added. diff --git a/xml/System.Runtime.CompilerServices/ModuleInitializerAttribute.xml b/xml/System.Runtime.CompilerServices/ModuleInitializerAttribute.xml index 1e9f60f166c..59def82bdc3 100644 --- a/xml/System.Runtime.CompilerServices/ModuleInitializerAttribute.xml +++ b/xml/System.Runtime.CompilerServices/ModuleInitializerAttribute.xml @@ -56,8 +56,16 @@ For more information, see [the specification for module initializers](https://gi - To be added. - To be added. + Initializes a new instance of the class. + + attribute provides additional runtime guarantees to methods. For example, the marked methods are guaranteed to run before any other method is invoked or any field is accessed in the whole module. + + ]]> + diff --git a/xml/System.Runtime.CompilerServices/PreserveBaseOverridesAttribute.xml b/xml/System.Runtime.CompilerServices/PreserveBaseOverridesAttribute.xml index 8d1a1b89bb9..c79f087fce4 100644 --- a/xml/System.Runtime.CompilerServices/PreserveBaseOverridesAttribute.xml +++ b/xml/System.Runtime.CompilerServices/PreserveBaseOverridesAttribute.xml @@ -20,7 +20,7 @@ - To be added. + Ensures that any virtual call to the method, whether it uses the base signature or derived signature of the method, executes the most derived override. To be added. @@ -37,7 +37,7 @@ - To be added. + Initializes a new instance of the class. To be added. diff --git a/xml/System.Runtime.CompilerServices/SkipLocalsInitAttribute.xml b/xml/System.Runtime.CompilerServices/SkipLocalsInitAttribute.xml index e283b8350d9..45429e1ac40 100644 --- a/xml/System.Runtime.CompilerServices/SkipLocalsInitAttribute.xml +++ b/xml/System.Runtime.CompilerServices/SkipLocalsInitAttribute.xml @@ -45,7 +45,7 @@ This attribute is unsafe, because it may reveal uninitialized memory to the appl - To be added. + Initializes a new instance of the class. To be added. diff --git a/xml/System.Runtime.CompilerServices/Unsafe.xml b/xml/System.Runtime.CompilerServices/Unsafe.xml index dec5b67afd6..df4516a79bf 100644 --- a/xml/System.Runtime.CompilerServices/Unsafe.xml +++ b/xml/System.Runtime.CompilerServices/Unsafe.xml @@ -1049,9 +1049,9 @@ - To be added. - To be added. - To be added. + The type of the uninitialized object. + The uninitialized object. + Bypasses definite assignment rules for a given value. To be added. From acae6fda9ba6963a3bd358bbd9af3e0f7c9955a4 Mon Sep 17 00:00:00 2001 From: Prashanth Govindarajan Date: Tue, 22 Sep 2020 19:25:08 -0700 Subject: [PATCH 29/31] resolve conflict --- .../CollectionExtensions.xml | 48 ++++---- .../LinkedListNode`1.xml | 108 +++++++++--------- 2 files changed, 81 insertions(+), 75 deletions(-) diff --git a/xml/System.Collections.Generic/CollectionExtensions.xml b/xml/System.Collections.Generic/CollectionExtensions.xml index 56c9c95a0ef..efda6b1edb6 100644 --- a/xml/System.Collections.Generic/CollectionExtensions.xml +++ b/xml/System.Collections.Generic/CollectionExtensions.xml @@ -57,10 +57,11 @@ - To be added. - To be added. - To be added. + The source enumeration of . + Gets an enumeration of assets where each asset has an empty runtime. + An enumeration of assets, each with an empty . To be added. + Thrown when is . @@ -88,10 +89,11 @@ - To be added. - To be added. - To be added. + The source enumeration of . + Gets the first with an empty . + The first with an empty , or if none exists. To be added. + Thrown when is . @@ -119,10 +121,11 @@ - To be added. - To be added. - To be added. + The source enumeration of . + Gets an enumeration of where each value has an empty runtime. + An enumeration of , each with an empty . To be added. + Thrown when is . @@ -151,11 +154,12 @@ - To be added. - To be added. - To be added. - To be added. + The source enumeration of . + The string to search for. + Gets an enumeration of assets where each asset's value equals . + An enumeration of assets where each asset's equals . To be added. + Thrown when is . @@ -184,11 +188,12 @@ - To be added. - To be added. - To be added. - To be added. + The source enumeration of . + The string to search for. + Gets an enumeration of where each value's equals . + An enumeration of , where each value's equals . To be added. + Thrown when is or empty. @@ -217,11 +222,12 @@ - To be added. - To be added. - To be added. - To be added. + The source enumeration of . + The string to search for. + Gets the first where matches . + The first where matches , or if none exists. To be added. + Thrown when is or empty. diff --git a/xml/System.Collections.Generic/LinkedListNode`1.xml b/xml/System.Collections.Generic/LinkedListNode`1.xml index d207890068c..d55fa7392ec 100644 --- a/xml/System.Collections.Generic/LinkedListNode`1.xml +++ b/xml/System.Collections.Generic/LinkedListNode`1.xml @@ -46,20 +46,20 @@ Specifies the element type of the linked list. Represents a node in a . This class cannot be inherited. - collection is a . The contains a value, a reference to the that it belongs to, a reference to the next node, and a reference to the previous node. - - - -## Examples - The following code example creates a , adds it to a , and tracks the values of its properties as the changes. - + collection is a . The contains a value, a reference to the that it belongs to, a reference to the next node, and a reference to the previous node. + + + +## Examples + The following code example creates a , adds it to a , and tracks the values of its properties as the changes. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/cpp/llnctor.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/CS/llnctor.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/VB/llnctor.vb" id="Snippet1"::: - + ]]> @@ -105,20 +105,20 @@ The value to contain in the . Initializes a new instance of the class, containing the specified value. - , , and properties are set to `null`. - - - -## Examples - The following code example creates a , adds it to a , and tracks the values of its properties as the changes. - + , , and properties are set to `null`. + + + +## Examples + The following code example creates a , adds it to a , and tracks the values of its properties as the changes. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/cpp/llnctor.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/CS/llnctor.cs" interactive="try-dotnet" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/VB/llnctor.vb" id="Snippet1"::: - + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/VB/llnctor.vb" id="Snippet1"::: + ]]> @@ -165,15 +165,15 @@ Gets the that the belongs to. A reference to the that the belongs to, or if the is not linked. - , adds it to a , and tracks the values of its properties as the changes. - + , adds it to a , and tracks the values of its properties as the changes. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/cpp/llnctor.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/CS/llnctor.cs" interactive="try-dotnet" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/VB/llnctor.vb" id="Snippet1"::: - + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/VB/llnctor.vb" id="Snippet1"::: + ]]> @@ -214,15 +214,15 @@ Gets the next node in the . A reference to the next node in the , or if the current node is the last element () of the . - , adds it to a , and tracks the values of its properties as the changes. - + , adds it to a , and tracks the values of its properties as the changes. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/cpp/llnctor.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/CS/llnctor.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/VB/llnctor.vb" id="Snippet1"::: - + ]]> @@ -263,15 +263,15 @@ Gets the previous node in the . A reference to the previous node in the , or if the current node is the first element () of the . - , adds it to a , and tracks the values of its properties as the changes. - + , adds it to a , and tracks the values of its properties as the changes. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/cpp/llnctor.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/CS/llnctor.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/VB/llnctor.vb" id="Snippet1"::: - + ]]> @@ -321,20 +321,20 @@ Gets the value contained in the node. The value contained in the node. - . - - - -## Examples - The following code example creates a , adds it to a , and tracks the values of its properties as the changes. - + . + + + +## Examples + The following code example creates a , adds it to a , and tracks the values of its properties as the changes. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/cpp/llnctor.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/CS/llnctor.cs" interactive="try-dotnet" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/VB/llnctor.vb" id="Snippet1"::: - + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Generic.LinkedListNode/VB/llnctor.vb" id="Snippet1"::: + ]]> From f6775a5f4fd932230a7f28455bc473214d5b1d7e Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 23 Sep 2020 21:15:42 +0200 Subject: [PATCH 30/31] Add Sysytem.Net.* missing API (#4904) * System.Net.Http.SocketsHttpHandler.EnableMultipleHttp2Connections * Add Sysytem.Net.\* missing API * Apply PR comments * Apply suggestions from code review * Apply suggestions from code review * Update xml/System.Net.Http/SocketsHttpHandler.xml Co-authored-by: Jan Jahoda Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> --- .../HeaderEncodingSelector`1.xml | 8 +- .../HttpKeepAlivePingPolicy.xml | 6 +- xml/System.Net.Http/MultipartContent.xml | 4 +- xml/System.Net.Http/SocketsHttpHandler.xml | 61 ++++++++--- .../SocketTaskExtensions.xml | 48 ++++---- xml/System.Net.Sockets/TcpClient.xml | 103 +++++++++++++++--- 6 files changed, 162 insertions(+), 68 deletions(-) diff --git a/xml/System.Net.Http/HeaderEncodingSelector`1.xml b/xml/System.Net.Http/HeaderEncodingSelector`1.xml index a4747c1dfaa..bde91e27769 100644 --- a/xml/System.Net.Http/HeaderEncodingSelector`1.xml +++ b/xml/System.Net.Http/HeaderEncodingSelector`1.xml @@ -24,10 +24,10 @@ To be added. - To be added. - To be added. - To be added. - To be added. + The name of the header to specify for the encoding. + The type we are encoding/decoding the headers for. + Represents a method that specifies the encoding to use when interpreting header values. + The encoding to use, or to use the default behavior. To be added. diff --git a/xml/System.Net.Http/HttpKeepAlivePingPolicy.xml b/xml/System.Net.Http/HttpKeepAlivePingPolicy.xml index bbf4c3c4aa4..756ed2291c7 100644 --- a/xml/System.Net.Http/HttpKeepAlivePingPolicy.xml +++ b/xml/System.Net.Http/HttpKeepAlivePingPolicy.xml @@ -13,7 +13,7 @@ System.Enum - To be added. + Specifies when the HTTP/2 ping frame is sent on an idle connection. To be added. @@ -34,7 +34,7 @@ 1 - To be added. + Sends a keep alive ping for the whole lifetime of the connection. @@ -54,7 +54,7 @@ 0 - To be added. + Sends a keep alive ping only when there are active streams on the connection. diff --git a/xml/System.Net.Http/MultipartContent.xml b/xml/System.Net.Http/MultipartContent.xml index 2b29c753104..3f3c7e6f568 100644 --- a/xml/System.Net.Http/MultipartContent.xml +++ b/xml/System.Net.Http/MultipartContent.xml @@ -414,8 +414,8 @@ This operation blocks until all of the content has been written to the memory st System.Net.Http.HeaderEncodingSelector<System.Net.Http.HttpContent> - To be added. - To be added. + Gets or sets a callback that decode response header values. + The header encoding selector callback to decode the value for the specified response header name, or to indicate the default behavior. To be added. diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 83deb87932a..764fed2692b 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -304,8 +304,9 @@ The default proxy is used only when System.Boolean - To be added. - To be added. + Gets or sets a value that indicates whether additional HTTP/2 connections can be established to the same server when the maximum number of concurrent streams is reached on all existing connections. + + if additional HTTP/2 connections are allowed to be created; otherwise, . To be added. @@ -355,8 +356,9 @@ The default proxy is used only when System.Boolean - To be added. - To be added. + Gets a value that indicates whether the handler is supported on the current platform. + + if the handler is supported; otherwise, . To be added. @@ -376,9 +378,18 @@ The default proxy is used only when System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets the keep alive ping delay. + The keep alive ping delay. Defaults to . + + to check whether the connection is broken. + +Delay value must be greater than or equal to 1 second. Set to to disable the keep alive ping. + + ]]> @@ -397,9 +408,16 @@ The default proxy is used only when System.Net.Http.HttpKeepAlivePingPolicy - To be added. - To be added. - To be added. + Gets or sets the keep alive ping behaviour. + The keep alive ping behaviour. + + value. + + ]]> + @@ -418,9 +436,18 @@ The default proxy is used only when System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets the keep alive ping timeout. + The keep alive ping timeout. Defaults to 20 seconds. + + value. The client will close the connection if it doesn't receive any frames within the timeout. + +Timeout must be greater than or equal to 1 second. Set to to disable the keep alive ping timeout. + + ]]> + @@ -671,8 +698,8 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r System.Net.Http.HeaderEncodingSelector<System.Net.Http.HttpRequestMessage> - To be added. - To be added. + Gets or sets a callback that decodes request headers values. + The header encoding selector callback to decode the value for the specified response header name, or to indicate the default behavior. To be added. @@ -721,8 +748,8 @@ Draining occurs when a request is cancelled or a response is disposed prior to f System.Net.Http.HeaderEncodingSelector<System.Net.Http.HttpRequestMessage> - To be added. - To be added. + Gets or sets a callback that decodes response headers values. + The header encoding selector callback to decode the value for the specified response header name, or to indicate the default behavior. To be added. diff --git a/xml/System.Net.Sockets/SocketTaskExtensions.xml b/xml/System.Net.Sockets/SocketTaskExtensions.xml index b718f3e8bfc..e2d5416be8d 100644 --- a/xml/System.Net.Sockets/SocketTaskExtensions.xml +++ b/xml/System.Net.Sockets/SocketTaskExtensions.xml @@ -205,11 +205,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The socket that is used for establishing a connection. + An EndPoint that represents the remote device. + A cancellation token that can be used to signal the asynchronous operation should be canceled. + Establishes a connection to a remote host. + A task that represents the asynchronous connection operation. To be added. @@ -258,7 +258,7 @@ The IP address of the remote host. The port number of the remote host. Establishes a connection to a remote host. The host is specified by an IP address and a port number. - To be added. + A task that represents an asynchronous connection operation. To be added. @@ -385,12 +385,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The socket to perform the connect operation on. + The IP address of the remote host. + The port number of the remote host. + A cancellation token that can be used to signal the asynchronous operation should be canceled. + Establishes a connection to a remote host, which is specified by an IP address and a port number. + A task that represents the asynchronous connection operation. To be added. @@ -419,12 +419,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The socket that the connect operation is performed on. + The IP addresses of the remote host. + The port number of the remote host. + A cancellation token that can be used to signal the asynchronous operation should be canceled. + Establishes a connection to a remote host, which is specified by an array of IP addresses and a port number. + A task that represents the asynchronous connection operation. To be added. @@ -453,12 +453,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The socket to perform the connect operation on. + The name of the remote host. + The port number of the remote host. + A cancellation token that can be used to signal the asynchronous operation should be canceled. + Establishes a connection to a remote host, which is specified by a host name and a port number. + A task that represents an asynchronous connection operation. To be added. diff --git a/xml/System.Net.Sockets/TcpClient.xml b/xml/System.Net.Sockets/TcpClient.xml index 8ea3b6af2f5..913e51e7030 100644 --- a/xml/System.Net.Sockets/TcpClient.xml +++ b/xml/System.Net.Sockets/TcpClient.xml @@ -1296,12 +1296,33 @@ The `Available` property is a way to determine whether data is queued for readin - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The IP address of the remote host. + The port number of the remote host. + A cancellation token that can be used to signal the asynchronous operation should be canceled. + Connects the client to a remote TCP host using the specified IP address and port number as an asynchronous operation. + A task that represents the asynchronous connection operation. + + method to obtain the underlying . Use this `NetworkStream` to send and receive data. + +> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + + ]]> + + The parameter is . + The is not between and . + An error occurred when accessing the socket. + + is closed. + @@ -1328,12 +1349,34 @@ The `Available` property is a way to determine whether data is queued for readin - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The array of IP address of the remote host. + The port number of the remote host. + A cancellation token that can be used to signal the asynchronous operation should be canceled. + Connects the client to a remote TCP host using the specified IP addresses and port number as an asynchronous operation. + A task that represents the asynchronous connection operation. + + method, which can return multiple IP addresses for a single host. Call this method to establish a synchronous remote host connection to the host specified by the array of IP addresses and the port number as an asynchronous operation. After connecting with the remote host, use the method to obtain the underlying . Use this `NetworkStream` to send and receive data. + +> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + + ]]> + + The parameter is . + The port number is not valid. + An error occurred when attempting to access the socket. + The has been closed. + A caller higher in the call stack does not have permission for the requested operation. + This method is valid for sockets that use the flag or the flag. + @@ -1360,12 +1403,36 @@ The `Available` property is a way to determine whether data is queued for readin - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The DNS name of the remote host. + The port number of the remote host. + A cancellation token that can be used to signal the asynchronous operation should be canceled. + Connects the client to the specified TCP port on the specified host as an asynchronous operation. + A task that represents the asynchronous connection operation. + + method to obtain the underlying . Use this `NetworkStream` to send and receive data. + + If IPv6 is enabled and the method is called to connect to a host that resolves to both IPv6 and IPv4 addresses, the connection to the IPv6 address will be attempted first before the IPv4 address. This may have the effect of delaying the time to establish the connection if the host is not listening on the IPv6 address. + +> [!NOTE] +> If you receive a , use to obtain the specific error code. After you have obtained this code, you can refer to the [Windows Sockets version 2 API error code](/windows/desktop/winsock/windows-sockets-error-codes-2) documentation for a detailed description of the error. + +> [!NOTE] +> This member outputs trace information when you enable network tracing in your application. For more information, see [Network Tracing in the .NET Framework](/dotnet/framework/network-programming/network-tracing). + + ]]> + + The parameter is . + The parameter is not between and . + An error occurred when accessing the socket. + + is closed. + + From 1baf681b389fa24825500188ec8cb095627e8cf8 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 23 Sep 2020 21:53:36 +0200 Subject: [PATCH 31/31] Http sync follow up (#4905) * Add the http sync follow up * Fix closing tag Co-authored-by: Jan Jahoda --- xml/System.Net.Http/ByteArrayContent.xml | 18 +-------- xml/System.Net.Http/DelegatingHandler.xml | 3 +- xml/System.Net.Http/HttpClient.xml | 36 ++--------------- xml/System.Net.Http/HttpClientHandler.xml | 9 +---- xml/System.Net.Http/HttpContent.xml | 40 +++---------------- xml/System.Net.Http/HttpMessageHandler.xml | 4 +- xml/System.Net.Http/HttpMessageInvoker.xml | 11 +---- .../MessageProcessingHandler.xml | 9 +---- xml/System.Net.Http/MultipartContent.xml | 11 +---- xml/System.Net.Http/ReadOnlyMemoryContent.xml | 9 +---- xml/System.Net.Http/StreamContent.xml | 35 +++------------- 11 files changed, 25 insertions(+), 160 deletions(-) diff --git a/xml/System.Net.Http/ByteArrayContent.xml b/xml/System.Net.Http/ByteArrayContent.xml index 816dc8a58d6..e5e98ff41b4 100644 --- a/xml/System.Net.Http/ByteArrayContent.xml +++ b/xml/System.Net.Http/ByteArrayContent.xml @@ -159,14 +159,7 @@ The cancellation token to cancel the operation. Creates an HTTP content stream for reading. It uses the memory from the as a backing store. The HTTP content stream. - - - + To be added. @@ -237,14 +230,7 @@ This operation blocks until all of the content stream has been created. Optional information about the transport, like the channel binding token. This parameter can be . The cancellation token to cancel the operation. Serializes and writes the byte array provided in the constructor to an HTTP content stream. - - - + To be added. diff --git a/xml/System.Net.Http/DelegatingHandler.xml b/xml/System.Net.Http/DelegatingHandler.xml index 8b1049bd50f..d32a80c0ab0 100644 --- a/xml/System.Net.Http/DelegatingHandler.xml +++ b/xml/System.Net.Http/DelegatingHandler.xml @@ -228,8 +228,7 @@ method is mainly used by the system and not by applications. When this method is called, it calls the method on the inner handler. diff --git a/xml/System.Net.Http/HttpClient.xml b/xml/System.Net.Http/HttpClient.xml index 38f01b2e321..5cef530bf22 100644 --- a/xml/System.Net.Http/HttpClient.xml +++ b/xml/System.Net.Http/HttpClient.xml @@ -2695,14 +2695,7 @@ The is not an absolute URI. The HTTP request message to send. Sends an HTTP request with the specified request. An HTTP response message. - - - + To be added. The is . The HTTP version is 2.0 or higher or the version policy is set to . @@ -2746,14 +2739,7 @@ The custom does not override One of the enumeration values that specifies when the operation should complete (as soon as a response is available or after reading the response content). Sends an HTTP request. The HTTP response message. - - - + To be added. The is . The HTTP version is 2.0 or higher or the version policy is set to . @@ -2797,14 +2783,7 @@ The custom does not override The token to cancel the operation. Sends an HTTP request with the specified request and cancellation token. The HTTP response message. - - - + To be added. The is . The HTTP version is 2.0 or higher or the version policy is set to . @@ -2854,14 +2833,7 @@ The custom does not override The token to cancel the operation. Sends an HTTP request with the specified request, completion option and cancellation token. The HTTP response message. - - - + To be added. The is . The HTTP version is 2.0 or higher or the version policy is set to . diff --git a/xml/System.Net.Http/HttpClientHandler.xml b/xml/System.Net.Http/HttpClientHandler.xml index 31074d7f171..35cfc456b4a 100644 --- a/xml/System.Net.Http/HttpClientHandler.xml +++ b/xml/System.Net.Http/HttpClientHandler.xml @@ -866,14 +866,7 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA A cancellation token to cancel the operation. Creates an instance of based on the information provided in the . The HTTP response message. - - - + To be added. The was . For HTTP/2 and higher or when requesting version upgrade is enabled by . diff --git a/xml/System.Net.Http/HttpContent.xml b/xml/System.Net.Http/HttpContent.xml index db44e5b6157..c1029b1ddf4 100644 --- a/xml/System.Net.Http/HttpContent.xml +++ b/xml/System.Net.Http/HttpContent.xml @@ -92,14 +92,7 @@ Information about the transport (for example, the channel binding token). This parameter may be . The cancellation token to cancel the operation. Serializes the HTTP content into a stream of bytes and copies it to . - - - + To be added. The was . @@ -747,14 +740,7 @@ This operation blocks until all of the content is written to the stream object. Serializes the HTTP content and returns a stream that represents the content. The stream that represents the HTTP content. - - - + To be added. @@ -782,14 +768,7 @@ This operation blocks until all of the stream that represents content has been r The cancellation token to cancel the operation. Serializes the HTTP content and returns a stream that represents the content. The stream that represents the HTTP content. - - - + To be added. @@ -989,16 +968,9 @@ This operation blocks until all of the stream that represents content has been r The target stream. Information about the transport (for example, the channel binding token). This parameter may be . The cancellation token to cancel the operation. - When overridden in a derived class, serializes the HTTP content to a stream. Otherwise, throws a . - - - - The method is not overridden in the derived class. + When overridden in a derived class, serializes the HTTP content to a stream. Otherwise, throws a . + To be added. + The method is not overridden in the derived class. diff --git a/xml/System.Net.Http/HttpMessageHandler.xml b/xml/System.Net.Http/HttpMessageHandler.xml index 3f9176205a6..264dd6c343e 100644 --- a/xml/System.Net.Http/HttpMessageHandler.xml +++ b/xml/System.Net.Http/HttpMessageHandler.xml @@ -198,10 +198,10 @@ The HTTP request message to send. The cancellation token to cancel operation. - When overridden in a derived class, sends an HTTP request with the specified request and cancellation token. Otherwise, throws a . + When overridden in a derived class, sends an HTTP request with the specified request and cancellation token. Otherwise, throws a . The HTTP response message. To be added. - The method is not overridden in the derived class. + The method is not overridden in the derived class. diff --git a/xml/System.Net.Http/HttpMessageInvoker.xml b/xml/System.Net.Http/HttpMessageInvoker.xml index 92586fbff04..6305d6b907a 100644 --- a/xml/System.Net.Http/HttpMessageInvoker.xml +++ b/xml/System.Net.Http/HttpMessageInvoker.xml @@ -234,16 +234,7 @@ The cancellation token to cancel operation. Sends an HTTP request with the specified request and cancellation token. The HTTP response message. - - or methods on the class. - - ]]> - + To be added. The was . For HTTP/2 and higher or when requesting version upgrade is enabled by . diff --git a/xml/System.Net.Http/MessageProcessingHandler.xml b/xml/System.Net.Http/MessageProcessingHandler.xml index 251fe4ea6fd..2c7717c80c3 100644 --- a/xml/System.Net.Http/MessageProcessingHandler.xml +++ b/xml/System.Net.Http/MessageProcessingHandler.xml @@ -230,14 +230,7 @@ A cancellation token that can be used by other objects or threads to receive notice of cancellation. Sends an HTTP request to the inner handler to send to the server. The HTTP response message. - - - + To be added. diff --git a/xml/System.Net.Http/MultipartContent.xml b/xml/System.Net.Http/MultipartContent.xml index 3f3c7e6f568..b5ceb1df069 100644 --- a/xml/System.Net.Http/MultipartContent.xml +++ b/xml/System.Net.Http/MultipartContent.xml @@ -221,8 +221,6 @@ ## Remarks This method overrides to use a custom stream that contains an array, with each HTTP content entity and its boundary encoded and serialized to a instance. -This operation blocks until all of the content has been written to the memory stream. - ]]> @@ -447,14 +445,7 @@ This operation blocks until all of the content has been written to the memory st Information about the transport (for example, the channel binding token). This parameter may be . The cancellation token to cancel the operation. Serializes the multipart HTTP content to a stream. - - - + To be added. diff --git a/xml/System.Net.Http/ReadOnlyMemoryContent.xml b/xml/System.Net.Http/ReadOnlyMemoryContent.xml index 2f57c60c4b9..8d4d0b0e255 100644 --- a/xml/System.Net.Http/ReadOnlyMemoryContent.xml +++ b/xml/System.Net.Http/ReadOnlyMemoryContent.xml @@ -138,14 +138,7 @@ Information about the transport (for example, the channel binding token). This parameter may be . The cancellation token to cancel the operation. Serializes the multipart HTTP content to a stream. - - - + To be added. diff --git a/xml/System.Net.Http/StreamContent.xml b/xml/System.Net.Http/StreamContent.xml index c49823b033e..aea0bdb2a73 100644 --- a/xml/System.Net.Http/StreamContent.xml +++ b/xml/System.Net.Http/StreamContent.xml @@ -150,18 +150,9 @@ The object calls The cancellation token to cancel the operation. - Writes the HTTP stream content to a memory stream. + Returns the HTTP stream as a read-only stream. The HTTP content stream. - - method buffers the content to a memory stream. Derived classes can override this behavior if there's a better way to retrieve the content as stream. For example, a byte array or a string could use a more efficient mechanism, such as wrapping a read-only around the bytes or string. - - ]]> - + To be added. @@ -192,18 +183,9 @@ This operation blocks until all of the content has been written to the memory st - Write the HTTP stream content to a memory stream as an asynchronous operation. + Returns the HTTP stream as a read-only stream as an asynchronous operation. The task object representing the asynchronous operation. - - object will complete after all of the content has been written to the memory stream. - - The method buffers the content to a memory stream. Derived classes can override this behavior if there is a better way to retrieve the content as stream. For example, a byte array or a string could use a more efficient method way such as wrapping a read-only around the bytes or string.) - - ]]> - + To be added. @@ -277,14 +259,7 @@ This operation blocks until all of the content has been written to the memory st Information about the transport (for example, the channel binding token). This parameter may be . The cancellation token to cancel the operation. Serializes the multipart HTTP content to a stream. - - - + To be added.