From bed8a7abc51e44c80df987b4e9c74aba7b803405 Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Tue, 19 Nov 2024 01:34:20 +0000 Subject: [PATCH] CI Update Build.Reason:Manual by Genevieve Warren Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=478325&view=results source_repo.branch:inheritdoc-test source_repo.url:https://apidrop.visualstudio.com/_git/binaries --- .../HybridCache.xml | 2 +- .../ServiceCollectionDescriptorExtensions.xml | 2 +- .../OptionsServiceCollectionExtensions.xml | 14 +- .../ServiceProviderOptions.xml | 2 +- .../MetricsBuilderExtensions.xml | 2 +- .../PhysicalFileProvider.xml | 4 +- xml/Microsoft.Extensions.Hosting/IHost.xml | 4 +- .../OptionsBuilder`1.xml | 24 +- xml/System.Buffers.Text/Base64Url.xml | 264 +-- xml/System.Formats.Asn1/AsnDecoder.xml | 20 +- xml/System.Formats.Asn1/AsnReader.xml | 1760 ++++++++--------- xml/System.Formats.Asn1/AsnWriter.xml | 12 +- xml/System.Formats.Tar/GnuTarEntry.xml | 2 +- xml/System.Numerics.Tensors/Tensor.xml | 20 +- .../TensorPrimitives.xml | 24 +- xml/System.Reflection/TypeExtensions.xml | 408 ++-- xml/System/Index.xml | 84 +- xml/System/Range.xml | 64 +- 18 files changed, 1364 insertions(+), 1348 deletions(-) diff --git a/xml/Microsoft.Extensions.Caching.Hybrid/HybridCache.xml b/xml/Microsoft.Extensions.Caching.Hybrid/HybridCache.xml index 63217235a39..30db322202d 100644 --- a/xml/Microsoft.Extensions.Caching.Hybrid/HybridCache.xml +++ b/xml/Microsoft.Extensions.Caching.Hybrid/HybridCache.xml @@ -180,8 +180,8 @@ The type of additional state required by . The type of the data being considered. The key of the entry to look for or create. - The state required for . Provides the underlying data service if the data is not available in the cache. + The state required for . Additional options for this cache entry. The tags to associate with this cache item. The used to propagate notifications that the operation should be canceled. diff --git a/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml b/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml index 2882d2b1ab6..4d711e4d7ca 100644 --- a/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml +++ b/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml @@ -648,8 +648,8 @@ The type of the service to add. The . - The service key. The factory that creates the service. + The service key. Adds the specified as a service using the factory specified in diff --git a/xml/Microsoft.Extensions.DependencyInjection/OptionsServiceCollectionExtensions.xml b/xml/Microsoft.Extensions.DependencyInjection/OptionsServiceCollectionExtensions.xml index ec81c75c1cb..9a141add20d 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/OptionsServiceCollectionExtensions.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/OptionsServiceCollectionExtensions.xml @@ -190,7 +190,7 @@ The so that configure calls can be chained in it. - The extension is called by this method. + The extension is called by this method. @@ -254,7 +254,7 @@ The so that configure calls can be chained in it. - The extension is called by this method. + The extension is called by this method. @@ -290,7 +290,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The so that additional calls can be chained. To be added. @@ -337,7 +337,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The so that additional calls can be chained. To be added. @@ -524,7 +524,7 @@ The action used to configure the options. Registers an action used to initialize a particular type of options. - Note: These are run after all . + Note: These are run after all . The so that additional calls can be chained. To be added. @@ -571,7 +571,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The so that additional calls can be chained. To be added. @@ -609,7 +609,7 @@ The action used to configure the options. Registers an action used to post configure all instances of a particular type of options. - Note: These are run after all . + Note: These are run after all . The so that additional calls can be chained. To be added. diff --git a/xml/Microsoft.Extensions.DependencyInjection/ServiceProviderOptions.xml b/xml/Microsoft.Extensions.DependencyInjection/ServiceProviderOptions.xml index cbf1d87a455..1564021b7d8 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/ServiceProviderOptions.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/ServiceProviderOptions.xml @@ -63,7 +63,7 @@ - Gets or sets a value that indicates whether validation is performed to ensure all services can be created when is called. + Gets or sets a value that indicates whether validation is performed to ensure all services can be created when is called. if validation is performed to ensure all services can be created during a call; otherwise, . The default is the value of . diff --git a/xml/Microsoft.Extensions.Diagnostics.Metrics/MetricsBuilderExtensions.xml b/xml/Microsoft.Extensions.Diagnostics.Metrics/MetricsBuilderExtensions.xml index 7fc299e44bf..64e6cb11250 100644 --- a/xml/Microsoft.Extensions.Diagnostics.Metrics/MetricsBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.Diagnostics.Metrics/MetricsBuilderExtensions.xml @@ -47,8 +47,8 @@ - The . The implementation type of the listener. + The . Registers a new instance. diff --git a/xml/Microsoft.Extensions.FileProviders/PhysicalFileProvider.xml b/xml/Microsoft.Extensions.FileProviders/PhysicalFileProvider.xml index d5087fc6992..767b6683147 100644 --- a/xml/Microsoft.Extensions.FileProviders/PhysicalFileProvider.xml +++ b/xml/Microsoft.Extensions.FileProviders/PhysicalFileProvider.xml @@ -330,13 +330,13 @@ Creates a for the specified . - Globbing patterns are interpreted by . + Globbing patterns are interpreted by . An that is notified when a file matching is added, modified, or deleted. Returns a if has invalid filter characters or if is an absolute path or outside the root directory specified in the - constructor . + constructor . To be added. diff --git a/xml/Microsoft.Extensions.Hosting/IHost.xml b/xml/Microsoft.Extensions.Hosting/IHost.xml index 16cfb3eae9d..46f06128230 100644 --- a/xml/Microsoft.Extensions.Hosting/IHost.xml +++ b/xml/Microsoft.Extensions.Hosting/IHost.xml @@ -46,7 +46,7 @@ - Gets the services configured for the program (for example, using ). + Gets the services configured for the program (for example, using ). To be added. To be added. @@ -73,7 +73,7 @@ Used to abort program start. Starts the objects configured for the program. - The application will run until interrupted or until is called. + The application will run until interrupted or until is called. A that will be completed when the starts. To be added. diff --git a/xml/Microsoft.Extensions.Options/OptionsBuilder`1.xml b/xml/Microsoft.Extensions.Options/OptionsBuilder`1.xml index 8374e4c133d..7da5c4537b5 100644 --- a/xml/Microsoft.Extensions.Options/OptionsBuilder`1.xml +++ b/xml/Microsoft.Extensions.Options/OptionsBuilder`1.xml @@ -96,7 +96,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -132,7 +132,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -174,7 +174,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -222,7 +222,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -276,7 +276,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -336,7 +336,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -387,7 +387,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. @@ -423,7 +423,7 @@ The action used to configure the options. Registers an action used to post configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. @@ -465,7 +465,7 @@ The action used to configure the options. Registers an action used to post configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. @@ -513,7 +513,7 @@ The action used to configure the options. Registers an action used to post configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. @@ -567,7 +567,7 @@ The action used to configure the options. Registers an action used to post configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. @@ -627,7 +627,7 @@ The action used to configure the options. Registers an action used to post configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. diff --git a/xml/System.Buffers.Text/Base64Url.xml b/xml/System.Buffers.Text/Base64Url.xml index cb17c1fdf9c..6ae09b14726 100644 --- a/xml/System.Buffers.Text/Base64Url.xml +++ b/xml/System.Buffers.Text/Base64Url.xml @@ -52,14 +52,14 @@ The input span which contains ASCII chars in Base64Url that needs to be decoded. - Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + + Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + A byte array which contains the result of the decoding operation. To be added. - - contains a invalid Base64Url character, - more than two padding characters, or a non white space character among the padding characters. - + contains a invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. @@ -88,15 +88,15 @@ The input span which contains ASCII chars in Base64Url that needs to be decoded. The output span which contains the result of the operation, i.e. the decoded binary data. - Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + + Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + The number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. To be added. The buffer in is too small to hold the encoded output. - - contains a invalid Base64Url character, - more than two padding characters, or a non white space character among the padding characters. - + contains a invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. @@ -130,19 +130,19 @@ When this method returns, contains the number of input chars consumed during the operation. This can be used to slice the input for subsequent calls, if necessary. This parameter is treated as uninitialized. When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. - - when the input span contains the entirety of data to encode; when more data may follow, - such as when calling in a loop. Calls with should be followed up with another call where this parameter is call. The default is . - - Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + when the input span contains the entirety of data to encode; when more data may follow, + such as when calling in a loop. Calls with should be followed up with another call where this parameter is call. The default is . + + Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + One of the enumeration values that indicates the success or failure of the operation. - As padding is optional for Base64Url the length not required to be a multiple of 4 even if is . - If the length is not a multiple of 4 and is the remainders decoded accordingly: - - Remainder of 3 chars - decoded into 2 bytes data, decoding succeeds. - - Remainder of 2 chars - decoded into 1 byte data. decoding succeeds. - - Remainder of 1 char - will cause OperationStatus.InvalidData result. - + As padding is optional for Base64Url the length not required to be a multiple of 4 even if is . + If the length is not a multiple of 4 and is the remainders decoded accordingly: + - Remainder of 3 chars - decoded into 2 bytes data, decoding succeeds. + - Remainder of 2 chars - decoded into 1 byte data. decoding succeeds. + - Remainder of 1 char - will cause OperationStatus.InvalidData result. + @@ -175,14 +175,14 @@ The input span which contains UTF-8 encoded text in Base64Url that needs to be decoded. - Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + + Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + >A byte array which contains the result of the decoding operation. To be added. - - contains an invalid Base64Url character, - more than two padding characters, or a non white space character among the padding characters. - + contains an invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. @@ -211,21 +211,21 @@ The input span which contains UTF-8 encoded text in Base64Url that needs to be decoded. The output span which contains the result of the operation, i.e. the decoded binary data. - Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + + Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + The number of bytes written into . This can be used to slice the output for subsequent calls, if necessary. - As padding is optional for Base64Url the length not required to be a multiple of 4. - If the length is not a multiple of 4 the remainders decoded accordingly: - - Remainder of 3 bytes - decoded into 2 bytes data, decoding succeeds. - - Remainder of 2 bytes - decoded into 1 byte data. decoding succeeds. - - Remainder of 1 byte - is invalid input, causes FormatException. - + As padding is optional for Base64Url the length not required to be a multiple of 4. + If the length is not a multiple of 4 the remainders decoded accordingly: + - Remainder of 3 bytes - decoded into 2 bytes data, decoding succeeds. + - Remainder of 2 bytes - decoded into 1 byte data. decoding succeeds. + - Remainder of 1 byte - is invalid input, causes FormatException. + The buffer in is too small to hold the encoded output. - - contains an invalid Base64Url character, - more than two padding characters, or a non white space character among the padding characters. - + contains an invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. @@ -259,19 +259,19 @@ When this method returns, contains the number of input bytes consumed during the operation. This can be used to slice the input for subsequent calls, if necessary. This parameter is treated as uninitialized. When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. - - when the input span contains the entirety of data to encode; when more data may follow, - such as when calling in a loop. Calls with should be followed up with another call where this parameter is call. The default is . - - Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + when the input span contains the entirety of data to encode; when more data may follow, + such as when calling in a loop. Calls with should be followed up with another call where this parameter is call. The default is . + + Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + One of the enumeration values that indicates the success or failure of the operation. - As padding is optional for Base64Url the length not required to be a multiple of 4 even if is . - If the length is not a multiple of 4 and is the remainders decoded accordingly: - - Remainder of 3 bytes - decoded into 2 bytes data, decoding succeeds. - - Remainder of 2 bytes - decoded into 1 byte data. decoding succeeds. - - Remainder of 1 byte - will cause OperationStatus.InvalidData result. - + As padding is optional for Base64Url the length not required to be a multiple of 4 even if is . + If the length is not a multiple of 4 and is the remainders decoded accordingly: + - Remainder of 3 bytes - decoded into 2 bytes data, decoding succeeds. + - Remainder of 2 bytes - decoded into 1 byte data. decoding succeeds. + - Remainder of 1 byte - will cause OperationStatus.InvalidData result. + @@ -299,22 +299,20 @@ The input span which contains the base 64 text data that needs to be decoded. - Decodes the span of UTF-8 encoded text in Base64Url into binary data, in-place. - The decoded binary output is smaller than the text data contained in the input (the operation deflates the data). - + Decodes the span of UTF-8 encoded text in Base64Url into binary data, in-place. + The decoded binary output is smaller than the text data contained in the input (the operation deflates the data). + The number of bytes written into . This can be used to slice the output for subsequent calls, if necessary. - As padding is optional for Base64Url the length not required to be a multiple of 4. - If the length is not a multiple of 4 the remainders decoded accordingly: - - Remainder of 3 bytes - decoded into 2 bytes data, decoding succeeds. - - Remainder of 2 bytes - decoded into 1 byte data. decoding succeeds. - - Remainder of 1 byte - is invalid input, causes FormatException. - + As padding is optional for Base64Url the length not required to be a multiple of 4. + If the length is not a multiple of 4 the remainders decoded accordingly: + - Remainder of 3 bytes - decoded into 2 bytes data, decoding succeeds. + - Remainder of 2 bytes - decoded into 1 byte data. decoding succeeds. + - Remainder of 1 byte - is invalid input, causes FormatException. + - - contains an invalid Base64Url character, - more than two padding characters, or a non white space character among the padding characters. - + contains an invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. @@ -347,7 +345,9 @@ The input span which contains binary data that needs to be encoded. - Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + + Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + A char array which contains the result of the operation, i.e. the ASCII chars in Base64Url. This implementation of the base64url encoding omits the optional padding characters. @@ -378,7 +378,9 @@ The input span which contains binary data that needs to be encoded. The output span which contains the result of the operation, i.e. the ASCII chars in Base64Url. - Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + + Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + The number of bytes written into the destination span. This can be used to slice the output for subsequent calls, if necessary. This implementation of the base64url encoding omits the optional padding characters. The buffer in is too small to hold the encoded output. @@ -415,11 +417,11 @@ >When this method returns, contains the number of input bytes consumed during the operation. This can be used to slice the input for subsequent calls, if necessary. This parameter is treated as uninitialized. >When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. - - when the input span contains the entirety of data to encode; when more data may follow, - such as when calling in a loop, subsequent calls with should end with call. The default is . - - Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + when the input span contains the entirety of data to encode; when more data may follow, + such as when calling in a loop, subsequent calls with should end with call. The default is . + + Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + One of the enumeration values that indicates the success or failure of the operation. This implementation of the base64url encoding omits the optional padding characters. @@ -454,7 +456,9 @@ The input span which contains binary data that needs to be encoded. - Encodes the span of binary data into unicode string represented as Base64Url ASCII chars. + + Encodes the span of binary data into unicode string represented as Base64Url ASCII chars. + A string which contains the result of the operation, i.e. the ASCII string in Base64Url. This implementation of the base64url encoding omits the optional padding characters. @@ -489,7 +493,9 @@ The input span which contains binary data that needs to be encoded. - Encodes the span of binary data into UTF-8 encoded text represented as Base64Url. + + Encodes the span of binary data into UTF-8 encoded text represented as Base64Url. + The output byte array which contains the result of the operation, i.e. the UTF-8 encoded text in Base64Url. This implementation of the base64url encoding omits the optional padding characters. @@ -520,7 +526,9 @@ The input span which contains binary data that needs to be encoded. The output span which contains the result of the operation, i.e. the UTF-8 encoded text in Base64Url. - Encodes the span of binary data into UTF-8 encoded text represented as Base64Url. + + Encodes the span of binary data into UTF-8 encoded text represented as Base64Url. + The number of bytes written into the destination span. This can be used to slice the output for subsequent calls, if necessary. This implementation of the base64url encoding omits the optional padding characters. The buffer in is too small to hold the encoded output. @@ -557,11 +565,11 @@ When this method returns, contains the number of input bytes consumed during the operation. This can be used to slice the input for subsequent calls, if necessary. This parameter is treated as uninitialized. When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. - - when the input span contains the entirety of data to encode; when more data may follow, - such as when calling in a loop, subsequent calls with should end with call. The default is . - - Encodes the span of binary data into UTF-8 encoded text represented as Base64Url. + when the input span contains the entirety of data to encode; when more data may follow, + such as when calling in a loop, subsequent calls with should end with call. The default is . + + Encodes the span of binary data into UTF-8 encoded text represented as Base64Url. + One of the enumeration values that indicates the success or failure of the operation. This implementation of the base64url encoding omits the optional padding characters. @@ -590,11 +598,14 @@ The size of the input span. - Returns the length (in bytes) of the result if you were to encode binary data within a byte span of size . + + Returns the length (in bytes) of the result if you were to encode binary data within a byte span of size . + The length (in bytes) of the encoded result. To be added. - is less than 0 or greater than 1610612733. + is less than 0 or greater than 1610612733. + @@ -621,10 +632,13 @@ The size of the input span. - Returns the maximum length (in bytes) of the result if you were to decode base 64 encoded text from a span of size . + + Returns the maximum length (in bytes) of the result if you were to decode base 64 encoded text from a span of size . + The maximum length (in bytes) of the decoded result. To be added. - The specified is less than 0. + The specified is less than 0. + @@ -654,7 +668,9 @@ Validates that the specified span of UTF-8 text is comprised of valid base-64 encoded data. if contains a valid, decodable sequence of base-64 encoded data; otherwise, . - where whitespace is defined as the characters ' ', '\t', '\r', or '\n' (as bytes). + + where whitespace is defined as the characters ' ', '\t', '\r', or '\n' (as bytes). + @@ -685,12 +701,11 @@ if contains a valid, decodable sequence of base-64 encoded data; otherwise, . - If the method returns , the same text passed to and - - would successfully decode (in the case - of assuming sufficient output space). - Any amount of whitespace is allowed anywhere in the input, where whitespace is defined as the characters ' ', '\t', '\r', or '\n'. - + If the method returns , the same text passed to and + would successfully decode (in the case + of assuming sufficient output space). + Any amount of whitespace is allowed anywhere in the input, where whitespace is defined as the characters ' ', '\t', '\r', or '\n'. + @@ -718,11 +733,13 @@ A span of UTF-8 text to validate. - If the method returns , the number of decoded bytes that will result from decoding the input UTF-8 text. + If the method returns true, the number of decoded bytes that will result from decoding the input UTF-8 text. Validates that the specified span of UTF-8 text is comprised of valid base-64 encoded data. if contains a valid, decodable sequence of base-64 encoded data; otherwise, . - where whitespace is defined as the characters ' ', '\t', '\r', or '\n' (as bytes). + + where whitespace is defined as the characters ' ', '\t', '\r', or '\n' (as bytes). + @@ -750,17 +767,16 @@ A span of text to validate. - If the method returns , the number of decoded bytes that will result from decoding the input text. + If the method returns true, the number of decoded bytes that will result from decoding the input text. Validates that the specified span of text is comprised of valid base-64 encoded data. if contains a valid, decodable sequence of base-64 encoded data; otherwise, . - If the method returns , the same text passed to and - - would successfully decode (in the case - of assuming sufficient output space). - Any amount of whitespace is allowed anywhere in the input, where whitespace is defined as the characters ' ', '\t', '\r', or '\n'. - + If the method returns , the same text passed to and + would successfully decode (in the case + of assuming sufficient output space). + Any amount of whitespace is allowed anywhere in the input, where whitespace is defined as the characters ' ', '\t', '\r', or '\n'. + @@ -791,15 +807,15 @@ The input span which contains ASCII chars in Base64Url that needs to be decoded. The output span which contains the result of the operation, i.e. the decoded binary data. When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. - Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + + Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + - if bytes decoded successfully; if is too small. + if bytes decoded successfully, otherwise . To be added. - - contains an invalid Base64Url character, - more than two padding characters, or a non white space character among the padding characters. - + contains an invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. @@ -830,15 +846,15 @@ The input span which contains UTF-8 encoded text in Base64Url that needs to be decoded. The output span which contains the result of the operation, i.e. the decoded binary data. When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. - Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + + Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + - if bytes decoded successfully; if is too small. + if bytes decoded successfully, otherwise . To be added. - - contains an invalid Base64Url character, - more than two padding characters, or a non white space character among the padding characters. - + contains an invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. @@ -869,9 +885,11 @@ The input span which contains binary data that needs to be encoded. The output span which contains the result of the operation, i.e. the ASCII chars in Base64Url. When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. - Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + + Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + - if chars encoded successfully; if is too small. + if chars encoded successfully, otherwise . This implementation of the base64url encoding omits the optional padding characters. @@ -903,9 +921,11 @@ The input span which contains binary data that needs to be encoded. The output span which contains the result of the operation, i.e. the UTF-8 encoded text in Base64Url. When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. - Encodes the span of binary data into UTF-8 encoded chars represented as Base64Url. + + Encodes the span of binary data into UTF-8 encoded chars represented as Base64Url. + - if bytes encoded successfully; if is too small. + if bytes encoded successfully, otherwise . This implementation of the base64url encoding omits the optional padding characters. @@ -934,21 +954,17 @@ - - The input span which contains binary data that needs to be encoded. - It needs to be large enough to fit the result of the operation. - - - The amount of binary data contained within the buffer that needs to be encoded - (and needs to be smaller than the buffer length). - + The input span which contains binary data that needs to be encoded. + It needs to be large enough to fit the result of the operation. + The amount of binary data contained within the buffer that needs to be encoded + (and needs to be smaller than the buffer length). When this method returns, contains the number of bytes written into the buffer. This parameter is treated as uninitialized. - Encodes the span of binary data (in-place) into UTF-8 encoded text represented as base 64. - The encoded text output is larger than the binary data contained in the input (the operation inflates the data). - + Encodes the span of binary data (in-place) into UTF-8 encoded text represented as base 64. + The encoded text output is larger than the binary data contained in the input (the operation inflates the data). + - if bytes encoded successfully; if is too small. + if bytes encoded successfully, otherwise . This implementation of the base64url encoding omits the optional padding characters. diff --git a/xml/System.Formats.Asn1/AsnDecoder.xml b/xml/System.Formats.Asn1/AsnDecoder.xml index 9fefd06a97a..48aebeae172 100644 --- a/xml/System.Formats.Asn1/AsnDecoder.xml +++ b/xml/System.Formats.Asn1/AsnDecoder.xml @@ -124,7 +124,7 @@ value will be copied into the return value as unset bits, irrespective of their value in the encoded representation. - + is not defined. @@ -145,7 +145,7 @@ . is not correct for the method. - + @@ -1248,7 +1248,7 @@ An array containing the contents of the Octet String value. To be added. - + is not defined. @@ -1269,7 +1269,7 @@ . is not correct for the method. - + @@ -1616,7 +1616,7 @@ value will be copied into as unset bits, irrespective of their value in the encoded representation. - + is not defined. @@ -1641,7 +1641,7 @@ overlaps . - + @@ -1700,7 +1700,7 @@ and the reader does not advance. To be added. - + is not defined. @@ -1729,7 +1729,7 @@ . is not the same as . - + @@ -2079,7 +2079,7 @@ otherwise, . To be added. - + is not defined. @@ -2104,7 +2104,7 @@ overlaps . - + diff --git a/xml/System.Formats.Asn1/AsnReader.xml b/xml/System.Formats.Asn1/AsnReader.xml index bcf885da0c7..996d6a87bb2 100644 --- a/xml/System.Formats.Asn1/AsnReader.xml +++ b/xml/System.Formats.Asn1/AsnReader.xml @@ -18,8 +18,8 @@ - - A stateful, forward-only reader for BER-, CER-, or DER-encoded ASN.1 data. + + A stateful, forward-only reader for BER-, CER-, or DER-encoded ASN.1 data. To be added. @@ -48,18 +48,18 @@ The data to read. The encoding constraints for the reader. Additional options for the reader. - - Construct an over with a given ruleset. + + Construct an over with a given ruleset. - - This constructor does not evaluate for correctness. - Any correctness checks are done as part of member methods. - - This constructor does not copy . The caller is responsible for - ensuring that the values do not change until the reader is finished. + + This constructor does not evaluate for correctness. + Any correctness checks are done as part of member methods. + + This constructor does not copy . The caller is responsible for + ensuring that the values do not change until the reader is finished. - is not defined. + is not defined. @@ -81,12 +81,12 @@ - - Clones the current reader. + + Clones the current reader. A clone of the current reader. - - This does not create a clone of the ASN.1 data, only the reader's state is cloned. + + This does not create a clone of the ASN.1 data, only the reader's state is cloned. @@ -110,12 +110,12 @@ System.Boolean - - Gets an indication of whether the reader has remaining data available to process. + + Gets an indication of whether the reader has remaining data available to process. - if there is more data available for the reader to process; - otherwise, . + if there is more data available for the reader to process; + otherwise, . To be added. @@ -141,17 +141,17 @@ - - Get a view of the content octets (bytes) of the - next encoded value without advancing the reader. + + Get a view of the content octets (bytes) of the + next encoded value without advancing the reader. - - The bytes of the contents octets of the next encoded value. + + The bytes of the contents octets of the next encoded value. To be added. - - The reader is positioned at a point where the tag or length is invalid - under the current encoding rules. + + The reader is positioned at a point where the tag or length is invalid + under the current encoding rules. @@ -177,21 +177,21 @@ - - Get a view of the next encoded value without - advancing the reader. For indefinite length encodings this includes the - End of Contents marker. + + Get a view of the next encoded value without + advancing the reader. For indefinite length encodings this includes the + End of Contents marker. - - The bytes of the next encoded value. + + The bytes of the next encoded value. To be added. - - - The reader is positioned at a point where the tag or length is invalid - under the current encoding rules. - + + The reader is positioned at a point where the tag or length is invalid + under the current encoding rules. + + @@ -215,15 +215,15 @@ - - Read the encoded tag at the next data position, without advancing the reader. + + Read the encoded tag at the next data position, without advancing the reader. - - The decoded tag value. + + The decoded tag value. To be added. - - a tag could not be decoded at the reader's current position. + + a tag could not be decoded at the reader's current position. @@ -250,40 +250,40 @@ - - On success, receives the number of bits in the last byte which were reported as - "unused" by the writer. + + On success, receives the number of bits in the last byte which were reported as + "unused" by the writer. - - The tag to check for before reading, or for the default tag (Universal 1). + + The tag to check for before reading, or for the default tag (Universal 1). - - Reads the next value as a BIT STRING with a specified tag, returning the value - in a byte array. + + Reads the next value as a BIT STRING with a specified tag, returning the value + in a byte array. - - A copy of the value in a newly allocated, precisely sized, array. + + A copy of the value in a newly allocated, precisely sized, array. To be added. - - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. - + @@ -308,32 +308,32 @@ - - The tag to check for before reading, or for the default tag (Universal 1). + + The tag to check for before reading, or for the default tag (Universal 1). - - Reads the next value as a Boolean with a specified tag. + + Reads the next value as a Boolean with a specified tag. - - The decoded value. + + The decoded value. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -360,46 +360,46 @@ - - One of the enumeration values representing the value type to process. + + One of the enumeration values representing the value type to process. - - The tag to check for before reading, or for the universal tag that is - appropriate to the requested encoding type. + + The tag to check for before reading, or for the universal tag that is + appropriate to the requested encoding type. - - Reads the next value as character string with the specified tag and - encoding type, returning the decoded value as a string. + + Reads the next value as character string with the specified tag and + encoding type, returning the decoded value as a string. - - The decoded value. + + The decoded value. To be added. - is not a known character string type. - - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. - - -or- - - The string did not successfully decode. + is not a known character string type. + + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. + + -or- + + The string did not successfully decode. - . is - , but - . is not the same as - . + . is + , but + . is not the same as + . @@ -425,13 +425,13 @@ - - Get a view of the next encoded value, - and advance the reader past it. For an indefinite length encoding this includes - the End of Contents marker. + + Get a view of the next encoded value, + and advance the reader past it. For an indefinite length encoding this includes + the End of Contents marker. - - A view of the next encoded value. + + A view of the next encoded value. To be added. @@ -459,33 +459,33 @@ - - The tag to check for before reading, or for the default tag (Universal 10). + + The tag to check for before reading, or for the default tag (Universal 10). - - Reads the next value as a Enumerated with a specified tag, returning the contents - as a over the original data. + + Reads the next value as a Enumerated with a specified tag, returning the contents + as a over the original data. - - The bytes of the Enumerated value, in signed big-endian form. + + The bytes of the Enumerated value, in signed big-endian form. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -514,51 +514,51 @@ Type object representing the destination type. - - The tag to check for before reading, or for the default tag (Universal 10). + + The tag to check for before reading, or for the default tag (Universal 10). - - Reads the next value as an Enumerated with a specified tag, converting it to the - non-[] enum specified by . + + Reads the next value as an Enumerated with a specified tag, converting it to the + non-[] enum specified by . - - The Enumerated value converted to a . + + The Enumerated value converted to a . - - This method does not validate that the return value is defined within - . + + This method does not validate that the return value is defined within + . - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. - - -or- - - The encoded value is too big to fit in a value. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. + + -or- + + The encoded value is too big to fit in a value. - is not an enum type. - - -or- - - was declared with . - - -or- - - . is - , but - . is not correct for - the method. + is not an enum type. + + -or- + + was declared with . + + -or- + + . is + , but + . is not correct for + the method. - is . + is . @@ -598,48 +598,48 @@ The destination enum type. - - The tag to check for before reading, or for the default tag (Universal 10). + + The tag to check for before reading, or for the default tag (Universal 10). - - Reads the next value as an Enumerated with a specified tag, converting it to the - non-[] enum specified by . + + Reads the next value as an Enumerated with a specified tag, converting it to the + non-[] enum specified by . - - The Enumerated value converted to a . + + The Enumerated value converted to a . - - This method does not validate that the return value is defined within - . + + This method does not validate that the return value is defined within + . - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. - - -or- - - The encoded value is too big to fit in a value. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. + + -or- + + The encoded value is too big to fit in a value. - is not an enum type. - - -or- - - was declared with . - - -or- - - . is - , but - . is not correct for - the method. + is not an enum type. + + -or- + + was declared with . + + -or- + + . is + , but + . is not correct for + the method. @@ -665,32 +665,32 @@ - - The tag to check for before reading, or for the default tag (Universal 24). + + The tag to check for before reading, or for the default tag (Universal 24). - - Reads the next value as a GeneralizedTime with a specified tag. + + Reads the next value as a GeneralizedTime with a specified tag. - - The decoded value. + + The decoded value. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -716,32 +716,32 @@ - - The tag to check for before reading, or for the default tag (Universal 2). + + The tag to check for before reading, or for the default tag (Universal 2). - - Reads the next value as an Integer with a specified tag. + + Reads the next value as an Integer with a specified tag. - - The decoded value. + + The decoded value. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -767,33 +767,33 @@ - - The tag to check for before reading, or for the default tag (Universal 2). + + The tag to check for before reading, or for the default tag (Universal 2). - - Reads the next value as a Integer with a specified tag, returning the contents - as a over the original data. + + Reads the next value as a Integer with a specified tag, returning the contents + as a over the original data. - - The bytes of the Integer value, in signed big-endian form. + + The bytes of the Integer value, in signed big-endian form. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -820,29 +820,29 @@ The tag to check for before reading. - - Reads the next value as a NamedBitList with a specified tag. + + Reads the next value as a NamedBitList with a specified tag. - - The bits from the encoded value. + + The bits from the encoded value. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -872,42 +872,42 @@ Type object representing the destination type. The tag to check for before reading. - - Reads the next value as a NamedBitList with a specified tag, converting it to the - [] enum specified by . + + Reads the next value as a NamedBitList with a specified tag, converting it to the + [] enum specified by . - - The NamedBitList value converted to a . + + The NamedBitList value converted to a . To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. - - -or- - - The encoded value is too big to fit in a value. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. + + -or- + + The encoded value is too big to fit in a value. - is not an enum type. - - -or- - - was not declared with - - -or- - - . is - , but - . is not correct for - the method. + is not an enum type. + + -or- + + was not declared with + + -or- + + . is + , but + . is not correct for + the method. is @@ -951,81 +951,81 @@ The destination enum type. The tag to check for before reading. - - Reads the next value as a NamedBitList with a specified tag, converting it to the - [] enum specified by . + + Reads the next value as a NamedBitList with a specified tag, converting it to the + [] enum specified by . - - The NamedBitList value converted to a . + + The NamedBitList value converted to a . - - The bit alignment performed by this method is to interpret the most significant bit - in the first byte of the value as the least significant bit in , - with bits increasing in value until the least significant bit of the first byte, proceeding - with the most significant bit of the second byte, and so on. Under this scheme, the following - ASN.1 type declaration and C# enumeration can be used together: - - - KeyUsage ::= BIT STRING { - digitalSignature (0), - nonRepudiation (1), - keyEncipherment (2), - dataEncipherment (3), - keyAgreement (4), - keyCertSign (5), - cRLSign (6), - encipherOnly (7), - decipherOnly (8) } - - [Flags] - enum KeyUsage - { - None = 0, - DigitalSignature = 1 << (0), - NonRepudiation = 1 << (1), - KeyEncipherment = 1 << (2), - DataEncipherment = 1 << (3), - KeyAgreement = 1 << (4), - KeyCertSign = 1 << (5), - CrlSign = 1 << (6), - EncipherOnly = 1 << (7), - DecipherOnly = 1 << (8), - } - - - While the example here uses the KeyUsage NamedBitList from - RFC 3280 (4.2.1.3), - the example enum uses values that are different from - System.Security.Cryptography.X509Certificates.X509KeyUsageFlags. + + The bit alignment performed by this method is to interpret the most significant bit + in the first byte of the value as the least significant bit in , + with bits increasing in value until the least significant bit of the first byte, proceeding + with the most significant bit of the second byte, and so on. Under this scheme, the following + ASN.1 type declaration and C# enumeration can be used together: + + + KeyUsage ::= BIT STRING { + digitalSignature (0), + nonRepudiation (1), + keyEncipherment (2), + dataEncipherment (3), + keyAgreement (4), + keyCertSign (5), + cRLSign (6), + encipherOnly (7), + decipherOnly (8) } + + [Flags] + enum KeyUsage + { + None = 0, + DigitalSignature = 1 << (0), + NonRepudiation = 1 << (1), + KeyEncipherment = 1 << (2), + DataEncipherment = 1 << (3), + KeyAgreement = 1 << (4), + KeyCertSign = 1 << (5), + CrlSign = 1 << (6), + EncipherOnly = 1 << (7), + DecipherOnly = 1 << (8), + } + + + While the example here uses the KeyUsage NamedBitList from + RFC 3280 (4.2.1.3), + the example enum uses values that are different from + System.Security.Cryptography.X509Certificates.X509KeyUsageFlags. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. - - -or- - - The encoded value is too big to fit in a value. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. + + -or- + + The encoded value is too big to fit in a value. - is not an enum type. - - -or- - - was not declared with - - -or- - - . is - , but - . is not correct for - the method. + is not an enum type. + + -or- + + was not declared with + + -or- + + . is + , but + . is not correct for + the method. @@ -1051,29 +1051,29 @@ - - The tag to check for before reading, or for the default tag (Universal 5). + + The tag to check for before reading, or for the default tag (Universal 5). - - Reads the next value as a NULL with a specified tag. + + Reads the next value as a NULL with a specified tag. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -1099,31 +1099,31 @@ - - The tag to check for before reading, or for the default tag (Universal 6). + + The tag to check for before reading, or for the default tag (Universal 6). - - Reads the next value as an OBJECT IDENTIFIER with a specified tag, returning - the value in a dotted decimal format string. + + Reads the next value as an OBJECT IDENTIFIER with a specified tag, returning + the value in a dotted decimal format string. The decoded object identifier in the dotted-decimal notation. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -1149,36 +1149,36 @@ - - The tag to check for before reading, or for the default tag (Universal 4). + + The tag to check for before reading, or for the default tag (Universal 4). - - Reads the next value as an OCTET STRING with tag UNIVERSAL 4, returning the value - in a byte array. + + Reads the next value as an OCTET STRING with tag UNIVERSAL 4, returning the value + in a byte array. - - A copy of the value in a newly allocated, precisely sized, array. + + A copy of the value in a newly allocated, precisely sized, array. To be added. - - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. - + @@ -1203,38 +1203,38 @@ - - The tag to check for before reading, or for the default tag (Universal 16). + + The tag to check for before reading, or for the default tag (Universal 16). - - Reads the next value as a SEQUENCE or SEQUENCE-OF with the specified tag - and returns the result as a new reader positioned at the first - value in the sequence (or with == ). + + Reads the next value as a SEQUENCE or SEQUENCE-OF with the specified tag + and returns the result as a new reader positioned at the first + value in the sequence (or with == ). - - A new reader positioned at the first - value in the sequence (or with == ). + + A new reader positioned at the first + value in the sequence (or with == ). - - The nested content is not evaluated by this method, and might contain data - that's not valid under the current encoding rules. + + The nested content is not evaluated by this method, and might contain data + that's not valid under the current encoding rules. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -1260,40 +1260,40 @@ - - The tag to check for before reading, or for the default tag (Universal 17). + + The tag to check for before reading, or for the default tag (Universal 17). - - Reads the next value as a SET-OF with the specified tag - and returns the result as a new reader positioned at the first - value in the set-of (or with == ), - using the value - from the constructor (default ). + + Reads the next value as a SET-OF with the specified tag + and returns the result as a new reader positioned at the first + value in the set-of (or with == ), + using the value + from the constructor (default ). - - A new reader positioned at the first - value in the set-of (or with == ). + + A new reader positioned at the first + value in the set-of (or with == ). - - The nested content is not evaluated by this method (aside from sort order, when - required) and might contain data that's not valid under the current encoding rules. + + The nested content is not evaluated by this method (aside from sort order, when + required) and might contain data that's not valid under the current encoding rules. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -1321,42 +1321,42 @@ - to always accept the data in the order it is presented, - to verify that the data is sorted correctly when the - encoding rules say sorting was required (CER and DER). + to always accept the data in the order it is presented, + to verify that the data is sorted correctly when the + encoding rules say sorting was required (CER and DER). - - The tag to check for before reading, or for the default tag (Universal 17). + + The tag to check for before reading, or for the default tag (Universal 17). - - Reads the next value as a SET-OF with the specified tag - and returns the result as a new reader positioned at the first - value in the set-of (or with == ). + + Reads the next value as a SET-OF with the specified tag + and returns the result as a new reader positioned at the first + value in the set-of (or with == ). - - A new reader positioned at the first - value in the set-of (or with == ). + + A new reader positioned at the first + value in the set-of (or with == ). - - The nested content is not evaluated by this method (aside from sort order, when - required) and might contain data that's not valid under the current encoding rules. + + The nested content is not evaluated by this method (aside from sort order, when + required) and might contain data that's not valid under the current encoding rules. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -1382,34 +1382,34 @@ - - The tag to check for before reading, or for the default tag (Universal 23). + + The tag to check for before reading, or for the default tag (Universal 23). - - Reads the next value as a UTCTime with a specified tag using the - value from options passed to - the constructor (with a default of 2049). + + Reads the next value as a UTCTime with a specified tag using the + value from options passed to + the constructor (with a default of 2049). - - The decoded value. + + The decoded value. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -1437,38 +1437,38 @@ - - The largest year to represent with this value. + + The largest year to represent with this value. - - The tag to check for before reading, or for the default tag (Universal 23). + + The tag to check for before reading, or for the default tag (Universal 23). - - Reads the next value as a UTCTime with a specified tag. + + Reads the next value as a UTCTime with a specified tag. - - The decoded value. + + The decoded value. To be added. - - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. - + @@ -1491,11 +1491,11 @@ System.Formats.Asn1.AsnEncodingRules - - Gets the encoding rules in use by this reader. + + Gets the encoding rules in use by this reader. - - The encoding rules in use by this reader. + + The encoding rules in use by this reader. To be added. @@ -1521,13 +1521,13 @@ - - Throws a standardized if the reader has remaining - data, performs no function if returns . + + Throws a standardized if the reader has remaining + data, performs no function if returns . - - This method provides a standardized target and standardized exception for reading a - "closed" structure, such as the nested content for an explicitly tagged value. + + This method provides a standardized target and standardized exception for reading a + "closed" structure, such as the nested content for an explicitly tagged value. @@ -1557,45 +1557,45 @@ The buffer in which to write. - - On success, receives the number of bits in the last byte which were reported as - "unused" by the writer. + + On success, receives the number of bits in the last byte which were reported as + "unused" by the writer. - - On success, receives the number of bytes written to . + + On success, receives the number of bytes written to . - - The tag to check for before reading, or for the default tag (Universal 1). + + The tag to check for before reading, or for the default tag (Universal 1). - - Reads the next value as a BIT STRING with a specified tag, copying the value - into a provided destination buffer. + + Reads the next value as a BIT STRING with a specified tag, copying the value + into a provided destination buffer. - and advances the reader if had sufficient - length to receive the value, otherwise - and the reader does not advance. + and advances the reader if had sufficient + length to receive the value, otherwise + and the reader does not advance. To be added. - - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. - + @@ -1624,51 +1624,51 @@ The buffer in which to write. - - One of the enumeration values representing the value type to process. + + One of the enumeration values representing the value type to process. - - On success, receives the number of chars written to . + + On success, receives the number of chars written to . - - The tag to check for before reading, or for the universal tag that is - appropriate to the requested encoding type. + + The tag to check for before reading, or for the universal tag that is + appropriate to the requested encoding type. - - Reads the next value as character string with the specified tag and - encoding type, copying the decoded value into a provided destination buffer. + + Reads the next value as character string with the specified tag and + encoding type, copying the decoded value into a provided destination buffer. - and advances the reader if had sufficient - length to receive the value, otherwise - and the reader does not advance. + and advances the reader if had sufficient + length to receive the value, otherwise + and the reader does not advance. To be added. - is not a known character string type. - - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. - - -or- - - The string did not successfully decode. + is not a known character string type. + + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. + + -or- + + The string did not successfully decode. - . is - , but - . is not the same as - . + . is + , but + . is not the same as + . @@ -1700,39 +1700,39 @@ The buffer in which to write. The tag to check for before reading. - - On success, receives the number of bytes written to . + + On success, receives the number of bytes written to . - - Reads the next value as character string with the specified tag, - copying the unprocessed bytes into a provided destination buffer. + + Reads the next value as character string with the specified tag, + copying the unprocessed bytes into a provided destination buffer. - and advances the reader if had sufficient - length to receive the value, otherwise - and the reader does not advance. + and advances the reader if had sufficient + length to receive the value, otherwise + and the reader does not advance. - - This method does not determine if the string used only characters defined by the encoding. + + This method does not determine if the string used only characters defined by the encoding. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not a character - string tag type. + . is + , but + . is not a character + string tag type. @@ -1760,38 +1760,38 @@ - - On success, receives the decoded value. + + On success, receives the decoded value. - - The tag to check for before reading, or for the default tag (Universal 2). + + The tag to check for before reading, or for the default tag (Universal 2). - - Attempts to read the next value as an Integer with a specified tag, - as a signed 32-bit value. + + Attempts to read the next value as an Integer with a specified tag, + as a signed 32-bit value. - and does not advance the reader if the value is not between - Int32.MinValue and Int32.MaxValue, inclusive; otherwise - is returned and the reader advances. + and does not advance the reader if the value is not between + Int32.MinValue and Int32.MaxValue, inclusive; otherwise + is returned and the reader advances. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -1818,38 +1818,38 @@ - - On success, receives the decoded value. + + On success, receives the decoded value. - - The tag to check for before reading, or for the default tag (Universal 2). + + The tag to check for before reading, or for the default tag (Universal 2). - - Attempts to read the next value as an Integer with a specified tag, - as a signed 64-bit value. + + Attempts to read the next value as an Integer with a specified tag, + as a signed 64-bit value. - and does not advance the reader if the value is not between - Int64.MinValue and Int64.MaxValue, inclusive; otherwise - is returned and the reader advances. + and does not advance the reader if the value is not between + Int64.MinValue and Int64.MaxValue, inclusive; otherwise + is returned and the reader advances. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -1878,41 +1878,41 @@ The buffer in which to write. - - On success, receives the number of bytes written to . + + On success, receives the number of bytes written to . - - The tag to check for before reading, or for the default tag (Universal 4). + + The tag to check for before reading, or for the default tag (Universal 4). - - Reads the next value as an OCTET STRING with a specified tag, copying the value - into a provided destination buffer. + + Reads the next value as an OCTET STRING with a specified tag, copying the value + into a provided destination buffer. - and advances the reader if had sufficient - length to receive the value, otherwise - and the reader does not advance. + and advances the reader if had sufficient + length to receive the value, otherwise + and the reader does not advance. To be added. - - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. - + @@ -1939,42 +1939,42 @@ - - On success, receives the number of bits in the last byte which were reported as - "unused" by the writer. + + On success, receives the number of bits in the last byte which were reported as + "unused" by the writer. - - On success, receives a over the original data - corresponding to the value of the BIT STRING. + + On success, receives a over the original data + corresponding to the value of the BIT STRING. - - The tag to check for before reading, or for the default tag (Universal 1). + + The tag to check for before reading, or for the default tag (Universal 1). - - Reads the next value as a BIT STRING with a specified tag, returning the contents - as a over the original data. + + Reads the next value as a BIT STRING with a specified tag, returning the contents + as a over the original data. - and advances the reader if the BIT STRING value had a primitive encoding, - and does not advance the reader if it had a constructed encoding. + and advances the reader if the BIT STRING value had a primitive encoding, + and does not advance the reader if it had a constructed encoding. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -2004,37 +2004,37 @@ The tag to check for before reading. - - On success, receives a over the original data - corresponding to the value of the character string. + + On success, receives a over the original data + corresponding to the value of the character string. - - Reads the next value as a character with a specified tag, returning the contents - as an unprocessed over the original data. + + Reads the next value as a character with a specified tag, returning the contents + as an unprocessed over the original data. - and advances the reader if the character string value had a primitive encoding, - and does not advance the reader if it had a constructed encoding. + and advances the reader if the character string value had a primitive encoding, + and does not advance the reader if it had a constructed encoding. - - This method does not determine if the string used only characters defined by the encoding. + + This method does not determine if the string used only characters defined by the encoding. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not a character - string tag type. + . is + , but + . is not a character + string tag type. @@ -2062,36 +2062,36 @@ - - On success, receives a over the original data - corresponding to the value of the OCTET STRING. + + On success, receives a over the original data + corresponding to the value of the OCTET STRING. The tag to check for before reading. - - Attempts to read the next value as an OCTET STRING with a specified tag, returning the contents - as a over the original data. + + Attempts to read the next value as an OCTET STRING with a specified tag, returning the contents + as a over the original data. - and advances the reader if the OCTET STRING value had a primitive encoding, - and does not advance the reader if it had a constructed encoding. + and advances the reader if the OCTET STRING value had a primitive encoding, + and does not advance the reader if it had a constructed encoding. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -2125,38 +2125,38 @@ - - On success, receives the decoded value. + + On success, receives the decoded value. - - The tag to check for before reading, or for the default tag (Universal 2). + + The tag to check for before reading, or for the default tag (Universal 2). - - Attempts to read the next value as an Integer with a specified tag, - as an unsigned 32-bit value. + + Attempts to read the next value as an Integer with a specified tag, + as an unsigned 32-bit value. - and does not advance the reader if the value is not between - UInt32.MinValue and UInt32.MaxValue, inclusive; otherwise - is returned and the reader advances. + and does not advance the reader if the value is not between + UInt32.MinValue and UInt32.MaxValue, inclusive; otherwise + is returned and the reader advances. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. @@ -2189,38 +2189,38 @@ - - On success, receives the decoded value. + + On success, receives the decoded value. - - The tag to check for before reading, or for the default tag (Universal 2). + + The tag to check for before reading, or for the default tag (Universal 2). - - Attempts to read the next value as an Integer with a specified tag, - as an unsigned 64-bit value. + + Attempts to read the next value as an Integer with a specified tag, + as an unsigned 64-bit value. - and does not advance the reader if the value is not between - Int64.MinValue and Int64.MaxValue, inclusive; otherwise - is returned and the reader advances. + and does not advance the reader if the value is not between + Int64.MinValue and Int64.MaxValue, inclusive; otherwise + is returned and the reader advances. To be added. - - The next value does not have the correct tag. - - -or- - - The length encoding is not valid under the current encoding rules. - - -or- - - The contents are not valid under the current encoding rules. + + The next value does not have the correct tag. + + -or- + + The length encoding is not valid under the current encoding rules. + + -or- + + The contents are not valid under the current encoding rules. - . is - , but - . is not correct for - the method. + . is + , but + . is not correct for + the method. diff --git a/xml/System.Formats.Asn1/AsnWriter.xml b/xml/System.Formats.Asn1/AsnWriter.xml index f91915cba78..0eb98807305 100644 --- a/xml/System.Formats.Asn1/AsnWriter.xml +++ b/xml/System.Formats.Asn1/AsnWriter.xml @@ -944,7 +944,7 @@ tag UNIVERSAL 10. To be added. - + is . @@ -962,7 +962,7 @@ the unboxed type of is declared []. - + @@ -1606,14 +1606,14 @@ accepting the two-digit year as valid in context. To be added. - + . is , but . is not correct for the method. - + @@ -1651,7 +1651,7 @@ provided the year is in the allowed range. To be added. - + . is , but @@ -1663,7 +1663,7 @@ is not in the range ( - 100, ]. - + diff --git a/xml/System.Formats.Tar/GnuTarEntry.xml b/xml/System.Formats.Tar/GnuTarEntry.xml index b7b8bce2985..5020bcf0b74 100644 --- a/xml/System.Formats.Tar/GnuTarEntry.xml +++ b/xml/System.Formats.Tar/GnuTarEntry.xml @@ -22,7 +22,7 @@ - Represents a tar entry in the GNU format. + Represents a '' entry in the GNU format. Even though the format is not POSIX compatible, it implements and supports the Unix-specific fields that were defined in the POSIX IEEE P1003.1 standard from 1988: devmajor, devminor, gname, and uname. diff --git a/xml/System.Numerics.Tensors/Tensor.xml b/xml/System.Numerics.Tensors/Tensor.xml index db2085fb677..7f8c66c852c 100644 --- a/xml/System.Numerics.Tensors/Tensor.xml +++ b/xml/System.Numerics.Tensors/Tensor.xml @@ -3908,8 +3908,8 @@ To be added. - The axis along which the tensors will be joined. If axis is -1, arrays are flattened before use. Default is 0. The tensors must have the same shape, except in the dimension corresponding to axis (the first, by default). + The axis along which the tensors will be joined. If axis is -1, arrays are flattened before use. Default is 0. Join a sequence of tensors along an existing axis. @@ -3974,8 +3974,8 @@ To be added. - The axis along which the tensors will be joined. If axis is -1, arrays are flattened before use. Default is 0. The tensors must have the same shape, except in the dimension corresponding to axis (the first, by default). + The axis along which the tensors will be joined. If axis is -1, arrays are flattened before use. Default is 0. Join a sequence of tensors along an existing axis. @@ -5214,7 +5214,7 @@ This method effectively computes .CosPi([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -5296,7 +5296,7 @@ This method effectively computes .CosPi([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -9178,8 +9178,8 @@ To be added. - Value to compare against. First to compare. + Value to compare against. Compares the elements of two to see if any elements of are greater than . If the shapes are not the same, the tensors are broadcasted to the smallest broadcastable size before they are compared. @@ -9965,8 +9965,8 @@ To be added. - Value to compare against. First to compare. + Value to compare against. Compares the elements of two to see if any elements of are greater than . If the shapes are not the same, the tensors are broadcasted to the smallest broadcastable size before they are compared. @@ -11578,8 +11578,8 @@ To be added. - Second value to compare against. First value to compare. + Second value to compare against. Compares the elements of two to see if all elements of are less than . If the shapes are not the same, the tensors are broadcasted to the smallest broadcastable size before they are compared. @@ -12365,8 +12365,8 @@ To be added. - Second value to compare against. First value to compare. + Second value to compare against. Compares the elements of two to see if all elements of are less than . If the shapes are not the same, the tensors are broadcasted to the smallest broadcastable size before they are compared. @@ -18556,8 +18556,8 @@ To be added. The tensor, represented as a span. - The degree of the root to be computed, represented as a scalar. The destination tensor, represented as a span. + The degree of the root to be computed, represented as a scalar. Computes the element-wise n-th root of the values in the specified tensor. To be added. To be added. @@ -20843,8 +20843,8 @@ To be added. - Index of where the new dimension will be. Input . + Index of where the new dimension will be. Join multiple along a new dimension. The axis parameter specifies the index of the new dimension. All tensors must have the same shape. diff --git a/xml/System.Numerics.Tensors/TensorPrimitives.xml b/xml/System.Numerics.Tensors/TensorPrimitives.xml index 270fe7aa1b3..ccc4e0b900d 100644 --- a/xml/System.Numerics.Tensors/TensorPrimitives.xml +++ b/xml/System.Numerics.Tensors/TensorPrimitives.xml @@ -2396,7 +2396,7 @@ This method effectively computes [i] = .Cos([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -2439,7 +2439,7 @@ If a value is equal to , the result stored into the corresponding destination location is also NaN. - The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -2504,7 +2504,7 @@ If a value is equal to , the result stored into the corresponding destination location is also NaN. - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -2673,7 +2673,7 @@ This method effectively computes [i] = .CosPi([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -10116,7 +10116,7 @@ This method effectively computes [i] = .Sin([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -10293,7 +10293,7 @@ the corresponding destination location is set to that value. - The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -10358,7 +10358,7 @@ the corresponding destination location is set to that value. - The angles in x must be in radians. Use or multiply by .Pi / 180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi / 180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -10419,7 +10419,7 @@ This method effectively computes [i] = .SinPi([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -11190,7 +11190,7 @@ This method effectively computes [i] = .Tan([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -11234,7 +11234,7 @@ If a value is equal to , the corresponding destination location is set to NaN. - The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -11300,7 +11300,7 @@ If a value is equal to , the corresponding destination location is set to NaN. - The angles in x must be in radians. Use or multiply by .Pi / 180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi / 180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -11361,7 +11361,7 @@ This method effectively computes [i] = .TanPi([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different diff --git a/xml/System.Reflection/TypeExtensions.xml b/xml/System.Reflection/TypeExtensions.xml index 54a4d623612..80be021e780 100644 --- a/xml/System.Reflection/TypeExtensions.xml +++ b/xml/System.Reflection/TypeExtensions.xml @@ -167,23 +167,38 @@ - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.EventInfo + System.Reflection.EventInfo - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents)>] + + + + To be added. @@ -331,24 +346,39 @@ - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.FieldInfo + System.Reflection.FieldInfo - - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)>] + + + + + To be added. @@ -399,23 +429,37 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.FieldInfo[] + System.Reflection.FieldInfo[] - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)>] + + + + To be added. @@ -426,29 +470,22 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Type[] + System.Type[] - + To be added. @@ -483,23 +520,37 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.MemberInfo[] + System.Reflection.MemberInfo[] - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + + To be added. @@ -539,36 +590,22 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.MemberInfo[] + System.Reflection.MemberInfo[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] - - - + To be added. @@ -578,23 +615,37 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.MemberInfo[] + System.Reflection.MemberInfo[] - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)>] + + + + To be added. @@ -690,36 +741,22 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.MethodInfo[] + System.Reflection.MethodInfo[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)>] - - - + To be added. @@ -756,39 +793,24 @@ - - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Type + System.Type - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)>] - - - - - + + + To be added. @@ -866,23 +888,37 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.PropertyInfo[] + System.Reflection.PropertyInfo[] - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + + To be added. @@ -893,23 +929,38 @@ - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.PropertyInfo + System.Reflection.PropertyInfo - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + + To be added. @@ -1046,42 +1097,23 @@ - - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Boolean + System.Boolean - - - - - [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - [<System.Diagnostics.CodeAnalysis.NotNullWhen(true)>] - - - [System.Runtime.CompilerServices.Nullable(2)] - [<System.Runtime.CompilerServices.Nullable(2)>] - - - + + To be added. diff --git a/xml/System/Index.xml b/xml/System/Index.xml index 58444cbb0f2..2cb51193373 100644 --- a/xml/System/Index.xml +++ b/xml/System/Index.xml @@ -48,21 +48,13 @@ - Represents a type that can be used to index a collection either from the beginning or the end. + Represent a type can be used to index a collection either from the start or the end. - - + Index is used by the C# compiler to support the new index syntax + + int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ; + int lastElement = someArray[^1]; // lastElement = 5 + @@ -95,19 +87,12 @@ int lastElement = someArray[^1]; // lastElement = 5 - The index value. It has to be greater then or equal to zero. - - to index from the end of the collection, or to index from the beginning of the collection. - Initializes a new with a specified index position and a value that indicates if the index is from the beginning or the end of a collection. + The index value. it has to be zero or positive number. + Indicating if the index is from the start or from the end. + Construct an Index using a value and indicating if the index is from the start or from the end. - is constructed from the end, an index value of 1 points to the last element, and an index value of 0 points beyond the last element. - - ]]> - + If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element. + @@ -140,7 +125,7 @@ If the is constructed from the end, an index value of 1 poin System.Index - Gets an that points beyond the last element. + Create an Index pointing at beyond last element. An index that points beyond the last element. To be added. @@ -181,8 +166,8 @@ If the is constructed from the end, an index value of 1 poin - The object to compare with this instance. - Returns a value that indicates whether the current object is equal to another object. + An object to compare with this object + Indicates whether the current Index object is equal to another Index object. if the current Index object is equal to ; otherwise. To be added. @@ -229,8 +214,8 @@ If the is constructed from the end, an index value of 1 poin - An object to compare with this instance. - Indicates whether the current Index object is equal to a specified object. + An object to compare with this object + Indicates whether the current Index object is equal to another object of the same type. if is of type and is equal to the current instance; otherwise. To be added. @@ -269,8 +254,8 @@ If the is constructed from the end, an index value of 1 poin - The index value from the end of a collection. - Creates an from the end of a collection at a specified index position. + The index value from the end. + Create an Index from the end at the position indicated by the value. The index value. To be added. @@ -308,8 +293,8 @@ If the is constructed from the end, an index value of 1 poin - The index position from the start of a collection. - Creates an from the specified index at the start of a collection. + The index value from the start. + Create an Index from the start at the position indicated by the value. The index value. To be added. @@ -383,20 +368,15 @@ If the is constructed from the end, an index value of 1 poin - The length of the collection that the Index will be used with. Must be a positive value. - Calculates the offset from the start of the collection using the specified collection length. + The length of the collection that the Index will be used with. length has to be a positive value + Calculate the offset from the start using the giving collection length. The offset. - , which will have the same effect as validation. - - ]]> - + For performance reason, we don't validate the input length parameter and the returned offset value against negative values. + we don't validate either the returned offset is greater than the input length. + It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and + then used to index a collection will get out of range exception which will be same affect as the validation. + @@ -429,7 +409,7 @@ Collections are not expected to have a negative length/count. If this method's r System.Boolean - Gets a value that indicates whether the index is from the start or the end. + Indicates whether the index is from the start or the end. if the Index is from the end; otherwise, . To be added. @@ -469,7 +449,7 @@ Collections are not expected to have a negative length/count. If this method's r The integer to convert. - Converts an integer number to an . + Converts integer number to an Index. An index representing the integer. To be added. @@ -504,7 +484,7 @@ Collections are not expected to have a negative length/count. If this method's r System.Index - Gets an that points to the first element of a collection. + Create an Index pointing at first element. An instance that points to the first element of a collection. To be added. @@ -540,7 +520,7 @@ Collections are not expected to have a negative length/count. If this method's r - Returns the string representation of the current instance. + Converts the value of the current Index object to its equivalent string representation. The string representation of the . To be added. @@ -575,7 +555,7 @@ Collections are not expected to have a negative length/count. If this method's r System.Int32 - Gets the index value. + Returns the index value. The index value. To be added. diff --git a/xml/System/Range.xml b/xml/System/Range.xml index 1569a17d8a1..9b084d38cbc 100644 --- a/xml/System/Range.xml +++ b/xml/System/Range.xml @@ -48,22 +48,14 @@ - Represents a range that has start and end indexes. + Represent a range has start and end indexes. - - + Range is used by the C# compiler to support the range syntax. + + int[] someArray = new int[5] { 1, 2, 3, 4, 5 }; + int[] subArray1 = someArray[0..2]; // { 1, 2 } + int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } + @@ -97,9 +89,9 @@ int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } - The inclusive start index of the range. - The exclusive end index of the range. - Instantiates a new instance with the specified starting and ending indexes. + Represent the inclusive start index of the range. + Represent the exclusive end index of the range. + Construct a Range object using the start and end indexes. To be added. @@ -133,7 +125,7 @@ int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } System.Range - Gets a object that starts from the first element to the end. + Create a Range object starting from first element to the end. A range from the start to the end. To be added. @@ -168,7 +160,7 @@ int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } System.Index - Gets an that represents the exclusive end index of the range. + Represent the exclusive end index of the Range. The end index of the range. To be added. @@ -207,7 +199,7 @@ int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } The position of the last element up to which the object will be created. - Creates a object starting from the first element in the collection to a specified end index. + Create a Range object starting from first element in the collection to the end Index. A range that starts from the first element to . To be added. @@ -253,8 +245,8 @@ int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } - An object to compare with this Range object. - Returns a value that indicates whether the current instance is equal to a specified object. + An object to compare with this object + Indicates whether the current Range object is equal to another object of the same type. if is of type and is equal to the current instance; otherwise, . To be added. @@ -296,8 +288,8 @@ int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } - A Range object to compare with this Range object. - Returns a value that indicates whether the current instance is equal to another object. + An object to compare with this object + Indicates whether the current Range object is equal to another Range object. if the current instance is equal to ; otherwise, . To be added. @@ -378,18 +370,14 @@ int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } - A positive integer that represents the length of the collection that the range will be used with. - Calculates the start offset and length of the range object using a collection length. + The length of the collection that the range will be used with. length has to be a positive value. + Calculate the start offset and length of range object using a collection length. The start offset and length of the range. - - + For performance reason, we don't validate the input length parameter against negative values. + It is expected Range will be used with collections which always have non negative length/count. + We validate the range is inside the length scope though. + is outside the bounds of the current range. @@ -424,7 +412,7 @@ For performance reasons, this method doesn't validate `length` to ensure that it System.Index - Gets the inclusive start index of the . + Represent the inclusive start index of the Range. The inclusive start index of the range. To be added. @@ -463,7 +451,7 @@ For performance reasons, this method doesn't validate `length` to ensure that it The position of the first element from which the Range will be created. - Returns a new instance starting from a specified start index to the end of the collection. + Create a Range object starting from start index to the end of the collection. A range from to the end of the collection. To be added. @@ -499,7 +487,7 @@ For performance reasons, this method doesn't validate `length` to ensure that it - Returns the string representation of the current object. + Converts the value of the current Range object to its equivalent string representation. The string representation of the range. To be added.