From 74587ec693064f94b23b74831b87dffd5fd748e2 Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Tue, 9 Jul 2019 14:08:51 -0700 Subject: [PATCH 01/33] Automatically port System.Text.Json triple slash comments --- .../JsonAttribute.xml | 4 +- .../JsonExtensionDataAttribute.xml | 20 +- .../JsonIgnoreAttribute.xml | 4 +- .../JsonPropertyNameAttribute.xml | 10 +- xml/System.Text.Json/JsonElement.xml | 102 +-- xml/System.Text.Json/JsonEncodedText.xml | 90 ++- xml/System.Text.Json/JsonException.xml | 70 ++- xml/System.Text.Json/JsonReaderOptions.xml | 26 +- xml/System.Text.Json/JsonTokenType.xml | 35 +- xml/System.Text.Json/Utf8JsonReader.xml | 117 +++- xml/System.Text.Json/Utf8JsonWriter.xml | 581 ++++++++++++++---- 11 files changed, 799 insertions(+), 260 deletions(-) diff --git a/xml/System.Text.Json.Serialization/JsonAttribute.xml b/xml/System.Text.Json.Serialization/JsonAttribute.xml index f643669e4cb..db9dd097924 100644 --- a/xml/System.Text.Json.Serialization/JsonAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonAttribute.xml @@ -14,7 +14,7 @@ - To be added. + The base class of serialization attributes. To be added. @@ -31,7 +31,7 @@ - To be added. + Creates a JsonAttribute instance. To be added. diff --git a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml index 34d07f17653..4b7343b2cfd 100644 --- a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml @@ -19,8 +19,24 @@ - To be added. - To be added. + When placed on a property of type , any properties that do not have a matching member are added to that Dictionary during deserialization and written during serialization. + + + and TValue must be or . + +During deserializing, when using a "null" JSON value is treated as a `null` object reference, and when using a "null" is treated as a JsonElement with set to . + +During serializing, the name of the extension data property is not included in the JSON; the data contained within the extension data is serialized as properties of the JSON object. + +If there is more than one extension property on a type, or it the property is not of the correct type, an is thrown during the first serialization or deserialization of that type. + + ]]> + + diff --git a/xml/System.Text.Json.Serialization/JsonIgnoreAttribute.xml b/xml/System.Text.Json.Serialization/JsonIgnoreAttribute.xml index 15b06f3c265..0cf46dffb44 100644 --- a/xml/System.Text.Json.Serialization/JsonIgnoreAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonIgnoreAttribute.xml @@ -19,7 +19,7 @@ - To be added. + Prevents a property from being serialized or deserialized. To be added. @@ -36,7 +36,7 @@ - To be added. + Initializes a new instance of . To be added. diff --git a/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml b/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml index 7bdbff4ad91..2c5ed1721de 100644 --- a/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml @@ -19,7 +19,7 @@ - To be added. + Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by . To be added. @@ -39,8 +39,8 @@ - To be added. - To be added. + The name of the property. + Initializes a new instance of with the specified property name. To be added. @@ -60,8 +60,8 @@ System.String - To be added. - To be added. + The name of the property. + A string representing the name of the property. To be added. diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index 93b18772912..4b9eb39aee2 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -170,9 +170,22 @@ This method does not parse the contents of a JSON string value. - To be added. - To be added. - To be added. + Gets the value of the element as bytes. + The value decode to bytes. + + + + + + This value's is not . + The value is not encoded as base 64 text and hence cannot be decoded to bytes. + The parent has been disposed. @@ -260,7 +273,7 @@ This method does not create a DateTimeOffset representation of values other than This value's is not . @@ -293,8 +306,8 @@ This method does not create a DateTimeOffset representation of values other than This method does not parse the contents of a JSON string value. On .NET Core, this method returns for values larger than , and it returns for values smaller than . - - ]]> + + ]]> This value's is not . The value cannot be represented as a . @@ -324,7 +337,7 @@ On .NET Core, this method returns This value's is not . @@ -380,7 +393,7 @@ This method does not create a Guid representation of values other than JSON stri This value's is not . @@ -416,8 +429,8 @@ This method does not parse the contents of a JSON string value. Property name matching is performed as an ordinal, case-sensitive comparison. If a property is defined multiple times for the same object, the method matches the last such definition. - - ]]> + + ]]> This value's is not . No property was found with the requested name. @@ -452,8 +465,8 @@ If a property is defined multiple times for the same object, the method matches Property name matching is performed as an ordinal, case-sensitive comparison. If a property is defined multiple times for the same object, the method matches the last such definition. - - ]]> + + ]]> This value's is not . No property was found with the requested name. @@ -493,8 +506,7 @@ If a property is defined multiple times for the same object, the method matches This value's is not . No property was found with the requested name. - - is . + is . The parent has been disposed. @@ -546,8 +558,8 @@ If a property is defined multiple times for the same object, the method matches This method does not parse the contents of a JSON string value. On .NET Core, this method returns for values larger than and for values smaller than . - - ]]> + + ]]> This value's is not . The value cannot be represented as a . @@ -680,8 +692,7 @@ This method does not parse the contents of a JSON string value. To be added. To be added. This value's is not . - - is not in the range [0, ()). + is not in the range [0, ()). The parent has been disposed. @@ -716,8 +727,8 @@ For , , the value of is returned. For other types, the value of is returned. - - ]]> + + ]]> The parent has been disposed. @@ -741,10 +752,24 @@ For other types, the value of is - To be added. - To be added. - To be added. - To be added. + Receives the value. + Attempts to represent the current JSON string as bytes assuming it is base 64 encoded. + + if the entire token value is encoded as valid base 64 text and can be successfully decoded to bytes. + otherwise. + + + + + + This value's is not . + The parent has been disposed. @@ -772,7 +797,7 @@ For other types, the value of is if the string can be represented as a , otherwise. @@ -808,7 +833,7 @@ This method does not create a DateTime representation of values other than JSON This value's is not . @@ -878,8 +903,8 @@ This method does not parse the contents of a JSON string value. This method does not parse the contents of a JSON string value. On .NET Core, this method does not return `false` for values larger than or smaller than . Instead, it returns This value's is not . The parent has been disposed. @@ -912,7 +937,7 @@ On .NET Core, this method does not return `false` for values larger than This value's is not . @@ -1018,8 +1043,8 @@ This method does not parse the contents of a JSON string value. Property name matching is performed as an ordinal, case-sensitive comparison. If a property is defined multiple times for the same object, the method matches the last such definition. - - ]]> + + ]]> This value's is not . The parent has been disposed. @@ -1056,8 +1081,8 @@ If a property is defined multiple times for the same object, the method matches Property name matching is performed as an ordinal, case-sensitive comparison. If a property is defined multiple times for the same object, the method matches the last such definition. - - ]]> + + ]]> This value's is not . The parent has been disposed. @@ -1094,12 +1119,11 @@ If a property is defined multiple times for the same object, the method matches Property name matching is performed as an ordinal, case-sensitive comparison. If a property is defined multiple times for the same object, the method matches the last such definition. - - ]]> + + ]]> This value's is not . - - is . + is . The parent has been disposed. @@ -1132,8 +1156,8 @@ If a property is defined multiple times for the same object, the method matches This method does not parse the contents of a JSON string value. On .NET Core, this method does not return `false` for values larger than or smaller than ). Instead, it returns `false` and assigns or to the `value` argument. - - ]]> + + ]]> This value's is not . The parent has been disposed. diff --git a/xml/System.Text.Json/JsonEncodedText.xml b/xml/System.Text.Json/JsonEncodedText.xml index 43d3804ca9b..8659e6f34ad 100644 --- a/xml/System.Text.Json/JsonEncodedText.xml +++ b/xml/System.Text.Json/JsonEncodedText.xml @@ -23,8 +23,18 @@ - To be added. - To be added. + Provides a way to transform UTF-8 or UTF-16 encoded text into a form that is suitable for JSON. + + + + + @@ -46,10 +56,11 @@ - To be added. - To be added. + The UTF-8 encoded value to be transformed as JSON encoded text. + Encodes the UTF-8 text value as a JSON string. To be added. To be added. + Thrown when the specified value is too large or if it contains invalid UTF-8 bytes. @@ -71,10 +82,11 @@ - To be added. - To be added. + The value to be transformed as JSON encoded text. + Encodes the text value as a JSON string. To be added. To be added. + Thrown when the specified value is too large or if it contains invalid UTF-16 characters. @@ -96,10 +108,12 @@ - To be added. - To be added. + The value to be transformed as JSON encoded text. + Encodes the string text value as a JSON string. To be added. To be added. + Thrown if value is null. + Thrown when the specified value is too large or if it contains invalid UTF-16 characters. @@ -118,7 +132,7 @@ System.ReadOnlySpan<System.Byte> - To be added. + Returns the UTF-8 encoded representation of the pre-encoded JSON text. To be added. To be added. @@ -143,9 +157,19 @@ To be added. - To be added. + Determines whether this instance and a specified object, which must also be a instance, have the same value. To be added. - To be added. + + + is `null`, the method returns `false`. + + ]]> + + @@ -171,9 +195,19 @@ To be added. - To be added. + Determines whether this instance and another specified instance have the same value. To be added. - To be added. + + + are treated as equal. + + ]]> + + @@ -193,9 +227,19 @@ - To be added. + Returns the hash code for this . To be added. - To be added. + + + . + + ]]> + + @@ -215,9 +259,19 @@ - To be added. - To be added. - To be added. + Converts the value of this instance to a . + Returns the underlying UTF-16 encoded string. + + + . + + ]]> + + diff --git a/xml/System.Text.Json/JsonException.xml b/xml/System.Text.Json/JsonException.xml index a48e741a936..73c42f0cb6b 100644 --- a/xml/System.Text.Json/JsonException.xml +++ b/xml/System.Text.Json/JsonException.xml @@ -1,5 +1,4 @@ - - + @@ -14,7 +13,7 @@ - To be added. + Defines a custom exception object that is thrown when invalid JSON text is encountered, when the defined maximum depth is passed, or the JSON text is not compatible with the type of a property on an object. To be added. @@ -35,10 +34,11 @@ - To be added. - To be added. - To be added. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + Creates a new exception object with serialized data. To be added. + Thrown when is . @@ -60,12 +60,22 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The context specific error message. + The path where the invalid JSON was encountered. + The line number at which the invalid JSON was encountered (starting at 0) when deserializing. + The byte count within the current line where the invalid JSON was encountered (starting at 0). + Creates a new exception object to relay error information to the user. + + + counts the number of bytes (i.e. UTF-8 code units) and not characters or scalars. + + ]]> + + @@ -88,13 +98,23 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The context specific error message. + The path where the invalid JSON was encountered. + The line number at which the invalid JSON was encountered (starting at 0) when deserializing. + The byte count within the current line where the invalid JSON was encountered (starting at 0). + The exception that caused the current exception. + Creates a new exception object to relay error information to the user. + + + counts the number of bytes (i.e. UTF-8 code units) and not characters or scalars. + + ]]> + + @@ -113,7 +133,7 @@ System.Nullable<System.Int64> - To be added. + The number of bytes read within the current line before the exception (starting at 0). To be added. To be added. @@ -138,9 +158,9 @@ - To be added. - To be added. - To be added. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + Sets the with information about the exception. To be added. @@ -160,7 +180,7 @@ System.Nullable<System.Int64> - To be added. + The number of lines read so far before the exception (starting at 0). To be added. To be added. @@ -181,7 +201,7 @@ System.String - To be added. + The path within the JSON where the exception was encountered. To be added. To be added. diff --git a/xml/System.Text.Json/JsonReaderOptions.xml b/xml/System.Text.Json/JsonReaderOptions.xml index 23944419d97..35f0c108a85 100644 --- a/xml/System.Text.Json/JsonReaderOptions.xml +++ b/xml/System.Text.Json/JsonReaderOptions.xml @@ -36,7 +36,17 @@ Defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read. By default, it's set to false, and a is thrown if a trailing comma is encountered. To be added. - To be added. + + + is thrown if a trailing comma is encountered. + + ]]> + + @@ -66,6 +76,7 @@ By default, the reader throws a if i ]]> + Thrown when the comment handling enum is set to a value that is not supported (i.e. not within the enum range). @@ -86,7 +97,18 @@ By default, the reader throws a if i Gets or sets the maximum depth allowed when reading JSON, with the default (i.e. 0) indicating a max depth of 64. Reading past this depth will throw a . To be added. - To be added. + + + . + + ]]> + + + Thrown when the max depth is set to a negative value. diff --git a/xml/System.Text.Json/JsonTokenType.xml b/xml/System.Text.Json/JsonTokenType.xml index ac2d1278a21..bcfaa43b646 100644 --- a/xml/System.Text.Json/JsonTokenType.xml +++ b/xml/System.Text.Json/JsonTokenType.xml @@ -34,7 +34,7 @@ 11 - To be added. + Indicates that the token type is the comment string. @@ -54,7 +54,7 @@ 4 - To be added. + Indicates that the token type is the end of a JSON array. @@ -74,7 +74,7 @@ 2 - To be added. + Indicates that the token type is the end of a JSON object. @@ -94,7 +94,7 @@ 9 - To be added. + Indicates that the token type is the JSON literal . @@ -114,7 +114,18 @@ 0 - To be added. + Indicates that there is no value (as distinct from ). + + + . + + ]]> + + @@ -134,7 +145,7 @@ 10 - To be added. + Indicates that the token type is the JSON literal . @@ -154,7 +165,7 @@ 7 - To be added. + Indicates that the token type is a JSON number. @@ -174,7 +185,7 @@ 5 - To be added. + Indicates that the token type is a JSON property name. @@ -194,7 +205,7 @@ 3 - To be added. + Indicates that the token type is the start of a JSON array. @@ -214,7 +225,7 @@ 1 - To be added. + Indicates that the token type is the start of a JSON object. @@ -234,7 +245,7 @@ 6 - To be added. + Indicates that the token type is a JSON string. @@ -254,7 +265,7 @@ 8 - To be added. + Indicates that the token type is the JSON literal . diff --git a/xml/System.Text.Json/Utf8JsonReader.xml b/xml/System.Text.Json/Utf8JsonReader.xml index 4354a2e651b..b184851bc4a 100644 --- a/xml/System.Text.Json/Utf8JsonReader.xml +++ b/xml/System.Text.Json/Utf8JsonReader.xml @@ -21,7 +21,8 @@ Provides a high-performance API for forward-only, read-only access to the UTF-8 encoded JSON text. - + If this is the first call to the constructor, pass in a default state. Otherwise, capture the state from the previous instance of the and pass that back. Initializes a new instance of the class. - + A struct that contains the reader state. On the first call to the constructor, it should reflect a default state; otherwise, it should capture the state from the previous instance instance of the and pass that back. Initializes a new instance of the class. - + Gets the depth of the current token. The depth of the current token. - + Gets the current snapshot of the state that must be captured by the caller and passed back in to the constructor with more data. To be added. - + - To be added. + Parses the current JSON token value from the source and decodes the base 64 encoded JSON string as bytes. To be added. To be added. + Thrown if trying to get the value of a JSON token that is not a . . + Thrown when the JSON string contains data outside of the expected base 64 range, or if it contains invalid/more than two padding characters, or is incomplete (i.e. the JSON string length is not a multiple of 4). @@ -257,9 +264,10 @@ in more data asynchronously before continuing with a new instance of the - To be added. + Parses the current JSON token value from the source as a comment, transcoded as a . To be added. To be added. + Thrown if trying to get the value of the JSON token that is not a comment. . @@ -330,7 +338,7 @@ in more data asynchronously before continuing with a new instance of the Reads the next JSON token value from the source and parses it to a . The UTF-8 encoded token value parsed to a . - Reads the next JSON token value from the source and parses it to a . The UTF-8 encoded token value parsed to a . - Reads the next JSON token value from the source and parses it to an . The UTF-8 encoded token value parsed to an . - Reads the next JSON token value from the source and parses it to an . The UTF-8 encoded token value parsed to an . - Reads the next JSON token value from the source and parses it to a . The UTF-8 encoded token value parsed to a . - if should be used to get the token value. if should be used instead. - `, this always returns `false`. For i System.Boolean - To be added. - To be added. + Returns the mode of this instance of the . + when the reader was constructed with the input span containing the entire data to process. when the reader was constructed knowing that the input span may contain partial data with more data to follow. To be added. @@ -722,8 +730,24 @@ The current depth exceeds the recursive limit set by the maximum depth. - To be added. - To be added. + Skips the children of the current JSON token. + + + is , the reader first moves to the property value. + +When (originally, or after advancing) is or , the reader advances to the matching or . + +For all other token types, the reader does not move. After the next call to , the reader will be at the next value (when in an array), the next property name (when in an object), or the end array/object token. + + ]]> + + + Thrown when the reader was given partial data with more data to follow (i.e. is false). + Thrown when an invalid JSON token is encountered while skipping, according to the JSON RFC, or if the current depth exceeds the recursive limit set by the max depth. @@ -786,8 +810,8 @@ If the look up text is invalid UTF-8 text, the method will return `false` since + + ]]> The JSON text isn't a string (its type is not or ). @@ -808,9 +832,21 @@ If the look up text is invalid or incomplete UTF-16 text (such as unpaired surro System.Int64 - To be added. + Returns the index that the last processed JSON token starts at within the given UTF-8 encoded input text, skipping any white space. To be added. - To be added. + + + + + @@ -854,9 +890,10 @@ If the look up text is invalid or incomplete UTF-16 text (such as unpaired surro To be added. - To be added. - To be added. + Parses the current JSON token value from the source and decodes the base 64 encoded JSON string as bytes. + if the entire token value is encoded as valid base 64 text and can be successfully decoded to bytes, otherwise. To be added. + Thrown if trying to get the value of a JSON token that is not a . . @@ -993,7 +1030,9 @@ If the look up text is invalid or incomplete UTF-16 text (such as unpaired surro if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . - values with hyphens and without any surrounding decorations. @@ -1169,9 +1208,26 @@ This method only parses values with hyphens and without any s - To be added. - To be added. - To be added. + Tries to skip the children of the current JSON token. + + if there was enough data for the children to be skipped successfully, else . + + + is , the reader first moves to the property value. + +When (originally, or after advancing) is or , the reader advances to the matching or . + +For all other token types, the reader does not move. After the next call to , the reader will be at the next value (when in an array), the next property name (when in an object), or the end array/object token. + + ]]> + + Thrown when an invalid JSON token is encountered while skipping, according to the JSON RFC, or if the current depth exceeds the recursive limit set by the max depth. @@ -1195,7 +1251,8 @@ This method only parses values with hyphens and without any s Otherwise, contains the token value. To be added. - + contains the token value. To be added. - - + \ No newline at end of file diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index eb2f2e193f7..bccd46fbbac 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -24,7 +24,7 @@ Provides a high-performance API for forward-only, non-cached writing of UTF-8 encoded JSON text. - Defines the customized behavior of the By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC. Constructs a new instance with a specified . To be added. - - is . + is . @@ -84,8 +83,7 @@ To be able to format the output with indentation and white space OR to skip vali Defines the customized behavior of the By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC. Constructs a new instance with a specified . To be added. - - is . + is . @@ -157,7 +155,7 @@ In the case of a , this property indicates how much data Gets the depth of the current token. The depth of the current token. - instance cannot be reused after disposing. - - ]]> + + ]]> @@ -375,8 +373,7 @@ The will continue to use the original wri ]]> - - is . + is . This instance has been disposed. @@ -408,8 +405,7 @@ The will continue to use the original wri ]]> - - is . + is . This instance has been disposed. @@ -433,10 +429,22 @@ The will continue to use the original wri - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The binary data to be written as a base 64 encoded JSON string as part of the name/value pair. + Writes the property name and raw bytes value (as a base 64 encoded JSON string) as part of a name/value pair of a JSON object. + + + + + + Thrown when the specified property name is too large. + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -459,10 +467,22 @@ The will continue to use the original wri - To be added. - To be added. - To be added. - To be added. + The property name of the JSON object to be transcoded and written as UTF-8. + The binary data to be written as a base 64 encoded JSON string as part of the name/value pair. + Writes the property name and raw bytes value (as a base 64 encoded JSON string) as part of a name/value pair of a JSON object. + + + + + + Thrown when the specified property name is too large. + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -485,10 +505,22 @@ The will continue to use the original wri - To be added. - To be added. - To be added. - To be added. + The property name of the JSON object to be transcoded and written as UTF-8. + The binary data to be written as a base 64 encoded JSON string as part of the name/value pair. + Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object. + + + + + + Thrown when the specified property name is too large. + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -511,10 +543,21 @@ The will continue to use the original wri - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The binary data to be written as a base 64 encoded JSON string as part of the name/value pair. + Writes the pre-encoded property name and raw bytes value (as a base 64 encoded JSON string) as part of a name/value pair of a JSON object. + + + was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -536,9 +579,21 @@ The will continue to use the original wri - To be added. - To be added. - To be added. + The binary data to be written as a base 64 encoded JSON string element of a JSON array. + Writes the raw bytes value as base 64 encoded JSON string as an element of a JSON array. + + + + + + Thrown when the specified value is too large. + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -602,7 +657,7 @@ The property name is escaped before writing. The specified property name is too large. @@ -636,7 +691,7 @@ The property name is escaped before writing. The specified property name is too large. @@ -663,10 +718,21 @@ The property name is escaped before writing. - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON literal "true" or "false" as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. + + + was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -719,7 +785,7 @@ The property name is escaped before writing. The specified value is too large. @@ -754,7 +820,7 @@ The comment value is not escaped before writing. The specified value is too large OR. @@ -789,7 +855,7 @@ The comment value is not escaped before writing. The specified value is too large. @@ -868,7 +934,7 @@ The comment value is not escaped before writing. The specified property name is too large. @@ -900,7 +966,7 @@ The property name is escaped before writing. The specified property name is too large. @@ -932,7 +998,7 @@ The property name is escaped before writing. The specified property name is too large. @@ -958,9 +1024,20 @@ The property name is escaped before writing. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + Writes the pre-encoded property name and the JSON literal "null" as part of a name/value pair of a JSON object. + + + was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -1749,10 +1826,23 @@ Writes the using the default - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + using the default (i.e. 'G'). + +The property name should already be escaped when the instance of was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -1775,10 +1865,23 @@ Writes the using the default - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + using the default (i.e. 'G'). + +The property name should already be escaped when the instance of was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -1801,10 +1904,23 @@ Writes the using the default - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + using the default (i.e. 'G'), for example: 32767. + +The property name should already be escaped when the instance of was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -1827,10 +1943,23 @@ Writes the using the default - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + using the default (i.e. 'G'), for example: 32767. + +The property name should already be escaped when the instance of was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -1853,10 +1982,23 @@ Writes the using the default - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + using the default (i.e. 'G'). + +The property name should already be escaped when the instance of was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -1884,10 +2026,23 @@ Writes the using the default - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + using the default (i.e. 'G'), for example: 32767. + +The property name should already be escaped when the instance of was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -1915,10 +2070,23 @@ Writes the using the default - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + using the default (i.e. 'G'), for example: 32767. + +The property name should already be escaped when the instance of was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -2301,9 +2469,20 @@ Validation is enabled, and this write operation would produce invalid JSON. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON array to be transcoded and written as UTF-8. + Writes the beginning of a JSON array with a pre-encoded property name as the key. + + + was created. + + ]]> + + + Thrown when the depth of the JSON has exceeded the maximum depth of 1000 OR if this would result in an invalid JSON to be written (while validation is enabled). @@ -2459,9 +2638,20 @@ Validation is enabled, and this write operation would produce invalid JSON. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + Writes the beginning of a JSON object with a pre-encoded property name as the key. + + + was created. + + ]]> + + + Thrown when the depth of the JSON has exceeded the maximum depth of 1000 OR if this would result in an invalid JSON to be written (while validation is enabled). @@ -2688,10 +2878,24 @@ The property name and value is escaped before writing. - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + Writes the UTF-8 property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. + + + was created. + +The property name is escaped before writing. + + ]]> + + + Thrown when the specified property name is too large. + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -2918,10 +3122,24 @@ The property name and value is escaped before writing. - To be added. - To be added. - To be added. - To be added. + The property name of the JSON object to be transcoded and written as UTF-8. + The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + Writes the property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. + + + was created. + +The property name is escaped before writing. + + ]]> + + + Thrown when the specified property name is too large. + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -3148,10 +3366,24 @@ The property name and value is escaped before writing. - To be added. - To be added. - To be added. - To be added. + The property name of the JSON object to be transcoded and written as UTF-8. + The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + Writes the property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. + + + was created. + +The property name is escaped before writing. + + ]]> + + + Thrown when the specified property name is too large. + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -3174,10 +3406,23 @@ The property name and value is escaped before writing. - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + using the round-trippable ('O') , for example: 2017-06-12T05:30:45.7680000. + +The property name should already be escaped when the instance of was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -3200,10 +3445,23 @@ The property name and value is escaped before writing. - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + using the round-trippable ('O') , for example: 2017-06-12T05:30:45.7680000-07:00. + +The property name should already be escaped when the instance of was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -3226,10 +3484,23 @@ The property name and value is escaped before writing. - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + using the default (i.e. 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. + +The property name should already be escaped when the instance of was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -3252,10 +3523,24 @@ The property name and value is escaped before writing. - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. + Writes the pre-encoded property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. + + + was created. + +The value is escaped before writing. + + ]]> + + + Thrown when the specified value is too large. + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -3278,10 +3563,24 @@ The property name and value is escaped before writing. - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + Writes the pre-encoded property name and text value (as a JSON string) as part of a name/value pair of a JSON object. + + + was created. + +The value is escaped before writing. + + ]]> + + + Thrown when the specified value is too large. + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -3304,10 +3603,24 @@ The property name and value is escaped before writing. - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + Writes the pre-encoded property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. + + + was created. + +The value is escaped before writing. + + ]]> + + + Thrown when the specified value is too large. + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -3330,10 +3643,21 @@ The property name and value is escaped before writing. - To be added. - To be added. - To be added. - To be added. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + Writes the pre-encoded property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. + + + was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). @@ -3544,9 +3868,20 @@ The value is escaped before writing. - To be added. - To be added. - To be added. + The JSON encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array. + Writes the pre-encoded text value (as a JSON string) as an element of a JSON array. + + + was created. + + ]]> + + + Thrown if this would result in an invalid JSON to be written (while validation is enabled). From b9f3fb8e68b0e6421a5322c7d8a25f64b37b63f3 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Jul 2019 18:12:07 -0700 Subject: [PATCH 02/33] Update JsonAttribute.xml --- xml/System.Text.Json.Serialization/JsonAttribute.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Text.Json.Serialization/JsonAttribute.xml b/xml/System.Text.Json.Serialization/JsonAttribute.xml index db9dd097924..72f4c35ac9a 100644 --- a/xml/System.Text.Json.Serialization/JsonAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonAttribute.xml @@ -14,7 +14,7 @@ - The base class of serialization attributes. + Provides the base class for serialization attributes. To be added. @@ -31,9 +31,9 @@ - Creates a JsonAttribute instance. + Creates a new instance of the instance. To be added. - \ No newline at end of file + From 6aec4484a532fc5f7807aa2c9fcca939332f394e Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Jul 2019 18:28:29 -0700 Subject: [PATCH 03/33] Update JsonExtensionDataAttribute.xml --- .../JsonExtensionDataAttribute.xml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml index 4b7343b2cfd..5e112d9f98f 100644 --- a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml @@ -19,18 +19,18 @@ - When placed on a property of type , any properties that do not have a matching member are added to that Dictionary during deserialization and written during serialization. + When placed on a property of type , provides that any properties that do not have a matching member are added to that dictionary during deserialization and written during serialization. and TValue must be or . +The dictionary's `TKey` value must be , and `TValue` must be or . -During deserializing, when using a "null" JSON value is treated as a `null` object reference, and when using a "null" is treated as a JsonElement with set to . +During deserialization, when using , a "null" JSON value is treated as a `null` object reference, and when using , a "null" is treated as a JsonElement with set to . -During serializing, the name of the extension data property is not included in the JSON; the data contained within the extension data is serialized as properties of the JSON object. +During serialization, the name of the extension data property is not included in the JSON; the data contained within the extension data is serialized as properties of the JSON object. If there is more than one extension property on a type, or it the property is not of the correct type, an is thrown during the first serialization or deserialization of that type. @@ -51,10 +51,10 @@ If there is more than one extension property on a type, or it the property is no 4.0.0.0 - - To be added. + Instantiates a new instance of the class. To be added. - \ No newline at end of file + From 8f1dfdc02174a954e408b5b4c896ef59d4ab1f86 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Jul 2019 18:32:51 -0700 Subject: [PATCH 04/33] Update JsonPropertyNameAttribute.xml --- .../JsonPropertyNameAttribute.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml b/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml index 2c5ed1721de..dffc2024599 100644 --- a/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml @@ -19,7 +19,7 @@ - Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by . + Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by . To be added. @@ -60,10 +60,10 @@ System.String - The name of the property. - A string representing the name of the property. + Gets the name of the property. + The name of the property. To be added. - \ No newline at end of file + From 663a3ba1d8f10bd065bd90d7a17698359d600eeb Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Jul 2019 18:38:01 -0700 Subject: [PATCH 05/33] Update JsonExtensionDataAttribute.xml --- .../JsonExtensionDataAttribute.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml index 5e112d9f98f..bede75011e8 100644 --- a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml @@ -28,7 +28,7 @@ The dictionary's `TKey` value must be , and `TValue` must be or . -During deserialization, when using , a "null" JSON value is treated as a `null` object reference, and when using , a "null" is treated as a JsonElement with set to . +During deserialization, when using , a "null" JSON value is treated as a `null` object reference, and when using , a "null" is treated as a JsonElement with set to . During serialization, the name of the extension data property is not included in the JSON; the data contained within the extension data is serialized as properties of the JSON object. From 9ee98a072b1ef19d9d0f5043400014a78f5d1aee Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Jul 2019 18:49:30 -0700 Subject: [PATCH 06/33] Update JsonElement.xml --- xml/System.Text.Json/JsonElement.xml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index 4b9eb39aee2..ec7909a1abd 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -170,20 +170,20 @@ This method does not parse the contents of a JSON string value. - Gets the value of the element as bytes. - The value decode to bytes. + Gets the value of the element as a byte array. + The value decoded as a byte array. - This value's is not . + This value's is not . The value is not encoded as base 64 text and hence cannot be decoded to bytes. The parent has been disposed. @@ -752,8 +752,8 @@ For other types, the value of is - Receives the value. - Attempts to represent the current JSON string as bytes assuming it is base 64 encoded. + When the method returns, contains the byte representation of if the method succeeded. + Attempts to represent the current JSON string as a byte array, assuming that it is base 64-encoded. if the entire token value is encoded as valid base 64 text and can be successfully decoded to bytes. otherwise. @@ -763,12 +763,12 @@ For other types, the value of is ## Remarks -This method does not create a byte[] representation of values other than bsae 64 encoded JSON strings. +This method does not create a byte array representation of values other than bsae 64-encoded JSON strings. ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -1372,4 +1372,4 @@ This method does not parse the contents of a JSON string value. - \ No newline at end of file + From 5a071ee5eeda8c1f8a6bffe49971dd09656f57ce Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Jul 2019 19:05:11 -0700 Subject: [PATCH 07/33] Update JsonEncodedText.xml --- xml/System.Text.Json/JsonEncodedText.xml | 38 ++++++++++++------------ 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/xml/System.Text.Json/JsonEncodedText.xml b/xml/System.Text.Json/JsonEncodedText.xml index 8659e6f34ad..fa143833fc4 100644 --- a/xml/System.Text.Json/JsonEncodedText.xml +++ b/xml/System.Text.Json/JsonEncodedText.xml @@ -30,7 +30,7 @@ ## Remarks -This can be used to cache and store known strings used for writing JSON ahead of time by pre-encoding them up front. +This type can be used to cache and store known strings used for writing JSON ahead of time by pre-encoding them up front. ]]> @@ -57,10 +57,10 @@ This can be used to cache and store known strings used for writing JSON ahead of The UTF-8 encoded value to be transformed as JSON encoded text. - Encodes the UTF-8 text value as a JSON string. - To be added. + Encodes a UTF-8 encoded byte span as a JSON string. + The JSON string. To be added. - Thrown when the specified value is too large or if it contains invalid UTF-8 bytes. + is too large or contains invalid UTF-8 bytes. @@ -83,10 +83,10 @@ This can be used to cache and store known strings used for writing JSON ahead of The value to be transformed as JSON encoded text. - Encodes the text value as a JSON string. - To be added. + Encodes a UTF-16 encoded character span as a JSON string. + The JSON string. To be added. - Thrown when the specified value is too large or if it contains invalid UTF-16 characters. + is too large or contains invalid UTF-16 characters. @@ -112,8 +112,8 @@ This can be used to cache and store known strings used for writing JSON ahead of Encodes the string text value as a JSON string. To be added. To be added. - Thrown if value is null. - Thrown when the specified value is too large or if it contains invalid UTF-16 characters. + is . + is too large or contains invalid UTF-16 characters. @@ -132,8 +132,8 @@ This can be used to cache and store known strings used for writing JSON ahead of System.ReadOnlySpan<System.Byte> - Returns the UTF-8 encoded representation of the pre-encoded JSON text. - To be added. + Gets the UTF-8 encoded representation of the pre-encoded JSON text. + The UTF-8 encoded representation of the pre-encoded JSON text. To be added. @@ -158,14 +158,14 @@ This can be used to cache and store known strings used for writing JSON ahead of To be added. Determines whether this instance and a specified object, which must also be a instance, have the same value. - To be added. + if the current instance and are equal; otherwise, . is `null`, the method returns `false`. +If `obj` is `null`, the method returns `false`. ]]> @@ -196,7 +196,7 @@ If is `null`, the method returns `false`. To be added. Determines whether this instance and another specified instance have the same value. - To be added. + if this instance and have the same value; otherwise, . are treated as equa Returns the hash code for this . - To be added. + The hash code for this instance. . +This method returns 0 on a default instance of . ]]> @@ -260,14 +260,14 @@ Returns 0 on a default instance of . Converts the value of this instance to a . - Returns the underlying UTF-16 encoded string. + The underlying UTF-16 encoded string. . +This method returns an empty string on a default instance of . ]]> @@ -275,4 +275,4 @@ Returns an empty string on a default instance of - \ No newline at end of file + From 56710b2483e0e3640bc308cc565540e6fff62f4d Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Jul 2019 19:16:35 -0700 Subject: [PATCH 08/33] Update JsonException.xml --- xml/System.Text.Json/JsonException.xml | 45 +++++++++++++------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/xml/System.Text.Json/JsonException.xml b/xml/System.Text.Json/JsonException.xml index 73c42f0cb6b..69be241c9a4 100644 --- a/xml/System.Text.Json/JsonException.xml +++ b/xml/System.Text.Json/JsonException.xml @@ -1,4 +1,5 @@ - + + @@ -34,11 +35,11 @@ - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. + The serialized object data about the exception being thrown. + An object that contains contextual information about the source or destination. Creates a new exception object with serialized data. To be added. - Thrown when is . + is . @@ -60,10 +61,10 @@ - The context specific error message. + The context-specific error message. The path where the invalid JSON was encountered. - The line number at which the invalid JSON was encountered (starting at 0) when deserializing. - The byte count within the current line where the invalid JSON was encountered (starting at 0). + The line number (starting at 0) at which the invalid JSON was encountered when deserializing. + The byte count within the current line (starting at 0) where the invalid JSON was encountered. Creates a new exception object to relay error information to the user. @@ -71,7 +72,7 @@ ## Remarks -Note that the counts the number of bytes (i.e. UTF-8 code units) and not characters or scalars. +Note that `bytePositionInLine` counts the number of bytes (that is, UTF-8 code units), and not characters or scalars. ]]> @@ -98,19 +99,19 @@ Note that the counts the number of bytes (i.e. UTF-8 c - The context specific error message. + The context-specific error message. The path where the invalid JSON was encountered. - The line number at which the invalid JSON was encountered (starting at 0) when deserializing. - The byte count within the current line where the invalid JSON was encountered (starting at 0). + The line number (starting at 0) at which the invalid JSON was encountered when deserializing. + The byte count (starting at 0) within the current line where the invalid JSON was encountered. The exception that caused the current exception. - Creates a new exception object to relay error information to the user. + Creates a new exception object to relay error information to the user that includes a specified inner exception. counts the number of bytes (i.e. UTF-8 code units) and not characters or scalars. +Note that the `bytePositionInLine` counts the number of bytes (that is, UTF-8 code units), and not characters or scalars. ]]> @@ -133,8 +134,8 @@ Note that the counts the number of bytes (i.e. UTF-8 c System.Nullable<System.Int64> - The number of bytes read within the current line before the exception (starting at 0). - To be added. + Gets the zero-based number of bytes read within the current line before the exception. + The zero-based number of bytes read within the current line before the exception. To be added. @@ -158,8 +159,8 @@ Note that the counts the number of bytes (i.e. UTF-8 c - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. + The serialized object data about the exception being thrown. + An object that contains contextual information about the source or destination. Sets the with information about the exception. To be added. @@ -180,8 +181,8 @@ Note that the counts the number of bytes (i.e. UTF-8 c System.Nullable<System.Int64> - The number of lines read so far before the exception (starting at 0). - To be added. + Gets the zero-based number of lines read before the exception. + The zero-based number of lines read before the exception. To be added. @@ -201,10 +202,10 @@ Note that the counts the number of bytes (i.e. UTF-8 c System.String - The path within the JSON where the exception was encountered. - To be added. + Gets The path within the JSON where the exception was encountered. + The path within the JSON where the exception was encountered. To be added. - \ No newline at end of file + From 7c450f21d82faa011c7040a5867d4929883b0575 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Jul 2019 19:25:17 -0700 Subject: [PATCH 09/33] Update JsonReaderOptions.xml --- xml/System.Text.Json/JsonReaderOptions.xml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/xml/System.Text.Json/JsonReaderOptions.xml b/xml/System.Text.Json/JsonReaderOptions.xml index 35f0c108a85..b3c1eaff389 100644 --- a/xml/System.Text.Json/JsonReaderOptions.xml +++ b/xml/System.Text.Json/JsonReaderOptions.xml @@ -34,15 +34,15 @@ System.Boolean - Defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read. By default, it's set to false, and a is thrown if a trailing comma is encountered. - To be added. + Gets or sets a value that defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read. + if an exra comma is allowed; otherwise, . is thrown if a trailing comma is encountered. +By default, this property is set to `false`, and a is thrown if a trailing comma is encountered. ]]> @@ -65,7 +65,7 @@ By default, it's set to `false`, and struct handles comments when reading through the JSON data. + Gets or sets a value that determines how the handles comments when reading through the JSON data. One of the enumeration values that indicates how comments are handled. if i ]]> - Thrown when the comment handling enum is set to a value that is not supported (i.e. not within the enum range). + The property is being set to a value that is not a member of the enumeration. @@ -95,8 +95,8 @@ By default, the reader throws a if i System.Int32 - Gets or sets the maximum depth allowed when reading JSON, with the default (i.e. 0) indicating a max depth of 64. Reading past this depth will throw a . - To be added. + Gets or sets the maximum depth allowed when reading JSON, with the default (i.e. 0) indicating a maximum depth of 64. + The maximum depth allowed when reading JSON. - Thrown when the max depth is set to a negative value. + The maximum depth is being set to a negative value. - \ No newline at end of file + From e3c89a94e1aa59c6ff42f7cee37aa7b09f179c9e Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Jul 2019 19:27:33 -0700 Subject: [PATCH 10/33] Update JsonTokenType.xml --- xml/System.Text.Json/JsonTokenType.xml | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/xml/System.Text.Json/JsonTokenType.xml b/xml/System.Text.Json/JsonTokenType.xml index bcfaa43b646..c4f2a659529 100644 --- a/xml/System.Text.Json/JsonTokenType.xml +++ b/xml/System.Text.Json/JsonTokenType.xml @@ -34,7 +34,7 @@ 11 - Indicates that the token type is the comment string. + The token type is the comment string. @@ -54,7 +54,7 @@ 4 - Indicates that the token type is the end of a JSON array. + The token type is the end of a JSON array. @@ -74,7 +74,7 @@ 2 - Indicates that the token type is the end of a JSON object. + The token type is the end of a JSON object. @@ -94,7 +94,7 @@ 9 - Indicates that the token type is the JSON literal . + The token type is the JSON literal . @@ -114,7 +114,7 @@ 0 - Indicates that there is no value (as distinct from ). + There is no value (as distinct from ). 10 - Indicates that the token type is the JSON literal . + The token type is the JSON literal . @@ -165,7 +165,7 @@ This is the default token type if no data has been read by the 7 - Indicates that the token type is a JSON number. + The token type is a JSON number. @@ -185,7 +185,7 @@ This is the default token type if no data has been read by the 5 - Indicates that the token type is a JSON property name. + The token type is a JSON property name. @@ -205,7 +205,7 @@ This is the default token type if no data has been read by the 3 - Indicates that the token type is the start of a JSON array. + The token type is the start of a JSON array. @@ -225,7 +225,7 @@ This is the default token type if no data has been read by the 1 - Indicates that the token type is the start of a JSON object. + The token type is the start of a JSON object. @@ -245,7 +245,7 @@ This is the default token type if no data has been read by the 6 - Indicates that the token type is a JSON string. + The token type is a JSON string. @@ -265,8 +265,8 @@ This is the default token type if no data has been read by the 8 - Indicates that the token type is the JSON literal . + The token type is the JSON literal . - \ No newline at end of file + From eef082606d328b4af0f661f422990f057249a142 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Jul 2019 19:38:19 -0700 Subject: [PATCH 11/33] Update Utf8JsonReader.xml --- xml/System.Text.Json/Utf8JsonReader.xml | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/xml/System.Text.Json/Utf8JsonReader.xml b/xml/System.Text.Json/Utf8JsonReader.xml index b184851bc4a..cf9d8c440af 100644 --- a/xml/System.Text.Json/Utf8JsonReader.xml +++ b/xml/System.Text.Json/Utf8JsonReader.xml @@ -240,11 +240,19 @@ in more data asynchronously before continuing with a new instance of the - Parses the current JSON token value from the source and decodes the base 64 encoded JSON string as bytes. - To be added. + Parses the current JSON token value from the source and decodes the base 64 encoded JSON string as a byte array. + The byte array that represents the current JSON token value. To be added. - Thrown if trying to get the value of a JSON token that is not a . . - Thrown when the JSON string contains data outside of the expected base 64 range, or if it contains invalid/more than two padding characters, or is incomplete (i.e. the JSON string length is not a multiple of 4). + The type of the JSON token is not a . + The JSON string contains data outside of the expected base 64 range. + +- or - + +The JSON string contains invalid padding characters or more than two padding characters. + +- or - + +The JSON string is incomplete; that is, the JSON string length is not a multiple of 4. @@ -264,10 +272,10 @@ in more data asynchronously before continuing with a new instance of the - Parses the current JSON token value from the source as a comment, transcoded as a . - To be added. + Parses the current JSON token value from the source as a comment, transcoded it as a . + The comment that represnets the current JSON token value. To be added. - Thrown if trying to get the value of the JSON token that is not a comment. . + The JSON token that is not a comment. @@ -1299,4 +1307,4 @@ Otherwise, the token value must be accessed from - \ No newline at end of file + From 80f4479b729a525806744b904a4d5a98136da640 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 16 Jul 2019 21:04:54 -0700 Subject: [PATCH 12/33] suggestions by rpetrusha Co-Authored-By: Ron Petrusha --- xml/System.Text.Json/JsonEncodedText.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text.Json/JsonEncodedText.xml b/xml/System.Text.Json/JsonEncodedText.xml index fa143833fc4..9adc1080e2f 100644 --- a/xml/System.Text.Json/JsonEncodedText.xml +++ b/xml/System.Text.Json/JsonEncodedText.xml @@ -23,7 +23,7 @@ - Provides a way to transform UTF-8 or UTF-16 encoded text into a form that is suitable for JSON. + Provides methods to transform UTF-8 or UTF-16 encoded text into a form that is suitable for JSON. Date: Wed, 17 Jul 2019 09:40:45 -0700 Subject: [PATCH 13/33] Fixed malformed XML --- .../JsonExtensionDataAttribute.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml index bede75011e8..e4dcf93889f 100644 --- a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml @@ -51,7 +51,7 @@ If there is more than one extension property on a type, or it the property is no 4.0.0.0 - Instantiates a new instance of the class. To be added. From ce0727e3781b73b9cc7f6b02c50eef71c8c0e01f Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 17 Jul 2019 09:42:26 -0700 Subject: [PATCH 14/33] fixed bad paramref --- xml/System.Text.Json/JsonEncodedText.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text.Json/JsonEncodedText.xml b/xml/System.Text.Json/JsonEncodedText.xml index 9adc1080e2f..5ed725e8704 100644 --- a/xml/System.Text.Json/JsonEncodedText.xml +++ b/xml/System.Text.Json/JsonEncodedText.xml @@ -60,7 +60,7 @@ This type can be used to cache and store known strings used for writing JSON ahe Encodes a UTF-8 encoded byte span as a JSON string. The JSON string. To be added. - is too large or contains invalid UTF-8 bytes. + is too large or contains invalid UTF-8 bytes. From 53d7a140af796c95689e52c80bb1c5bf02628544 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 17 Jul 2019 10:30:50 -0700 Subject: [PATCH 15/33] Update Utf8JsonReader.xml --- xml/System.Text.Json/Utf8JsonReader.xml | 44 +++++++++++++++---------- 1 file changed, 26 insertions(+), 18 deletions(-) diff --git a/xml/System.Text.Json/Utf8JsonReader.xml b/xml/System.Text.Json/Utf8JsonReader.xml index cf9d8c440af..c3327f2502a 100644 --- a/xml/System.Text.Json/Utf8JsonReader.xml +++ b/xml/System.Text.Json/Utf8JsonReader.xml @@ -667,8 +667,8 @@ For input data within a `ReadOnlySpan`, this always returns `false`. For i System.Boolean - Returns the mode of this instance of the . - when the reader was constructed with the input span containing the entire data to process. when the reader was constructed knowing that the input span may contain partial data with more data to follow. + Gets the mode of this instance of the . + if the reader was constructed with the input span containing the entire data to process. if the reader was constructed with an input span that may contain partial data with more data to follow. To be added. @@ -745,17 +745,21 @@ The current depth exceeds the recursive limit set by the maximum depth. is , the reader first moves to the property value. +When is , the reader first moves to the property value. -When (originally, or after advancing) is or , the reader advances to the matching or . +When (originally, or after advancing) is or , the reader advances to the matching or . For all other token types, the reader does not move. After the next call to , the reader will be at the next value (when in an array), the next property name (when in an object), or the end array/object token. ]]> - Thrown when the reader was given partial data with more data to follow (i.e. is false). - Thrown when an invalid JSON token is encountered while skipping, according to the JSON RFC, or if the current depth exceeds the recursive limit set by the max depth. + The reader was given partial data with more data to follow (that is, is ). + An invalid JSON token was encountered while skipping, according to the JSON RFC. + +- or - + +The current depth exceeds the recursive limit set by the maximum depth. @@ -840,17 +844,17 @@ If the look up text is invalid or incomplete UTF-16 text (such as unpaired surro System.Int64 - Returns the index that the last processed JSON token starts at within the given UTF-8 encoded input text, skipping any white space. - To be added. + Gets the index that the last processed JSON token within the given UTF-8 encoded input text starts at, skipping any white space. + The starting index of the last processed JSON token within the given UTF-8 encoded input text. @@ -897,11 +901,11 @@ For comments, this points to before the first comment delimiter (i.e. '/'). - To be added. - Parses the current JSON token value from the source and decodes the base 64 encoded JSON string as bytes. - if the entire token value is encoded as valid base 64 text and can be successfully decoded to bytes, otherwise. + When the method returns, a byte array that contains the base 64-encoded JSON string if the method succeeds. + Tries to parse the current JSON token value from the source and decodes the base 64 encoded JSON string as a byte array. + if the entire token value is encoded as valid base 64 text and can be successfully decoded; otherwise. To be added. - Thrown if trying to get the value of a JSON token that is not a . . + The JSON token is not a . @@ -1218,7 +1222,7 @@ This method only parses values with hyphens and without any s Tries to skip the children of the current JSON token. - if there was enough data for the children to be skipped successfully, else . + if there was enough data for the children to be skipped successfully; otherwise, . values with hyphens and without any s If the reader did not have enough data to completely skip the children of the current token, it will be reset to the state it was in before the method was called. -When is , the reader first moves to the property value. +When is , the reader first moves to the property value. -When (originally, or after advancing) is or , the reader advances to the matching or . +When (originally, or after advancing) is or , the reader advances to the matching or . For all other token types, the reader does not move. After the next call to , the reader will be at the next value (when in an array), the next property name (when in an object), or the end array/object token. ]]> - Thrown when an invalid JSON token is encountered while skipping, according to the JSON RFC, or if the current depth exceeds the recursive limit set by the max depth. + An invalid JSON token was encountered while skipping, according to the JSON RFC. + +- or - + +The current depth exceeds the recursive limit set by the maximum depth. From eee88860199c0b7b31b3084df04845397c61b7d8 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 17 Jul 2019 10:56:15 -0700 Subject: [PATCH 16/33] Update Utf8JsonWriter.xml --- xml/System.Text.Json/Utf8JsonWriter.xml | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index bccd46fbbac..24fd69e66c3 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -443,8 +443,8 @@ The property name is escaped before writing. ]]> - Thrown when the specified property name is too large. - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + The specified property name is too large. + Validation is enabled, and this method would result in writing invalid JSON. @@ -481,8 +481,8 @@ The property name is escaped before writing. ]]> - Thrown when the specified property name is too large. - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + The specified property name is too large. + Validation is enabled, and this method would result in writing invalid JSON. @@ -519,8 +519,9 @@ The property name is escaped before writing. ]]> - Thrown when the specified property name is too large. - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + + when the specified property name is too large. + Validation is enabled, and this method would result in writing invalid JSON. @@ -557,7 +558,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and this method would result in writing invalid JSON. @@ -592,8 +593,8 @@ The bytes are encoded before writing. ]]> - Thrown when the specified value is too large. - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + The specified value is too large. + Validation is enabled, and this method would result in writing invalid JSON. @@ -732,7 +733,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and this method would result in writing invalid JSON. @@ -1037,7 +1038,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and this method would result in writing invalid JSON. @@ -3885,4 +3886,4 @@ The value should already be escaped when the instance of - \ No newline at end of file + From 33f597f7eaf256c8fe7c6dda330a3e964c6e57ad Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 17 Jul 2019 11:01:10 -0700 Subject: [PATCH 17/33] Update Utf8JsonWriter.xml --- xml/System.Text.Json/Utf8JsonWriter.xml | 26 ++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index 24fd69e66c3..89a957a3afd 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -1843,7 +1843,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and this method would result in writing invalid JSON. @@ -1882,7 +1882,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and this method would result in writing invalid JSON. @@ -1921,7 +1921,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and this method would result in writing invalid JSON. @@ -1960,7 +1960,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and this method would result in writing invalid JSON. @@ -1999,7 +1999,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and this method would result in writing invalid JSON. @@ -2043,7 +2043,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and this method would result in writing invalid JSON. @@ -2087,7 +2087,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and this method would result in writing invalid JSON. @@ -2483,7 +2483,11 @@ The property name should already be escaped when the instance of - Thrown when the depth of the JSON has exceeded the maximum depth of 1000 OR if this would result in an invalid JSON to be written (while validation is enabled). + The depth of the JSON has exceeded the maximum depth of 1000. + +- or - + +Validation is enabled, and this method would result in writing invalid JSON. @@ -2652,7 +2656,11 @@ The property name should already be escaped when the instance of - Thrown when the depth of the JSON has exceeded the maximum depth of 1000 OR if this would result in an invalid JSON to be written (while validation is enabled). + The depth of the JSON has exceeded the maximum depth of 1000. + +- or - + +Validation is enabled, and this method would result in writing invalid JSON. From 5ed4fd191fb97499b878eba7e9c8c5b482b8c5dc Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 17 Jul 2019 11:05:22 -0700 Subject: [PATCH 18/33] Update Utf8JsonWriter.xml --- xml/System.Text.Json/Utf8JsonWriter.xml | 34 ++++++++++++------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index 89a957a3afd..df7f39dac8c 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -2903,8 +2903,8 @@ The property name is escaped before writing. ]]> - Thrown when the specified property name is too large. - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + The specified property name is too large. + Validation is enabled, and this method would result in writing invalid JSON. @@ -3147,8 +3147,8 @@ The property name is escaped before writing. ]]> - Thrown when the specified property name is too large. - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -3391,8 +3391,8 @@ The property name is escaped before writing. ]]> - Thrown when the specified property name is too large. - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -3431,7 +3431,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -3470,7 +3470,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -3509,7 +3509,7 @@ The property name should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -3548,8 +3548,8 @@ The value is escaped before writing. ]]> - Thrown when the specified value is too large. - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -3588,8 +3588,8 @@ The value is escaped before writing. ]]> - Thrown when the specified value is too large. - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -3628,8 +3628,8 @@ The value is escaped before writing. ]]> - Thrown when the specified value is too large. - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -3666,7 +3666,7 @@ The property name and value should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -3890,7 +3890,7 @@ The value should already be escaped when the instance of - Thrown if this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. From b9d48be98362f274223aa8ebb7402033d4017b3d Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 17 Jul 2019 11:19:13 -0700 Subject: [PATCH 19/33] Update Utf8JsonWriter.xml --- xml/System.Text.Json/Utf8JsonWriter.xml | 84 ++++++++++++------------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index df7f39dac8c..a5a56e2520a 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -793,7 +793,7 @@ The comment value is not escaped before writing. -or- - contains a comment delimiter (i.e. */). + contains a comment delimiter (such as */). @@ -828,7 +828,7 @@ The comment value is not escaped before writing. -or- - contains a comment delimiter (i.e. */). + contains a comment delimiter (such as */). @@ -863,7 +863,7 @@ The comment value is not escaped before writing. -or- - contains a comment delimiter (i.e. */). + contains a comment delimiter (such as */). @@ -1089,7 +1089,7 @@ The property name should already be escaped when the instance of using the default (i.e. 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). The property name is escaped before writing. ]]> @@ -1123,7 +1123,7 @@ Writes the using the default using the default (i.e. 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). The property name is escaped before writing. ]]> @@ -1157,7 +1157,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1191,7 +1191,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1225,7 +1225,7 @@ Writes the using the default using the default (i.e. 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). The property name is escaped before writing. ]]> @@ -1264,7 +1264,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1303,7 +1303,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1337,7 +1337,7 @@ Writes the using the default using the default (i.e. 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). The property name is escaped before writing. ]]> @@ -1371,7 +1371,7 @@ Writes the using the default using the default (i.e. 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). The property name is escaped before writing. ]]> @@ -1405,7 +1405,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1439,7 +1439,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1473,7 +1473,7 @@ Writes the using the default using the default (i.e. 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). The property name is escaped before writing. ]]> @@ -1512,7 +1512,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1551,7 +1551,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1585,7 +1585,7 @@ Writes the using the default using the default (i.e. 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). The property name is escaped before writing. ]]> @@ -1619,7 +1619,7 @@ Writes the using the default using the default (i.e. 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). The property name is escaped before writing. ]]> @@ -1653,7 +1653,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1687,7 +1687,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1721,7 +1721,7 @@ Writes the using the default using the default (i.e. 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). The property name is escaped before writing. ]]> @@ -1760,7 +1760,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1799,7 +1799,7 @@ Writes the using the default using the default (i.e. 'G'), for example: 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. ]]> @@ -1836,7 +1836,7 @@ Writes the using the default using the default (i.e. 'G'). +Writes the using the default (that is, 'G'). The property name should already be escaped when the instance of was created. @@ -1875,7 +1875,7 @@ The property name should already be escaped when the instance of using the default (i.e. 'G'). +Writes the using the default (that is, 'G'). The property name should already be escaped when the instance of was created. @@ -1914,7 +1914,7 @@ The property name should already be escaped when the instance of using the default (i.e. 'G'), for example: 32767. +Writes the using the default (that is, 'G'); for example, 32767. The property name should already be escaped when the instance of was created. @@ -1953,7 +1953,7 @@ The property name should already be escaped when the instance of using the default (i.e. 'G'), for example: 32767. +Writes the using the default (this is, 'G'); for example, 32767. The property name should already be escaped when the instance of was created. @@ -1992,7 +1992,7 @@ The property name should already be escaped when the instance of using the default (i.e. 'G'). +Writes the using the default (that is, 'G'). The property name should already be escaped when the instance of was created. @@ -2036,7 +2036,7 @@ The property name should already be escaped when the instance of using the default (i.e. 'G'), for example: 32767. +Writes the using the default (that is, 'G'); for example, 32767. The property name should already be escaped when the instance of was created. @@ -2080,7 +2080,7 @@ The property name should already be escaped when the instance of using the default (i.e. 'G'), for example: 32767. +Writes the using the default (that is, 'G'); for example, 32767. The property name should already be escaped when the instance of was created. @@ -2723,7 +2723,7 @@ Writes the using the round-trippable ('O') using the round-trippable ('O') , for example: 2017-06-12T05:30:45.7680000-07:00. The property name is escaped before writing. +Writes the using the round-trippable ('O') ; for example, 2017-06-12T05:30:45.7680000-07:00. The property name is escaped before writing. ]]> @@ -2757,7 +2757,7 @@ Writes the using the round-trippable ('O') using the default (i.e. 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. The property name is escaped before writing. +Writes the using the default (that is, 'D'), in the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. The property name is escaped before writing. ]]> @@ -2933,7 +2933,7 @@ The property name is escaped before writing. using the round-trippable ('O') , for example: 2017-06-12T05:30:45.7680000. The property name is escaped before writing. +Writes the using the round-trippable ('O') ; for example, 2017-06-12T05:30:45.7680000. The property name is escaped before writing. ]]> @@ -2967,7 +2967,7 @@ Writes the using the round-trippable ('O') using the round-trippable ('O') , for example: 2017-06-12T05:30:45.7680000-07:00. The property name is escaped before writing. +Writes the using the round-trippable ('O') ; for example, 2017-06-12T05:30:45.7680000-07:00. The property name is escaped before writing. ]]> @@ -3001,7 +3001,7 @@ Writes the using the round-trippable ('O') using the default (i.e. 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. The property name is escaped before writing. +Writes the using the default (that is, 'D'), in the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. The property name is escaped before writing. ]]> @@ -3177,7 +3177,7 @@ The property name is escaped before writing. using the round-trippable ('O') , for example: 2017-06-12T05:30:45.7680000. The property name is escaped before writing. +Writes the using the round-trippable ('O') ; for example, 2017-06-12T05:30:45.7680000. The property name is escaped before writing. ]]> @@ -3211,7 +3211,7 @@ Writes the using the round-trippable ('O') using the round-trippable ('O') , for example: 2017-06-12T05:30:45.7680000-07:00. The property name is escaped before writing. +Writes the using the round-trippable ('O') ; for example, 2017-06-12T05:30:45.7680000-07:00. The property name is escaped before writing. ]]> @@ -3245,7 +3245,7 @@ Writes the using the round-trippable ('O') using the default (i.e. 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. The property name is escaped before writing. +Writes the using the default (that is, 'D'), in the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. The property name is escaped before writing. ]]> @@ -3424,7 +3424,7 @@ The property name is escaped before writing. ## Remarks -Writes the using the round-trippable ('O') , for example: 2017-06-12T05:30:45.7680000. +Writes the using the round-trippable ('O') ; for example, 2017-06-12T05:30:45.7680000. The property name should already be escaped when the instance of was created. @@ -3463,7 +3463,7 @@ The property name should already be escaped when the instance of using the round-trippable ('O') , for example: 2017-06-12T05:30:45.7680000-07:00. +Writes the using the round-trippable ('O') ; for example, 2017-06-12T05:30:45.7680000-07:00. The property name should already be escaped when the instance of was created. @@ -3502,7 +3502,7 @@ The property name should already be escaped when the instance of using the default (i.e. 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. +Writes the using the default (that is, 'D'), in the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. The property name should already be escaped when the instance of was created. From dddb50799651cd7da4a129ef941b833c0d821eee Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 17 Jul 2019 12:45:59 -0700 Subject: [PATCH 20/33] Fixed broken xref. --- .../JsonExtensionDataAttribute.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml index e4dcf93889f..53226172c95 100644 --- a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml @@ -52,7 +52,7 @@ If there is more than one extension property on a type, or it the property is no - Instantiates a new instance of the class. + Instantiates a new instance of the class. To be added. From 771baa41a5149ce706b3c99d6cd698683a5616fe Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 18 Jul 2019 10:50:47 -0700 Subject: [PATCH 21/33] suggestions by ahsonkhan Co-Authored-By: Ahson Khan --- xml/System.Text.Json.Serialization/JsonAttribute.xml | 2 +- .../JsonExtensionDataAttribute.xml | 4 ++-- xml/System.Text.Json/JsonTokenType.xml | 6 +++--- xml/System.Text.Json/Utf8JsonReader.xml | 12 ++++++------ 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/xml/System.Text.Json.Serialization/JsonAttribute.xml b/xml/System.Text.Json.Serialization/JsonAttribute.xml index 72f4c35ac9a..5df72d53a54 100644 --- a/xml/System.Text.Json.Serialization/JsonAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonAttribute.xml @@ -31,7 +31,7 @@ - Creates a new instance of the instance. + Creates a new instance of the . To be added. diff --git a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml index 53226172c95..aef1b014a25 100644 --- a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml @@ -19,7 +19,7 @@ - When placed on a property of type , provides that any properties that do not have a matching member are added to that dictionary during deserialization and written during serialization. + When placed on a property of type , any properties that do not have a matching member are added to that dictionary during deserialization and written during serialization. , a "null" JSON value is During serialization, the name of the extension data property is not included in the JSON; the data contained within the extension data is serialized as properties of the JSON object. -If there is more than one extension property on a type, or it the property is not of the correct type, an is thrown during the first serialization or deserialization of that type. +If there is more than one property on a type with this extension data attribute, or if the property itself is not of the correct type, an is thrown during the first serialization or deserialization of that type. ]]> diff --git a/xml/System.Text.Json/JsonTokenType.xml b/xml/System.Text.Json/JsonTokenType.xml index c4f2a659529..616d959f06d 100644 --- a/xml/System.Text.Json/JsonTokenType.xml +++ b/xml/System.Text.Json/JsonTokenType.xml @@ -34,7 +34,7 @@ 11 - The token type is the comment string. + The token type is a comment string. @@ -94,7 +94,7 @@ 9 - The token type is the JSON literal . + The token type is the JSON literal "false". @@ -145,7 +145,7 @@ This is the default token type if no data has been read by the 10 - The token type is the JSON literal . + The token type is the JSON literal "null". diff --git a/xml/System.Text.Json/Utf8JsonReader.xml b/xml/System.Text.Json/Utf8JsonReader.xml index c3327f2502a..db8d4fac263 100644 --- a/xml/System.Text.Json/Utf8JsonReader.xml +++ b/xml/System.Text.Json/Utf8JsonReader.xml @@ -273,9 +273,9 @@ The JSON string is incomplete; that is, the JSON string length is not a multiple Parses the current JSON token value from the source as a comment, transcoded it as a . - The comment that represnets the current JSON token value. + The comment that represents the current JSON token value. To be added. - The JSON token that is not a comment. + The JSON token is not a comment. @@ -667,8 +667,8 @@ For input data within a `ReadOnlySpan`, this always returns `false`. For i System.Boolean - Gets the mode of this instance of the . - if the reader was constructed with the input span containing the entire data to process. if the reader was constructed with an input span that may contain partial data with more data to follow. + Gets the mode of this instance of the which indicates whether all the JSON data was provided or there is more data to come. + if the reader was constructed with the input span or sequence containing the entire JSON data to process. if the reader was constructed with an input span or sequence that may contain partial JSON data with more data to follow. To be added. @@ -844,7 +844,7 @@ If the look up text is invalid or incomplete UTF-16 text (such as unpaired surro System.Int64 - Gets the index that the last processed JSON token within the given UTF-8 encoded input text starts at, skipping any white space. + Gets the index that the last processed JSON token starts at (within the given UTF-8 encoded input text), skipping any white space. The starting index of the last processed JSON token within the given UTF-8 encoded input text. @@ -901,7 +901,7 @@ For comments, this value points to before the first comment delimiter (that is, - When the method returns, a byte array that contains the base 64-encoded JSON string if the method succeeds. + If the method succeeds, a byte array that contains the base 64-encoded JSON string. Tries to parse the current JSON token value from the source and decodes the base 64 encoded JSON string as a byte array. if the entire token value is encoded as valid base 64 text and can be successfully decoded; otherwise. To be added. From 63f04f4dcd2b8e97e33418389532ae60071beda2 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 18 Jul 2019 22:00:47 -0700 Subject: [PATCH 22/33] suggestion by ahsonkhan for TryGetBytesFromBase64 --- xml/System.Text.Json/JsonElement.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index ec7909a1abd..4532458da03 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -752,7 +752,7 @@ For other types, the value of is - When the method returns, contains the byte representation of if the method succeeded. + If the method succeeds, contains the decoded binary representation of the base 64 text. Attempts to represent the current JSON string as a byte array, assuming that it is base 64-encoded. if the entire token value is encoded as valid base 64 text and can be successfully decoded to bytes. From 889eaf6a143be5ee1f7029c3dd64da90246d3a96 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 18 Jul 2019 22:03:04 -0700 Subject: [PATCH 23/33] suggestions by ahsonkhan and bartonjs Co-Authored-By: Jeremy Barton Co-Authored-By: Ahson Khan --- xml/System.Text.Json/JsonElement.xml | 2 +- xml/System.Text.Json/JsonReaderOptions.xml | 2 +- xml/System.Text.Json/Utf8JsonReader.xml | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index 4532458da03..a000be4eab1 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -763,7 +763,7 @@ For other types, the value of is ## Remarks -This method does not create a byte array representation of values other than bsae 64-encoded JSON strings. +This method does not create a byte array representation of values other than base 64-encoded JSON strings. ]]> diff --git a/xml/System.Text.Json/JsonReaderOptions.xml b/xml/System.Text.Json/JsonReaderOptions.xml index b3c1eaff389..70eae3b348e 100644 --- a/xml/System.Text.Json/JsonReaderOptions.xml +++ b/xml/System.Text.Json/JsonReaderOptions.xml @@ -95,7 +95,7 @@ By default, the reader throws a if i System.Int32 - Gets or sets the maximum depth allowed when reading JSON, with the default (i.e. 0) indicating a maximum depth of 64. + Gets or sets the maximum depth allowed when reading JSON, with the default (that is, 0) indicating a maximum depth of 64. The maximum depth allowed when reading JSON. diff --git a/xml/System.Text.Json/Utf8JsonReader.xml b/xml/System.Text.Json/Utf8JsonReader.xml index db8d4fac263..018f476459d 100644 --- a/xml/System.Text.Json/Utf8JsonReader.xml +++ b/xml/System.Text.Json/Utf8JsonReader.xml @@ -901,9 +901,9 @@ For comments, this value points to before the first comment delimiter (that is, - If the method succeeds, a byte array that contains the base 64-encoded JSON string. + If the method succeeds, contains the decoded binary representation of the base 64 text. Tries to parse the current JSON token value from the source and decodes the base 64 encoded JSON string as a byte array. - if the entire token value is encoded as valid base 64 text and can be successfully decoded; otherwise. + if the entire token value is encoded as valid base 64 text and can be successfully decoded to bytes; otherwise. To be added. The JSON token is not a . From 3afa1da7bb1719284707343b4ac61c55c44715d7 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 23 Jul 2019 12:27:46 -0700 Subject: [PATCH 24/33] Bold JSON literals --- xml/System.Text.Json/JsonTokenType.xml | 2 +- xml/System.Text.Json/Utf8JsonWriter.xml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Text.Json/JsonTokenType.xml b/xml/System.Text.Json/JsonTokenType.xml index 616d959f06d..8c749f5200c 100644 --- a/xml/System.Text.Json/JsonTokenType.xml +++ b/xml/System.Text.Json/JsonTokenType.xml @@ -94,7 +94,7 @@ 9 - The token type is the JSON literal "false". + The token type is the JSON literal false. diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index a5a56e2520a..7580e0aa59c 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -720,8 +720,8 @@ The property name is escaped before writing. The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON literal "true" or "false" as part of the name/value pair. - Writes the pre-encoded property name and value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. + The value to be written as a JSON literal true or false as part of the name/value pair. + Writes the pre-encoded property name and value (as a JSON literal true or false) as part of a name/value pair of a JSON object. Date: Tue, 23 Jul 2019 12:32:24 -0700 Subject: [PATCH 25/33] smaller exception for Utf8JsonReader.GetBytesFromBase64 --- xml/System.Text.Json/Utf8JsonReader.xml | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/xml/System.Text.Json/Utf8JsonReader.xml b/xml/System.Text.Json/Utf8JsonReader.xml index 018f476459d..9e4c8545315 100644 --- a/xml/System.Text.Json/Utf8JsonReader.xml +++ b/xml/System.Text.Json/Utf8JsonReader.xml @@ -244,15 +244,7 @@ in more data asynchronously before continuing with a new instance of the The byte array that represents the current JSON token value. To be added. The type of the JSON token is not a . - The JSON string contains data outside of the expected base 64 range. - -- or - - -The JSON string contains invalid padding characters or more than two padding characters. - -- or - - -The JSON string is incomplete; that is, the JSON string length is not a multiple of 4. + The value is not encoded as base 64 text and hence cannot be decoded to bytes. From e9bc3e9a0c98cf78f1f2e35e328b7961bf47c482 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 25 Jul 2019 11:05:25 -0700 Subject: [PATCH 26/33] suggestions by ahsonkhan Co-Authored-By: Ahson Khan --- xml/System.Text.Json/JsonTokenType.xml | 4 +- xml/System.Text.Json/Utf8JsonWriter.xml | 96 ++++++++++++++++++------- 2 files changed, 71 insertions(+), 29 deletions(-) diff --git a/xml/System.Text.Json/JsonTokenType.xml b/xml/System.Text.Json/JsonTokenType.xml index 94a41c8252a..324dae20838 100644 --- a/xml/System.Text.Json/JsonTokenType.xml +++ b/xml/System.Text.Json/JsonTokenType.xml @@ -145,7 +145,7 @@ This is the default token type if no data has been read by the 11 - The token type is the JSON literal "null". + The token type is the JSON literal null. @@ -265,7 +265,7 @@ This is the default token type if no data has been read by the 9 - The token type is the JSON literal . + The token type is the JSON literal true. diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index 9b18fdf2370..2e9812e8ac9 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -429,7 +429,7 @@ The will continue to use the original wri - The UTF-8 encoded property name of the JSON object to be written. + The UTF-8 encoded name of the property to write. The binary data to be written as a base 64 encoded JSON string as part of the name/value pair. Writes the property name and raw bytes value (as a base 64 encoded JSON string) as part of a name/value pair of a JSON object. @@ -544,7 +544,7 @@ The property name is escaped before writing. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The JSON-encoded name of the property to write. The binary data to be written as a base 64 encoded JSON string as part of the name/value pair. Writes the pre-encoded property name and raw bytes value (as a base 64 encoded JSON string) as part of a name/value pair of a JSON object. @@ -793,7 +793,7 @@ The comment value is not escaped before writing. -or- - contains a comment delimiter (such as */). + contains a comment delimiter (that is, */). @@ -828,7 +828,7 @@ The comment value is not escaped before writing. -or- - contains a comment delimiter (such as */). + contains a comment delimiter (that is, */). @@ -863,7 +863,7 @@ The comment value is not escaped before writing. -or- - contains a comment delimiter (such as */). + contains a comment delimiter (that is, */). @@ -1026,7 +1026,7 @@ The property name is escaped before writing. The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - Writes the pre-encoded property name and the JSON literal "null" as part of a name/value pair of a JSON object. + Writes the pre-encoded property name and the JSON literal null as part of a name/value pair of a JSON object. using the default (that is, 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). + +The property name is escaped before writing. ]]> @@ -1123,7 +1125,9 @@ Writes the using the default using the default (that is, 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). + +The property name is escaped before writing. ]]> @@ -1157,7 +1161,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> @@ -1191,7 +1197,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> @@ -1225,7 +1233,9 @@ Writes the using the default using the default (that is, 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). + +The property name is escaped before writing. ]]> @@ -1264,7 +1274,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> @@ -1303,7 +1315,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> @@ -1337,7 +1351,9 @@ Writes the using the default using the default (that is, 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). + +The property name is escaped before writing. ]]> @@ -1371,7 +1387,9 @@ Writes the using the default using the default (that is, 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). + +The property name is escaped before writing. ]]> @@ -1405,7 +1423,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> @@ -1439,7 +1459,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> @@ -1473,7 +1495,9 @@ Writes the using the default using the default (that is, 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). + +The property name is escaped before writing. ]]> @@ -1512,7 +1536,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> @@ -1551,7 +1577,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> @@ -1585,7 +1613,9 @@ Writes the using the default using the default (that is, 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). + +The property name is escaped before writing. ]]> @@ -1619,7 +1649,9 @@ Writes the using the default using the default (that is, 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). + +The property name is escaped before writing. ]]> @@ -1653,7 +1685,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> @@ -1687,7 +1721,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> @@ -1721,7 +1757,9 @@ Writes the using the default using the default (that is, 'G'). The property name is escaped before writing. +Writes the using the default (that is, 'G'). + +The property name is escaped before writing. ]]> @@ -1760,7 +1798,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> @@ -1799,7 +1839,9 @@ Writes the using the default using the default (that is, 'G'); for example, 32767. The property name is escaped before writing. +Writes the using the default (that is, 'G'); for example, 32767. + +The property name is escaped before writing. ]]> From 5e9331669f18ad337bfed9cbabb332ee9afc3704 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 25 Jul 2019 11:10:42 -0700 Subject: [PATCH 27/33] JSON literal null for WriteNullValue --- xml/System.Text.Json/Utf8JsonWriter.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index 2e9812e8ac9..081960d89d0 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -1058,7 +1058,7 @@ The property name should already be escaped when the instance of - Writes the JSON literal "null" as an element of a JSON array. + Writes the JSON literal null as an element of a JSON array. To be added. Validation is enabled, and the operation would result in writing invalid JSON. From 498fa68944d021693d03c80a3f9e54f4ba9ec6ce Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Fri, 26 Jul 2019 10:58:33 -0700 Subject: [PATCH 28/33] Changed type name --- .../JsonExtensionDataAttribute.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml index aef1b014a25..ba56dd32ab4 100644 --- a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml @@ -28,7 +28,7 @@ The dictionary's `TKey` value must be , and `TValue` must be or . -During deserialization, when using , a "null" JSON value is treated as a `null` object reference, and when using , a "null" is treated as a JsonElement with set to . +During deserialization, when using , a "null" JSON value is treated as a `null` object reference, and when using , a "null" is treated as a JsonElement with set to . During serialization, the name of the extension data property is not included in the JSON; the data contained within the extension data is serialized as properties of the JSON object. From 7daf66c22a5e420151373b71d1d36d4456173b14 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Fri, 26 Jul 2019 11:01:41 -0700 Subject: [PATCH 29/33] Corrected enum type name --- xml/System.Text.Json/JsonElement.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index f142aca7de0..6e7d7388b81 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -205,7 +205,7 @@ This method does not create a byte representation of values other than base 64-e ]]> - This value's is not . + This value's is not . The value is not encoded as base 64 text and hence cannot be decoded to bytes. The parent has been disposed. @@ -789,7 +789,7 @@ This method does not parse the contents of a JSON string value. Gets the value at a specified index when the current value is an . To be added. To be added. - This value's is not . + This value's is not . is not in the range [0, ()). The parent has been disposed. @@ -891,7 +891,7 @@ This method does not create a byte array representation of values other than bas ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -1270,7 +1270,7 @@ If a property is defined multiple times for the same object, the method matches ]]> - This value's is not . + This value's is not . is . The parent has been disposed. From b15ff4e381916198f8eeef3da5bef5624a4c01cd Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Fri, 26 Jul 2019 11:08:07 -0700 Subject: [PATCH 30/33] Fixed bad cref --- .../JsonPropertyNameAttribute.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml b/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml index dffc2024599..581e9a5a1f9 100644 --- a/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml @@ -19,7 +19,7 @@ - Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by . + Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by . To be added. From d1f8a14763dc49061c0c704314f1f5692b6aa269 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 29 Jul 2019 09:44:56 -0700 Subject: [PATCH 31/33] JSON literals --- xml/System.Text.Json/Utf8JsonWriter.xml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index 081960d89d0..356c6b3465a 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -618,8 +618,8 @@ The bytes are encoded before writing. The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON literal "true" or "false" as part of the name/value pair. - Writes a property name specified as a read-only span of bytes and a value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. + The value to be written as a JSON literal true or false as part of the name/value pair. + Writes a property name specified as a read-only span of bytes and a value (as a JSON literal true or false) as part of a name/value pair of a JSON object. The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON literal "true" or "false" as part of the name/value pair. - Writes a property name specified as a read-only character span and a value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. + The value to be written as a JSON literal true or false as part of the name/value pair. + Writes a property name specified as a read-only character span and a value (as a JSON literal true or false) as part of a name/value pair of a JSON object. The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON literal "true" or "false" as part of the name/value pair. - Writes a property name specified as a string and a value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. + The value to be written as a JSON literal true or false as part of the name/value pair. + Writes a property name specified as a string and a value (as a JSON literal true or false) as part of a name/value pair of a JSON object. - The value to be written as a JSON literal "true" or "false" as an element of a JSON array. - Writes a value (as a JSON literal "true" or "false") as an element of a JSON array. + The value to be written as a JSON literal true or false as an element of a JSON array. + Writes a value (as a JSON literal true or false) as an element of a JSON array. To be added. Validation is enabled, and the operation would result in writing invalid JSON. @@ -930,7 +930,7 @@ The comment value is not escaped before writing. The UTF-8 encoded property name of the JSON object to be written. - Writes a property name specified as a read-only span of bytes and the JSON literal "null" as part of a name/value pair of a JSON object. + Writes a property name specified as a read-only span of bytes and the JSON literal null as part of a name/value pair of a JSON object. The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - Writes a property name specified as a read-only character span and the JSON literal "null" as part of a name/value pair of a JSON object. + Writes a property name specified as a read-only character span and the JSON literal null as part of a name/value pair of a JSON object. The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - Writes a property name specified as a string and the JSON literal "null" as part of a name/value pair of a JSON object. + Writes a property name specified as a string and the JSON literal null as part of a name/value pair of a JSON object. Date: Mon, 29 Jul 2019 11:53:58 -0700 Subject: [PATCH 32/33] Fixed broken links --- xml/System.Text.Json/JsonElement.xml | 68 ++++++++++++++-------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index 6e7d7388b81..37874bc0eac 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -71,7 +71,7 @@ If this JsonElement is itself the output of a previous call to `Clone` or a valu Gets an enumerator to enumerate the values in the JSON array represented by this JsonElement. An enumerator to enumerate the values in the JSON array represented by this JsonElement. To be added. - This value's is not . + This value's is not . The parent has been disposed. @@ -95,7 +95,7 @@ If this JsonElement is itself the output of a previous call to `Clone` or a valu Gets an enumerator to enumerate the properties in the JSON object represented by this JsonElement. An enumerator to enumerate the properties in the JSON object represented by this JsonElement. To be added. - This value's is not . + This value's is not . The parent has been disposed. @@ -119,7 +119,7 @@ If this JsonElement is itself the output of a previous call to `Clone` or a valu Gets the number of values contained within the current array value. The number of values contained within the current array value. To be added. - This value's is not . + This value's is not . The parent has been disposed. @@ -149,7 +149,7 @@ This method does not parse the contents of a JSON string value. ]]> - This value's is neither nor . + This value's is neither nor . The parent has been disposed. @@ -205,7 +205,7 @@ This method does not create a byte representation of values other than base 64-e ]]> - This value's is not . + This value's is not . The value is not encoded as base 64 text and hence cannot be decoded to bytes. The parent has been disposed. @@ -236,7 +236,7 @@ This method does not create a DateTime representation of values other than JSON ]]> - This value's is not . + This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -267,7 +267,7 @@ This method does not create a DateTimeOffset representation of values other than ]]> - This value's is not . + This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -298,7 +298,7 @@ This method does not create a DateTimeOffset representation of values other than ]]> - This value's is not . + This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -331,7 +331,7 @@ On .NET Core, this method returns - This value's is not . + This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -362,7 +362,7 @@ This method does not create a Guid representation of values other than JSON stri ]]> - This value's is not . + This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -409,7 +409,7 @@ This method does not create a Guid representation of values other than JSON stri Gets the current JSON number as an . The current JSON number as an . To be added. - This value's is not . + This value's is not . The value cannot be represented as an . The parent has been disposed. @@ -440,7 +440,7 @@ This method does not parse the contents of a JSON string value. ]]> - This value's is not . + This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -476,7 +476,7 @@ If a property is defined multiple times for the same object, the method matches ]]> - This value's is not . + This value's is not . No property was found with the requested name. The parent has been disposed. @@ -512,7 +512,7 @@ If a property is defined multiple times for the same object, the method matches ]]> - This value's is not . + This value's is not . No property was found with the requested name. The parent has been disposed. @@ -548,7 +548,7 @@ If a property is defined multiple times for the same object, the method matches ]]> - This value's is not . + This value's is not . No property was found with the requested name. is . The parent has been disposed. @@ -632,7 +632,7 @@ On .NET Core, this method returns - This value's is not . + This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -663,7 +663,7 @@ This method does not create a string representation of values other than JSON st ]]> - This value's is neither nor . + This value's is neither nor . The parent has been disposed. @@ -725,7 +725,7 @@ This method does not parse the contents of a JSON string value. ]]> - This value's is not . + This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -761,7 +761,7 @@ This method does not parse the contents of a JSON string value. ]]> - This value's is not . + This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -789,7 +789,7 @@ This method does not parse the contents of a JSON string value. Gets the value at a specified index when the current value is an . To be added. To be added. - This value's is not . + This value's is not . is not in the range [0, ()). The parent has been disposed. @@ -891,7 +891,7 @@ This method does not create a byte array representation of values other than bas ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -925,7 +925,7 @@ This method does not create a DateTime representation of values other than JSON ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -959,7 +959,7 @@ This method does not create a DateTimeOffset representation of values other than ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -993,7 +993,7 @@ This method does not parse the contents of a JSON string value. ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -1029,7 +1029,7 @@ On .NET Core, this method does not return `false` for values larger than - This value's is not . + This value's is not . The parent has been disposed. @@ -1063,7 +1063,7 @@ This method does not create a Guid representation of values other than JSON stri ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -1122,7 +1122,7 @@ This method does not parse the contents of a JSON string value. ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -1156,7 +1156,7 @@ This method does not parse the contents of a JSON string value. ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -1194,7 +1194,7 @@ If a property is defined multiple times for the same object, the method matches ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -1232,7 +1232,7 @@ If a property is defined multiple times for the same object, the method matches ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -1270,7 +1270,7 @@ If a property is defined multiple times for the same object, the method matches ]]> - This value's is not . + This value's is not . is . The parent has been disposed. @@ -1337,7 +1337,7 @@ On .NET Core, this method does not return `false` for values larger than - This value's is not . + This value's is not . The parent has been disposed. @@ -1406,7 +1406,7 @@ This method does not parse the contents of a JSON string value. ]]> - This value's is not . + This value's is not . The parent has been disposed. @@ -1445,7 +1445,7 @@ This method does not parse the contents of a JSON string value. ]]> - This value's is not . + This value's is not . The parent has been disposed. From 89210bacffe14166eafe852c7124018d19546dc4 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Mon, 29 Jul 2019 11:55:05 -0700 Subject: [PATCH 33/33] Fixed broken link --- .../JsonExtensionDataAttribute.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml index ba56dd32ab4..9243ce481c7 100644 --- a/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml +++ b/xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml @@ -28,7 +28,7 @@ The dictionary's `TKey` value must be , and `TValue` must be or . -During deserialization, when using , a "null" JSON value is treated as a `null` object reference, and when using , a "null" is treated as a JsonElement with set to . +During deserialization, when using , a "null" JSON value is treated as a `null` object reference, and when using , a "null" is treated as a JsonElement with set to . During serialization, the name of the extension data property is not included in the JSON; the data contained within the extension data is serialized as properties of the JSON object.