diff --git a/xml/System.Text.Json/JsonReaderOptions.xml b/xml/System.Text.Json/JsonReaderOptions.xml index 85331b25ae7..a7eef078c88 100644 --- a/xml/System.Text.Json/JsonReaderOptions.xml +++ b/xml/System.Text.Json/JsonReaderOptions.xml @@ -116,7 +116,7 @@ By default, the reader throws a if it enco ## Remarks -Reading past this depth will throw a to use the default encoder. - The JavaScript character encoding. + The JavaScript character encoder used to override the escaping behavior. To be added. diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index bd6afc530b6..1db217ffd86 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -30,9 +30,9 @@ `Utf8JsonWriter` writes the text sequentially with no caching and by default adheres to the [JSON RFC](https://tools.ietf.org/html/rfc8259), with the exception of writing comments. -A method that attempts to write invalid JSON when validation is enabled throws a with a context-specific error message. +A method that attempts to write invalid JSON when validation is enabled throws an with a context-specific error message. -To be able to format the output with indentation and white space OR to skip validation, create an instance of and pass it in to the writer. +To be able to format the output with indentation and white space, to skip validation, OR to customize the escaping behavior, create an instance of and pass it in to the writer. ]]> @@ -55,8 +55,8 @@ To be able to format the output with indentation and white space OR to skip vali The destination for writing 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 . + Defines the customized behavior of the . By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC. + Initializes a new instance of the class using the specified to write the output to and customization options. To be added. is . @@ -79,8 +79,8 @@ To be able to format the output with indentation and white space OR to skip vali The destination for writing 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 . + Defines the customized behavior of the . By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC. + Initializes a new instance of the class using the specified stream to write the output to and customization options. To be added. is . @@ -322,8 +322,8 @@ In the case of , this writes the data to the stream and f System.Text.Json.JsonWriterOptions - Gets the custom behavior when writing JSON using this instance, which indicates whether to format the output while writing and whether to skip structural JSON validation. - An object that defines the behavior of this instance for formatting and validation. + Gets the custom behavior when writing JSON using this instance, which indicates whether to format the output while writing, whether to skip structural JSON validation, and which characters to escape. + The custom behavior of this instance of the writer for formatting, validating, and escaping. To be added. @@ -383,7 +383,7 @@ The will continue to use the original wri ## Remarks -The will continue to use the original writer options but now writes to `bufferWriter` as the new destination. +The will continue to use the original writer options but now write to `bufferWriter` as the new destination. ]]> @@ -806,7 +806,7 @@ The property name should already be escaped when the instance of - The UTF-8 encoded value to be written as a JSON comment within /*..*/. + The UTF-8 encoded value to be written as a JSON comment within `/*..*/`. Writes a UTF-8 text value as a JSON comment. contains a comment delimiter (that is, */). + contains a comment delimiter (that is, `*/`). @@ -843,7 +843,7 @@ The comment value is not escaped before writing. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within `/*..*/`. Writes a UTF-16 text value as a JSON comment. - The specified value is too large OR. + The specified value is too large. -or- - contains a comment delimiter (that is, */). + contains a comment delimiter (that is, `*/`). @@ -880,7 +880,7 @@ The comment value is not escaped before writing. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within `/*..*/`. Writes a string text value as a JSON comment. contains a comment delimiter (that is, */). + contains a comment delimiter (that is, `*/`). The parameter is . @@ -1167,7 +1167,7 @@ The property name is escaped before writing. ## Remarks -Writes the using the default (that is, 'G'). +Writes the using the default (that is, 'G') on .NET Core 3.0 or later versions. Uses 'G17' on any other framework. The property name is escaped before writing. @@ -1281,7 +1281,7 @@ The property name is escaped before writing. ## Remarks -Writes the using the default (that is, 'G'). +Writes the using the default (that is, 'G') on .NET Core 3.0 or later versions. Uses 'G9' on any other framework. The property name is escaped before writing. @@ -1443,7 +1443,7 @@ The property name is escaped before writing. ## Remarks -Writes the using the default (that is, 'G'). +Writes the using the default (that is, 'G') on .NET Core 3.0 or later versions. Uses 'G17' on any other framework. The property name is escaped before writing. @@ -1557,7 +1557,7 @@ The property name is escaped before writing. ## Remarks -Writes the using the default (that is, 'G'). +Writes the using the default (that is, 'G') on .NET Core 3.0 or later versions. Uses 'G9' on any other framework. The property name is escaped before writing. @@ -1720,7 +1720,7 @@ The property name is escaped before writing. ## Remarks -Writes the using the default (that is, 'G'). +Writes the using the default (that is, 'G') on .NET Core 3.0 or later versions. Uses 'G17' on any other framework. The property name is escaped before writing. @@ -1837,7 +1837,7 @@ The property name is escaped before writing. ## Remarks -Writes the using the default (that is, 'G'). +Writes the using the default (that is, 'G') on .NET Core 3.0 or later versions. Uses 'G9' on any other framework. The property name is escaped before writing. @@ -2001,7 +2001,7 @@ The property name should already be escaped when the instance of using the default (that is, 'G'). +Writes the using the default (that is, 'G') on .NET Core 3.0 or later versions. Uses 'G17' on any other framework. The property name should already be escaped when the instance of was created. @@ -2112,7 +2112,7 @@ The property name should already be escaped when the instance of using the default (that is, 'G'). +Writes the using the default (that is, 'G') on .NET Core 3.0 or later versions. Uses 'G9' on any other framework. The property name should already be escaped when the instance of was created. @@ -2264,7 +2264,7 @@ This method writes the value using the default value using the default (that is, 'G'). +This method writes the value using the default (that is, 'G') on .NET Core 3.0 or later versions. Uses 'G17' on any other framework. ]]> @@ -2363,7 +2363,7 @@ This method writes the value using the default value using the default (that is, 'G'). +This method writes the value using the default (that is, 'G') on .NET Core 3.0 or later versions. Uses 'G9' on any other framework. ]]> @@ -2756,7 +2756,7 @@ The property name should already be escaped when the instance of The depth of the JSON has exceeded the maximum depth of 1000. -- or - +-or- Validation is enabled, and this method would result in writing invalid JSON. @@ -2934,7 +2934,7 @@ The property name should already be escaped when the instance of The depth of the JSON has exceeded the maximum depth of 1000. -- or - +-or- Validation is enabled, and this method would result in writing invalid JSON. @@ -3155,6 +3155,8 @@ The property name and value are escaped before writing. The property name and value are escaped before writing. +If `value` is `null`, the JSON **null** value is written, as if the method was called. + ]]> The specified property name or value is too large. @@ -3415,6 +3417,8 @@ The property name and value are escaped before writing. The property name and value are escaped before writing. +If `value` is `null`, the JSON **null** value is written, as if the method was called. + ]]> The specified property name or value is too large. @@ -3680,6 +3684,8 @@ The property name and value are escaped before writing. The property name and value are escaped before writing. +If `value` is `null`, the JSON **null** value is written, as if the method was called. + ]]> The specified property name or value is too large. @@ -3909,6 +3915,8 @@ The property name should already be escaped when the instance of method was called. + ]]> The specified value is too large. @@ -3947,6 +3955,8 @@ The property name should already be escaped when the instance of method was called. + ]]> The specified value is too large. @@ -4185,6 +4195,8 @@ The value is escaped before writing. The value is escaped before writing. +If `value` is `null`, the JSON **null** value is written, as if the method was called. + ]]> The specified value is too large.