From f7e02815e69cbfa88f6315c935b72723083969f1 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez Date: Wed, 24 Apr 2019 15:40:52 -0700 Subject: [PATCH 1/7] Port System.Text.Json source comments to Docs --- xml/System.Text.Json/JsonDocument.xml | 64 +++--- .../JsonElement+ArrayEnumerator.xml | 4 +- .../JsonElement+ObjectEnumerator.xml | 4 +- xml/System.Text.Json/JsonElement.xml | 214 ++++++++++++------ xml/System.Text.Json/JsonProperty.xml | 8 +- xml/System.Text.Json/JsonValueType.xml | 16 +- 6 files changed, 196 insertions(+), 114 deletions(-) diff --git a/xml/System.Text.Json/JsonDocument.xml b/xml/System.Text.Json/JsonDocument.xml index 5ea018b57e2..a5fb8fe3007 100644 --- a/xml/System.Text.Json/JsonDocument.xml +++ b/xml/System.Text.Json/JsonDocument.xml @@ -65,11 +65,13 @@ - To be added. - To be added. - To be added. - To be added. + JSON text to parse. + Options to control the reader behavior during parsing. + Parse a sequence as UTF-8-encoded text representing a single JSON value into a JsonDocument. + A JsonDocument representation of the JSON value. To be added. + does not represent a valid single JSON value. + contains unsupported options. @@ -91,11 +93,13 @@ - To be added. - To be added. - To be added. - To be added. + JSON data to parse. + Options to control the reader behavior during parsing. + Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be read to completion. + A JsonDocument representation of the JSON value. To be added. + does not represent a valid single JSON value. + contains unsupported options. @@ -117,11 +121,13 @@ - To be added. - To be added. - To be added. - To be added. + JSON text to parse. + Options to control the reader behavior during parsing. + Parse memory as UTF-8-encoded text representing a single JSON value into a JsonDocument. + A JsonDocument representation of the JSON value. To be added. + does not represent a valid single JSON value. + contains unsupported options. @@ -143,11 +149,13 @@ - To be added. - To be added. - To be added. - To be added. + JSON text to parse. + Options to control the reader behavior during parsing. + Parse text representing a single JSON value into a JsonDocument. + A JsonDocument representation of the JSON value. To be added. + does not represent a valid single JSON value. + contains unsupported options. @@ -169,11 +177,13 @@ - To be added. - To be added. - To be added. - To be added. + JSON text to parse. + Options to control the reader behavior during parsing. + Parse text representing a single JSON value into a JsonDocument. + A JsonDocument representation of the JSON value. To be added. + does not represent a valid single JSON value. + contains unsupported options. @@ -195,12 +205,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + JSON data to parse. + Options to control the reader behavior during parsing. + The token to monitor for cancellation requests. + Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be read to completion. + A Task to produce a JsonDocument representation of the JSON value. To be added. + does not represent a valid single JSON value. + contains unsupported options. @@ -219,7 +231,7 @@ System.Text.Json.JsonElement - To be added. + The representing the value of the document. To be added. To be added. diff --git a/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml b/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml index f015c89940a..59cef518e5e 100644 --- a/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml +++ b/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml @@ -99,8 +99,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through a collection. + An value that can be used to iterate through the array. To be added. diff --git a/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml b/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml index d82d3ce52b3..7365d9d8745 100644 --- a/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml +++ b/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml @@ -99,8 +99,8 @@ - To be added. - To be added. + Returns an enumerator that iterates the properties of an object. + An value that can be used to iterate through the object. To be added. diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index ef5e5083635..9d3269a5cb9 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -40,9 +40,11 @@ - To be added. - To be added. + Get 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 . + The parent has been disposed. @@ -62,9 +64,11 @@ - To be added. - To be added. + Get 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 . + The parent has been disposed. @@ -84,9 +88,11 @@ - To be added. - To be added. + Get 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 . + The parent has been disposed. @@ -106,9 +112,11 @@ - To be added. - To be added. + Gets the value of the element as a . + The value of the element as a . To be added. + This value's is neither or . + The parent has been disposed. @@ -128,9 +136,12 @@ - To be added. - To be added. + Gets the current JSON number as a . + The current JSON number as a . To be added. + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -150,9 +161,12 @@ - To be added. - To be added. + Gets the current JSON number as a . + The current JSON number as a . To be added. + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -172,9 +186,12 @@ - To be added. - To be added. + Gets the current JSON number as an . + The current JSON number as an . To be added. + This value's is not . + The value cannot be represented as an . + The parent has been disposed. @@ -194,9 +211,12 @@ - To be added. - To be added. + Gets the current JSON number as a . + The current JSON number as a . To be added. + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -218,10 +238,13 @@ - To be added. - To be added. - To be added. + The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. + Gets a representing the value of a required property identified by . + A representing the value of the requested property. To be added. + This value's is not . + No property was found with the requested name. + The parent has been disposed. @@ -243,10 +266,13 @@ - To be added. - To be added. - To be added. + Name of the property whose value to return. + Gets a representing the value of a required property identified by . + A representing the value of the requested property. To be added. + This value's is not . + No property was found with the requested name. + The parent has been disposed. @@ -268,10 +294,15 @@ - To be added. - To be added. - To be added. + Name of the property whose value to return. + Gets a representing the value of a required property identified + by . + A representing the value of the requested property. To be added. + This value's is not . + No property was found with the requested name. + is . + The parent has been disposed. @@ -291,9 +322,10 @@ - To be added. - To be added. + Gets the original input data backing this value, returning it as a . + The original input data backing this value, returning it as a . To be added. + The parent has been disposed. @@ -313,9 +345,12 @@ - To be added. - To be added. + Gets the current JSON number as a . + The current JSON number as a . To be added. + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -335,9 +370,11 @@ - To be added. - To be added. + Gets the value of the element as a . + The value of the element as a . To be added. + This value's is neither nor . + The parent has been disposed. @@ -362,9 +399,12 @@ - To be added. - To be added. + Gets the current JSON number as a . + The current JSON number as a . To be added. + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -389,9 +429,12 @@ - To be added. - To be added. + Gets the current JSON number as a . + The current JSON number as a . To be added. + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -414,9 +457,13 @@ To be added. - To be added. + Get the value at a specified index when the current value is a + . To be added. To be added. + This value's is not . + is not in the range [0, ()). + The parent has been disposed. @@ -436,9 +483,10 @@ - To be added. - To be added. + Gets a string representation for the current value appropriate to the value type. + A string representation for the current value appropriate to the value type. To be added. + The parent has been disposed. @@ -460,10 +508,12 @@ - To be added. - To be added. - To be added. + Receives the value. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. To be added. + This value's is not . + The parent has been disposed. @@ -485,10 +535,12 @@ - To be added. - To be added. - To be added. + Receives the value. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. To be added. + This value's is not . + The parent has been disposed. @@ -510,10 +562,12 @@ - To be added. - To be added. - To be added. + Receives the value. + Attempts to represent the current JSON number as an . + if the number can be represented as an , otherwise. To be added. + This value's is not . + The parent has been disposed. @@ -535,10 +589,12 @@ - To be added. - To be added. - To be added. + Receives the value. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. To be added. + This value's is not . + The parent has been disposed. @@ -561,11 +617,13 @@ - To be added. - To be added. - To be added. - To be added. + The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. + Receives the value of the located property. + Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. + if the property was found, otherwise. To be added. + This value's is not . + The parent has been disposed. @@ -588,11 +646,13 @@ - To be added. - To be added. - To be added. - To be added. + Name of the property to find. + Receives the value of the located property. + Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. + if the property was found, otherwise. To be added. + This value's is not . + The parent has been disposed. @@ -615,11 +675,14 @@ - To be added. - To be added. - To be added. - To be added. + Name of the property to find. + Receives the value of the located property. + Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. + if the property was found, otherwise. To be added. + This value's is not . + is . + The parent has been disposed. @@ -641,10 +704,12 @@ - To be added. - To be added. - To be added. + Receives the value. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. To be added. + This value's is not . + The parent has been disposed. @@ -671,10 +736,12 @@ - To be added. - To be added. - To be added. + Receives the value. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. To be added. + This value's is not . + The parent has been disposed. @@ -701,10 +768,12 @@ - To be added. - To be added. - To be added. + Receives the value. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. To be added. + This value's is not . + The parent has been disposed. @@ -723,9 +792,10 @@ System.Text.Json.JsonValueType - To be added. + The that the value is. To be added. To be added. + The parent has been disposed. diff --git a/xml/System.Text.Json/JsonProperty.xml b/xml/System.Text.Json/JsonProperty.xml index 0459c8e2aac..36bcac1a7f3 100644 --- a/xml/System.Text.Json/JsonProperty.xml +++ b/xml/System.Text.Json/JsonProperty.xml @@ -39,7 +39,7 @@ System.String - To be added. + The name of this property. To be added. To be added. @@ -61,8 +61,8 @@ - To be added. - To be added. + Provides a representation of the property for debugging purposes. + A string containing the un-interpreted value of the property, beginning at the declaring open-quote and ending at the last character that is part of the value. To be added. @@ -82,7 +82,7 @@ System.Text.Json.JsonElement - To be added. + The value of this property. To be added. To be added. diff --git a/xml/System.Text.Json/JsonValueType.xml b/xml/System.Text.Json/JsonValueType.xml index ea4a6dec396..83ba8d4abb3 100644 --- a/xml/System.Text.Json/JsonValueType.xml +++ b/xml/System.Text.Json/JsonValueType.xml @@ -34,7 +34,7 @@ 2 - To be added. + Indicates that a value is a JSON array. @@ -54,7 +54,7 @@ 6 - To be added. + Indicates that a value is the JSON value . @@ -74,7 +74,7 @@ 7 - To be added. + Indicates that a value is the JSON value . @@ -94,7 +94,7 @@ 4 - To be added. + Indicates that a value is a JSON number. @@ -114,7 +114,7 @@ 1 - To be added. + Indicates that a value is a JSON object. @@ -134,7 +134,7 @@ 3 - To be added. + Indicates that a value is a JSON string. @@ -154,7 +154,7 @@ 5 - To be added. + Indicates that a value is the JSON value . @@ -174,7 +174,7 @@ 0 - To be added. + Indicates that there is no value (as distinct from ). From 278fb4eb51b0e336f4a774760ba3ac0ba0ee3669 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 25 Apr 2019 08:12:21 -0700 Subject: [PATCH 2/7] Apply suggestions from code review Removing extra spaces, thanks ahsonkhan. Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Text.Json/JsonDocument.xml | 6 +++--- xml/System.Text.Json/JsonElement.xml | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/xml/System.Text.Json/JsonDocument.xml b/xml/System.Text.Json/JsonDocument.xml index a5fb8fe3007..a6ceab8ffee 100644 --- a/xml/System.Text.Json/JsonDocument.xml +++ b/xml/System.Text.Json/JsonDocument.xml @@ -95,7 +95,7 @@ JSON data to parse. Options to control the reader behavior during parsing. - Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be read to completion. + Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be read to completion. A JsonDocument representation of the JSON value. To be added. does not represent a valid single JSON value. @@ -208,7 +208,7 @@ JSON data to parse. Options to control the reader behavior during parsing. The token to monitor for cancellation requests. - Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be read to completion. + Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be read to completion. A Task to produce a JsonDocument representation of the JSON value. To be added. does not represent a valid single JSON value. @@ -237,4 +237,4 @@ - \ No newline at end of file + diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index 9d3269a5cb9..4874a3144bf 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -680,7 +680,7 @@ Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. if the property was found, otherwise. To be added. - This value's is not . + This value's is not . is . The parent has been disposed. @@ -708,7 +708,7 @@ Attempts to represent the current JSON number as a . if the number can be represented as a , otherwise. To be added. - This value's is not . + This value's is not . The parent has been disposed. @@ -799,4 +799,4 @@ - \ No newline at end of file + From de476f89e65a654e6cfd0a705f9bc3b05f29b63a Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez Date: Thu, 25 Apr 2019 11:11:26 -0700 Subject: [PATCH 3/7] Adding missing remarks and some more exceptions. --- xml/System.Text.Json/JsonDocument.xml | 8 +- .../JsonElement+ObjectEnumerator.xml | 2 +- xml/System.Text.Json/JsonElement.xml | 89 ++- xml/System.Text.Json/Utf8JsonWriter.xml | 615 ++++++------------ 4 files changed, 253 insertions(+), 461 deletions(-) diff --git a/xml/System.Text.Json/JsonDocument.xml b/xml/System.Text.Json/JsonDocument.xml index a5fb8fe3007..e9bb57d2c7c 100644 --- a/xml/System.Text.Json/JsonDocument.xml +++ b/xml/System.Text.Json/JsonDocument.xml @@ -69,7 +69,8 @@ Options to control the reader behavior during parsing. Parse a sequence as UTF-8-encoded text representing a single JSON value into a JsonDocument. A JsonDocument representation of the JSON value. - To be added. + The may be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object lifetime. +Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must not be present. does not represent a valid single JSON value. contains unsupported options. @@ -125,7 +126,8 @@ Options to control the reader behavior during parsing. Parse memory as UTF-8-encoded text representing a single JSON value into a JsonDocument. A JsonDocument representation of the JSON value. - To be added. + The value will be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object lifetime. +Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must not be present. does not represent a valid single JSON value. contains unsupported options. @@ -153,7 +155,7 @@ Options to control the reader behavior during parsing. Parse text representing a single JSON value into a JsonDocument. A JsonDocument representation of the JSON value. - To be added. + The value may be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object lifetime. does not represent a valid single JSON value. contains unsupported options. diff --git a/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml b/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml index 7365d9d8745..8eda290c583 100644 --- a/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml +++ b/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml @@ -101,7 +101,7 @@ Returns an enumerator that iterates the properties of an object. An value that can be used to iterate through the object. - To be added. + The enumerator will enumerate the properties in the order they are declared, and when an object has multiple definitions of a single property they will all individually be returned (each in the order they appear in the content). diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index 9d3269a5cb9..0c75ff229b9 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -114,7 +114,7 @@ Gets the value of the element as a . The value of the element as a . - To be added. + This method does not parse the contents of a JSON string value. This value's is neither or . The parent has been disposed. @@ -138,7 +138,7 @@ Gets the current JSON number as a . The current JSON number as a . - To be added. + This method does not parse the contents of a JSON string value. This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -163,7 +163,9 @@ Gets the current JSON number as a . The current JSON number as a . - To be added. + This method does not parse the contents of a JSON string value.On .NET Core this method returns (or + ) for values larger than + (or smaller than ). This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -213,7 +215,7 @@ Gets the current JSON number as a . The current JSON number as a . - To be added. + This method does not parse the contents of a JSON string value. This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -241,7 +243,8 @@ The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. Gets a representing the value of a required property identified by . A representing the value of the requested property. - To be added. + Property name matching is performed as an ordinal, case-sensitive, comparison.If a property is defined multiple times for the same object, the last such definition is + what is matched. This value's is not . No property was found with the requested name. The parent has been disposed. @@ -269,7 +272,8 @@ Name of the property whose value to return. Gets a representing the value of a required property identified by . A representing the value of the requested property. - To be added. + Property name matching is performed as an ordinal, case-sensitive, comparison.If a property is defined multiple times for the same object, the last such definition is + what is matched. This value's is not . No property was found with the requested name. The parent has been disposed. @@ -298,7 +302,8 @@ Gets a representing the value of a required property identified by . A representing the value of the requested property. - To be added. + Property name matching is performed as an ordinal, case-sensitive, comparison. +If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . No property was found with the requested name. is . @@ -347,7 +352,8 @@ Gets the current JSON number as a . The current JSON number as a . - To be added. + This method does not parse the contents of a JSON string value. +On .NET Core this method returns (or ) for values larger than (or smaller than ). This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -372,7 +378,7 @@ Gets the value of the element as a . The value of the element as a . - To be added. + This method does not create a string representation of values other than JSON strings. This value's is neither nor . The parent has been disposed. @@ -401,7 +407,7 @@ Gets the current JSON number as a . The current JSON number as a . - To be added. + This method does not parse the contents of a JSON string value. This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -431,7 +437,7 @@ Gets the current JSON number as a . The current JSON number as a . - To be added. + This method does not parse the contents of a JSON string value. This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -485,7 +491,11 @@ Gets a string representation for the current value appropriate to the value type. A string representation for the current value appropriate to the value type. - To be added. + For , is returned. +For , is returned. +For , is returned. +For , the value of () is returned. +For other types, the value of () is returned. The parent has been disposed. @@ -510,8 +520,9 @@ Receives the value. Attempts to represent the current JSON number as a . - if the number can be represented as a , otherwise. - To be added. + + if the number can be represented as a , otherwise. + This method does not parse the contents of a JSON string value. This value's is not . The parent has been disposed. @@ -537,8 +548,10 @@ Receives the value. Attempts to represent the current JSON number as a . - if the number can be represented as a , otherwise. - To be added. + + if the number can be represented as a , otherwise. + This method does not parse the contents of a JSON string value. +On .NET Core this method does not return for values larger than (or smaller than ), instead is returned and (or ) is emitted. This value's is not . The parent has been disposed. @@ -564,8 +577,9 @@ Receives the value. Attempts to represent the current JSON number as an . - if the number can be represented as an , otherwise. - To be added. + + if the number can be represented as an , otherwise. + This method does not parse the contents of a JSON string value. This value's is not . The parent has been disposed. @@ -591,8 +605,9 @@ Receives the value. Attempts to represent the current JSON number as a . - if the number can be represented as a , otherwise. - To be added. + + if the number can be represented as a , otherwise. + This method does not parse the contents of a JSON string value. This value's is not . The parent has been disposed. @@ -620,8 +635,10 @@ The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. Receives the value of the located property. Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. - if the property was found, otherwise. - To be added. + + if the property was found, otherwise. + Property name matching is performed as an ordinal, case-sensitive, comparison. +If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . The parent has been disposed. @@ -649,8 +666,10 @@ Name of the property to find. Receives the value of the located property. Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. - if the property was found, otherwise. - To be added. + + if the property was found, otherwise. + Property name matching is performed as an ordinal, case-sensitive, comparison. +If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . The parent has been disposed. @@ -678,8 +697,10 @@ Name of the property to find. Receives the value of the located property. Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. - if the property was found, otherwise. - To be added. + + if the property was found, otherwise. + Property name matching is performed as an ordinal, case-sensitive, comparison. +If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . is . The parent has been disposed. @@ -706,8 +727,10 @@ Receives the value. Attempts to represent the current JSON number as a . - if the number can be represented as a , otherwise. - To be added. + + if the number can be represented as a , otherwise. + This method does not parse the contents of a JSON string value. +On .NET Core this method does not return for values larger than (or smaller than ), instead is returned and (or ) is emitted. This value's is not . The parent has been disposed. @@ -738,8 +761,9 @@ Receives the value. Attempts to represent the current JSON number as a . - if the number can be represented as a , otherwise. - To be added. + + if the number can be represented as a , otherwise. + This method does not parse the contents of a JSON string value. This value's is not . The parent has been disposed. @@ -770,8 +794,9 @@ Receives the value. Attempts to represent the current JSON number as a . - if the number can be represented as a , otherwise. - To be added. + + if the number can be represented as a , otherwise. + This method does not parse the contents of a JSON string value. This value's is not . The parent has been disposed. diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index 8c1fbb8ee58..6a4f74d6dc1 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -20,8 +20,7 @@ Provides a high-performance API for forward-only, non-cached writing of UTF-8 encoded JSON text. - - and pass that in to the writer. - ]]> - + ]]> @@ -54,18 +52,15 @@ To be able to format the output with indentation and white space OR to skip vali An instance of used as a destination for writing JSON text. 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 with the specified . - - . - ]]> - - - is . + ]]> + is . @@ -87,7 +82,8 @@ This is the reason why the constructor accepts a Gets the total number of bytes committed to the output by the so far for the current instance of the . This indicates how much the has advanced. The total number of bytes committed to the output by the so far. - To be added. + In the case of IBufferwriter, this is how much the IBufferWriter has advanced. +In the case of Stream, this is how much data has been written to the stream. @@ -130,15 +126,13 @@ This is the reason why the constructor accepts a Gets the depth of the current token. The depth of the current token. - - - + ]]> @@ -159,12 +153,10 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - to indicate no more data will be written; otherwise, . This is used to validate - that the JSON written so far is structurally valid if no more data is to follow. + to indicate no more data will be written; otherwise, . This is used to validate that the JSON written so far is structurally valid if no more data is to follow. Advances the underlying based on what has been written so far. To be added. - - Incomplete JSON has been written and is . For example, when an open object or array needs to be closed. + Incomplete JSON has been written and is . For example, when an open object or array needs to be closed. @@ -187,8 +179,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Returns the current snapshot of the state that must be captured by the caller and passed back in to the constructor with more data. The current snapshot of the state. - - struct without first committing the data that has been written would result in an inconsistent state. Call before getting the current state. - ]]> - - - The JSON data has been written and buffered but not yet flushed to the . + ]]> + The JSON data has been written and buffered but not yet flushed to the . @@ -229,10 +218,8 @@ Call before getting the current to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. To be added. - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -260,10 +247,8 @@ Call before getting the current to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter and its default value is . Writes the property name and value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. To be added. - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -291,10 +276,8 @@ Call before getting the current to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter and its default value is . Writes the property name and value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. To be added. - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -319,8 +302,7 @@ Call before getting the current The value to be written as a JSON literal "true" or "false" as an element of a JSON array. Writes the value (as a JSON literal "true" or "false") as an element of a JSON array. To be added. - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -346,8 +328,7 @@ Call before getting the current to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter and its default value is . Writes the UTF-8 text value as a JSON comment (within /*..*/). To be added. - - is too large. + is too large. @@ -373,8 +354,7 @@ Call before getting the current to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter and its default value is . Writes the UTF-16 text value as a JSON comment (within /*..*/). To be added. - - is too large. + is too large. @@ -400,8 +380,7 @@ Call before getting the current to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter and its default value is . Writes the string text value as a JSON comment (within /*..*/). To be added. - - is too large. + is too large. @@ -423,8 +402,7 @@ Call before getting the current Writes the end of a JSON array. To be added. - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -446,8 +424,7 @@ Call before getting the current Writes the end of a JSON object. To be added. - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -473,10 +450,8 @@ Call before getting the current to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and the JSON literal "null" as part of a name/value pair of a JSON object. To be added. - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -502,10 +477,8 @@ Call before getting the current to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and the JSON literal "null" as part of a name/value pair of a JSON object. To be added. - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -531,10 +504,8 @@ Call before getting the current to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and the JSON literal "null" as part of a name/value pair of a JSON object. To be added. - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -556,8 +527,7 @@ Call before getting the current Writes the JSON literal "null" as an element of a JSON array. To be added. - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -584,13 +554,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -617,13 +583,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -650,13 +612,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -683,13 +641,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -716,13 +670,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -754,13 +704,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -792,13 +738,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -825,13 +767,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -858,13 +796,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -891,13 +825,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -924,13 +854,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -957,13 +883,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -995,13 +917,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1033,13 +951,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1066,13 +980,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1099,13 +1009,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1132,13 +1038,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1165,13 +1067,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1198,13 +1096,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1236,13 +1130,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1274,13 +1164,9 @@ Call before getting the current The value to be written as a JSON number as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON number) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'G'). For example, 32767. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1304,11 +1190,8 @@ Call before getting the current The value to be written as a JSON number as an element of a JSON array. Writes the value (as a JSON number) as an element of a JSON array. - - Writes the using the default (that is, 'G'). - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1332,11 +1215,8 @@ Call before getting the current The value to be written as a JSON number as an element of a JSON array. Writes the value (as a JSON number) as an element of a JSON array. - - Writes the using the default (that is, 'G'). - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1360,11 +1240,8 @@ Call before getting the current The value to be written as a JSON number as an element of a JSON array. Writes the value (as a JSON number) as an element of a JSON array. - - Writes the using the default (that is, 'G'). For example, 32767. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1388,11 +1265,8 @@ Call before getting the current The value to be written as a JSON number as an element of a JSON array. Writes the value (as a JSON number) as an element of a JSON array. - - Writes the using the default (that is, 'G'). For example, 32767. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1416,11 +1290,8 @@ Call before getting the current The value to be written as a JSON number as an element of a JSON array. Writes the value (as a JSON number) as an element of a JSON array. - - Writes the using the default (that is, 'G'). - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1449,11 +1320,8 @@ Call before getting the current The value to be written as a JSON number as an element of a JSON array. Writes the value (as a JSON number) as an element of a JSON array. - - Writes the using the default (that is, 'G'). For example, 32767. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1482,11 +1350,8 @@ Call before getting the current The value to be written as a JSON number as an element of a JSON array. Writes the value (as a JSON number) as an element of a JSON array. - - Writes the using the default (that is, 'G'). For example, 32767. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'G'). For example, 32767. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1508,13 +1373,11 @@ Call before getting the current Writes the beginning of a JSON array. To be added. - - The depth of the JSON has exceeded the maximum depth of 1000. + 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). - +if this would result in an invalid JSON to be written (while validation is enabled). @@ -1540,15 +1403,12 @@ if this would result in an invalid JSON to be written (while validation is enabl to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the beginning of a JSON array with a property name as the key. To be added. - - is too large. - - The depth of the JSON has exceeded the maximum depth of 1000. + is too large. + The depth of the JSON has exceeded the maximum depth of 1000. -or- -The JSON data to be written would be invalid JSON (while validation is enabled). - +The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1574,15 +1434,12 @@ The JSON data to be written would be invalid JSON (while validation is enabled). to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the beginning of a JSON array with a property name as the key. To be added. - - is too large. - - The depth of the JSON has exceeded the maximum depth of 1000. + is too large. + The depth of the JSON has exceeded the maximum depth of 1000. -or- -The JSON data to be written would be invalid JSON (while validation is enabled). - +The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1608,15 +1465,12 @@ The JSON data to be written would be invalid JSON (while validation is enabled). to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the beginning of a JSON array with a property name as the key. To be added. - - is too large. - - The depth of the JSON has exceeded the maximum depth of 1000. + is too large. + The depth of the JSON has exceeded the maximum depth of 1000. -or- -The JSON data to be written would be invalid JSON (while validation is enabled). - +The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1638,13 +1492,11 @@ The JSON data to be written would be invalid JSON (while validation is enabled). Writes the beginning of a JSON object. To be added. - - The depth of the JSON has exceeded the maximum depth of 1000. + The depth of the JSON has exceeded the maximum depth of 1000. -or- -The JSON data to be written would be invalid JSON (while validation is enabled). - +The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1670,15 +1522,12 @@ The JSON data to be written would be invalid JSON (while validation is enabled). to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the beginning of a JSON object with a property name as the key. To be added. - - is too large. - - The depth of the JSON has exceeded the maximum depth of 1000. + is too large. + The depth of the JSON has exceeded the maximum depth of 1000. -or- -The JSON data to be written would be invalid JSON (while validation is enabled). - +The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1704,15 +1553,12 @@ The JSON data to be written would be invalid JSON (while validation is enabled). to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the beginning of a JSON object with a property name as the key. To be added. - - is too large. - - The depth of the JSON has exceeded the maximum depth of 1000. + is too large. + The depth of the JSON has exceeded the maximum depth of 1000. -or- -The JSON data to be written would be invalid JSON (while validation is enabled). - +The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1738,15 +1584,12 @@ The JSON data to be written would be invalid JSON (while validation is enabled). to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the beginning of a JSON object with a property name as the key. To be added. - - is too large. - - The depth of the JSON has exceeded the maximum depth of 1000. + is too large. + The depth of the JSON has exceeded the maximum depth of 1000. -or- -The JSON data to be written would be invalid JSON (while validation is enabled). - +The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1773,13 +1616,9 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON string) as part of a name/value pair of a JSON object. - - Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1806,13 +1645,9 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON string) as part of a name/value pair of a JSON object. - - Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000-07:00. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000-07:00. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1839,13 +1674,9 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON string) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1874,11 +1705,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value is always escaped Writes the UTF-8 property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. To be added. - - Thrown when the specified property name or value is too large. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Thrown when the specified property name or value is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1907,11 +1735,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value is always escaped Writes the UTF-8 property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. To be added. - - Thrown when the specified property name or value is too large. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Thrown when the specified property name or value is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1940,11 +1765,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value is always escaped Writes the UTF-8 property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. To be added. - - Thrown when the specified property name or value is too large. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Thrown when the specified property name or value is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1971,13 +1793,9 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON string) as part of a name/value pair of a JSON object. - - Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2004,13 +1822,9 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON string) as part of a name/value pair of a JSON object. - - Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000-07:00. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000-07:00. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2037,13 +1851,9 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON string) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2072,11 +1882,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value is always escaped Writes the UTF-16 property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. To be added. - - Thrown when the specified property name or value is too large. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Thrown when the specified property name or value is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2105,11 +1912,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value is always escaped Writes the UTF-16 property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. To be added. - - Thrown when the specified property name or value is too large. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Thrown when the specified property name or value is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2138,11 +1942,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value is always escaped Writes the UTF-16 property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. To be added. - - Thrown when the specified property name or value is too large. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Thrown when the specified property name or value is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2169,13 +1970,9 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON string) as part of a name/value pair of a JSON object. - - Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2202,13 +1999,9 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON string) as part of a name/value pair of a JSON object. - - Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000-07:00. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000-07:00. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2235,13 +2028,9 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as part of the name/value pair. to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter; its default value is . Writes the property name and value (as a JSON string) as part of a name/value pair of a JSON object. - - Writes the using the default (that is, 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. - - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2270,11 +2059,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value is always escaped Writes the property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. To be added. - - Thrown when the specified property name or value is too large. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Thrown when the specified property name or value is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2303,11 +2089,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value is always escaped Writes the property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. To be added. - - Thrown when the specified property name or value is too large. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Thrown when the specified property name or value is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2336,11 +2119,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value is always escaped Writes the property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. To be added. - - Thrown when the specified property name or value is too large. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Thrown when the specified property name or value is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2364,11 +2144,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as an element of a JSON array. Writes the value (as a JSON string) as an element of a JSON array. - - Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2392,11 +2169,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as an element of a JSON array. Writes the value (as a JSON string) as an element of a JSON array. - - Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000-07:00. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000-07:00. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2420,11 +2194,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as an element of a JSON array. Writes the value (as a JSON string) as an element of a JSON array. - - Writes the using the default (that is, 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. - - - The JSON data to be written would be invalid JSON (while validation is enabled). + Writes the using the default (that is, 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2450,10 +2221,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter and its default value is . Writes the UTF-8 text value (as a JSON string) as an element of a JSON array. To be added. - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2479,10 +2248,8 @@ The JSON data to be written would be invalid JSON (while validation is enabled). to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter and its default value is . Writes the UTF-16 text value (as a JSON string) as an element of a JSON array. To be added. - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2508,11 +2275,9 @@ The JSON data to be written would be invalid JSON (while validation is enabled). to indicate the writer should assume the property name is properly escaped and skips the escaping step; otherwise, . This is an optional parameter and its default value is . Writes the string text value (as a JSON string) as an element of a JSON array. To be added. - - is too large. - - The JSON data to be written would be invalid JSON (while validation is enabled). + is too large. + The JSON data to be written would be invalid JSON (while validation is enabled). - + \ No newline at end of file From 2d2075f585df7f55bfa83350a6486f36607d69bd Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 25 Apr 2019 12:47:40 -0700 Subject: [PATCH 4/7] Update JsonElement.xml Fixed one ".On" and two ".If" glued sentences. --- xml/System.Text.Json/JsonElement.xml | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index f283849392e..596972193b2 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -163,9 +163,8 @@ Gets the current JSON number as a . The current JSON number as a . - This method does not parse the contents of a JSON string value.On .NET Core this method returns (or - ) for values larger than - (or smaller than ). + This method does not parse the contents of a JSON string value. +On .NET Core this method returns (or ) for values larger than (or smaller than ). This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -243,8 +242,8 @@ The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. Gets a representing the value of a required property identified by . A representing the value of the requested property. - Property name matching is performed as an ordinal, case-sensitive, comparison.If a property is defined multiple times for the same object, the last such definition is - what is matched. + Property name matching is performed as an ordinal, case-sensitive, comparison. +If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . No property was found with the requested name. The parent has been disposed. @@ -272,8 +271,8 @@ Name of the property whose value to return. Gets a representing the value of a required property identified by . A representing the value of the requested property. - Property name matching is performed as an ordinal, case-sensitive, comparison.If a property is defined multiple times for the same object, the last such definition is - what is matched. + Property name matching is performed as an ordinal, case-sensitive, comparison. +If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . No property was found with the requested name. The parent has been disposed. From 5517bd6e0637096b982a2fa958cd138ff5d1a722 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Fri, 26 Apr 2019 11:41:31 -0700 Subject: [PATCH 5/7] Update Utf8JsonWriter.xml Removed remark that is not ready to be published. --- xml/System.Text.Json/Utf8JsonWriter.xml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index 6a4f74d6dc1..80aa0698aad 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -82,8 +82,7 @@ This is the reason why the constructor accepts a Gets the total number of bytes committed to the output by the so far for the current instance of the . This indicates how much the has advanced. The total number of bytes committed to the output by the so far. - In the case of IBufferwriter, this is how much the IBufferWriter has advanced. -In the case of Stream, this is how much data has been written to the stream. + To be added. @@ -2280,4 +2279,4 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - \ No newline at end of file + From 12b11581b37293137c0135e85c17403a129ccc00 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Mon, 6 May 2019 18:01:31 -0700 Subject: [PATCH 6/7] Apply suggestions from code review rpetrusha suggestions Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Text.Json/JsonDocument.xml | 28 ++++---- .../JsonElement+ArrayEnumerator.xml | 4 +- .../JsonElement+ObjectEnumerator.xml | 6 +- xml/System.Text.Json/JsonElement.xml | 65 ++++++++++--------- xml/System.Text.Json/JsonProperty.xml | 8 +-- 5 files changed, 60 insertions(+), 51 deletions(-) diff --git a/xml/System.Text.Json/JsonDocument.xml b/xml/System.Text.Json/JsonDocument.xml index 470c0660ba3..4a10f1146de 100644 --- a/xml/System.Text.Json/JsonDocument.xml +++ b/xml/System.Text.Json/JsonDocument.xml @@ -65,11 +65,12 @@ - JSON text to parse. + The JSON text to parse. Options to control the reader behavior during parsing. - Parse a sequence as UTF-8-encoded text representing a single JSON value into a JsonDocument. + Parses a sequence as UTF-8-encoded text representing a single JSON value into a . A JsonDocument representation of the JSON value. - The may be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object lifetime. + The may be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object's lifetime. + Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must not be present. does not represent a valid single JSON value. contains unsupported options. @@ -96,7 +97,7 @@ Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must n JSON data to parse. Options to control the reader behavior during parsing. - Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be read to completion. + Parses a as UTF-8-encoded data representing a single JSON value into a . The stream will be read to completion. A JsonDocument representation of the JSON value. To be added. does not represent a valid single JSON value. @@ -124,9 +125,10 @@ Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must n JSON text to parse. Options to control the reader behavior during parsing. - Parse memory as UTF-8-encoded text representing a single JSON value into a JsonDocument. + Parses memory as UTF-8-encoded text representing a single JSON value into a . A JsonDocument representation of the JSON value. - The value will be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object lifetime. + The value will be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object's lifetime. + Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must not be present. does not represent a valid single JSON value. contains unsupported options. @@ -151,11 +153,11 @@ Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must n - JSON text to parse. + The JSON text to parse. Options to control the reader behavior during parsing. - Parse text representing a single JSON value into a JsonDocument. + Parses text representing a single JSON value into a . A JsonDocument representation of the JSON value. - The value may be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object lifetime. + The value may be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object's lifetime. does not represent a valid single JSON value. contains unsupported options. @@ -181,7 +183,7 @@ Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must n JSON text to parse. Options to control the reader behavior during parsing. - Parse text representing a single JSON value into a JsonDocument. + Parses text representing a single JSON value into a . A JsonDocument representation of the JSON value. To be added. does not represent a valid single JSON value. @@ -210,8 +212,8 @@ Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must n JSON data to parse. Options to control the reader behavior during parsing. The token to monitor for cancellation requests. - Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be read to completion. - A Task to produce a JsonDocument representation of the JSON value. + Parses a as UTF-8-encoded data representing a single JSON value into a . The stream will be read to completion. + A task to produce a representation of the JSON value. To be added. does not represent a valid single JSON value. contains unsupported options. @@ -233,7 +235,7 @@ Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must n System.Text.Json.JsonElement - The representing the value of the document. + Gets the representing the value of the document. To be added. To be added. diff --git a/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml b/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml index 59cef518e5e..e1b2d188fdc 100644 --- a/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml +++ b/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml @@ -100,7 +100,7 @@ Returns an enumerator that iterates through a collection. - An value that can be used to iterate through the array. + An enumerator that can be used to iterate through the array. To be added. @@ -226,4 +226,4 @@ - \ No newline at end of file + diff --git a/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml b/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml index 8eda290c583..ac8fb4cb3c5 100644 --- a/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml +++ b/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml @@ -100,8 +100,8 @@ Returns an enumerator that iterates the properties of an object. - An value that can be used to iterate through the object. - The enumerator will enumerate the properties in the order they are declared, and when an object has multiple definitions of a single property they will all individually be returned (each in the order they appear in the content). + An enumerator that can be used to iterate through the object. + The enumerator will enumerate the properties in the order they are declared, and when an object has multiple definitions of a single property, they will all individually be returned (each in the order they appear in the content). @@ -226,4 +226,4 @@ - \ No newline at end of file + diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index 596972193b2..8983656c08c 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -40,7 +40,7 @@ - Get an enumerator to enumerate the values in the JSON array represented by this JsonElement. + Gets an enumerator to enumerate the values in the JSON array represented by this . An enumerator to enumerate the values in the JSON array represented by this JsonElement. To be added. This value's is not . @@ -64,7 +64,7 @@ - Get an enumerator to enumerate the properties in the JSON object represented by this JsonElement. + Gets an enumerator to enumerate the properties in the JSON object represented by this . An enumerator to enumerate the properties in the JSON object represented by this JsonElement. To be added. This value's is not . @@ -88,7 +88,7 @@ - Get the number of values contained within the current array value. + 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 . @@ -163,8 +163,15 @@ Gets the current JSON number as a . The current JSON number as a . - This method does not parse the contents of a JSON string value. -On .NET Core this method returns (or ) for values larger than (or smaller than ). + + (or ) for values larger than (or smaller than ). + + ]]> + This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -239,10 +246,10 @@ On .NET Core this method returns - The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. + The UTF-8 representation with no Byte-Order-Mark (BOM) of the name of the property to return. Gets a representing the value of a required property identified by . A representing the value of the requested property. - Property name matching is performed as an ordinal, case-sensitive, comparison. + Property name matching is performed as an ordinal, case-sensitive comparison. If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . No property was found with the requested name. @@ -271,7 +278,7 @@ If a property is defined multiple times for the same object, the last such defin Name of the property whose value to return. Gets a representing the value of a required property identified by . A representing the value of the requested property. - Property name matching is performed as an ordinal, case-sensitive, comparison. + Property name matching is performed as an ordinal, case-sensitive comparison. If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . No property was found with the requested name. @@ -301,7 +308,7 @@ If a property is defined multiple times for the same object, the last such defin Gets a representing the value of a required property identified by . A representing the value of the requested property. - Property name matching is performed as an ordinal, case-sensitive, comparison. + Property name matching is performed as an ordinal, case-sensitive comparison. If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . No property was found with the requested name. @@ -326,8 +333,8 @@ If a property is defined multiple times for the same object, the last such defin - Gets the original input data backing this value, returning it as a . - The original input data backing this value, returning it as a . + Gets a string containing the original input data backing this value. + The original input data backing this value. To be added. The parent has been disposed. @@ -462,7 +469,7 @@ On .NET Core this method returns To be added. - Get the value at a specified index when the current value is a + Gets the value at a specified index when the current value is an . To be added. To be added. @@ -517,7 +524,7 @@ For other types, the value of - Receives the value. + When the method returns, the current JSON number represented as a decimal value. Attempts to represent the current JSON number as a . if the number can be represented as a , otherwise. @@ -545,7 +552,7 @@ For other types, the value of - Receives the value. + When the method returns, the current JSON number represented as a double-precision floating point value. Attempts to represent the current JSON number as a . if the number can be represented as a , otherwise. @@ -574,7 +581,7 @@ On .NET Core this method does not return for values lar - Receives the value. + When the method returns, the current JSON number represented as a 32-bit signed integer. Attempts to represent the current JSON number as an . if the number can be represented as an , otherwise. @@ -602,7 +609,7 @@ On .NET Core this method does not return for values lar - Receives the value. + When the method returns, the current JSON number represented as a 64-bit signed integer value. Attempts to represent the current JSON number as a . if the number can be represented as a , otherwise. @@ -633,10 +640,10 @@ On .NET Core this method does not return for values lar The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. Receives the value of the located property. - Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. + Looks for a property named in the current object, returning whether or not such a property exists. When the property exists is assigned to the value of that property. if the property was found, otherwise. - Property name matching is performed as an ordinal, case-sensitive, comparison. + Property name matching is performed as an ordinal, case-sensitive comparison. If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . The parent has been disposed. @@ -662,12 +669,12 @@ If a property is defined multiple times for the same object, the last such defin - Name of the property to find. - Receives the value of the located property. - Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. + The name of the property to find. + When the method returns, the value of the specified property. + Looks for a property named in the current object, returning whether or not such a property exists. When the property exists, is assigned to the value of that property. if the property was found, otherwise. - Property name matching is performed as an ordinal, case-sensitive, comparison. + Property name matching is performed as an ordinal, case-sensitive comparison. If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . The parent has been disposed. @@ -694,10 +701,10 @@ If a property is defined multiple times for the same object, the last such defin Name of the property to find. - Receives the value of the located property. - Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. + When the method returns, the value of the specified property. + Looks for a property named in the current object, returning whether or not such a property exists. When the property exists, is assigned to the value of that property. if the property was found, otherwise. - Property name matching is performed as an ordinal, case-sensitive, comparison. + Property name matching is performed as an ordinal, case-sensitive comparison. If a property is defined multiple times for the same object, the last such definition is what is matched. This value's is not . is . @@ -723,7 +730,7 @@ If a property is defined multiple times for the same object, the last such defin - Receives the value. + When the method returns, the JSON number represented as a single-precision floating point number. Attempts to represent the current JSON number as a . if the number can be represented as a , otherwise. This method does not parse the contents of a JSON string value. @@ -756,7 +763,7 @@ On .NET Core this method does not return for values lar - Receives the value. + When the method returns, the current JSON number as an unsigned 32-bit integer. Attempts to represent the current JSON number as a . if the number can be represented as a , otherwise. @@ -789,7 +796,7 @@ On .NET Core this method does not return for values lar - Receives the value. + When the method returns, the current JSON number as an unsigned long integer. Attempts to represent the current JSON number as a . if the number can be represented as a , otherwise. @@ -814,7 +821,7 @@ On .NET Core this method does not return for values lar System.Text.Json.JsonValueType - The that the value is. + Gets the type of the value. To be added. To be added. The parent has been disposed. diff --git a/xml/System.Text.Json/JsonProperty.xml b/xml/System.Text.Json/JsonProperty.xml index 36bcac1a7f3..716058d8d5b 100644 --- a/xml/System.Text.Json/JsonProperty.xml +++ b/xml/System.Text.Json/JsonProperty.xml @@ -39,7 +39,7 @@ System.String - The name of this property. + Gets the name of this property. To be added. To be added. @@ -62,7 +62,7 @@ Provides a representation of the property for debugging purposes. - A string containing the un-interpreted value of the property, beginning at the declaring open-quote and ending at the last character that is part of the value. + A string containing the uninterpreted value of the property, beginning at the declaring open-quote and ending at the last character that is part of the value. To be added. @@ -82,10 +82,10 @@ System.Text.Json.JsonElement - The value of this property. + Gets the value of this property. To be added. To be added. - \ No newline at end of file + From 1068a9b75d9efed274944436850488a41084348d Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 7 May 2019 14:22:08 -0700 Subject: [PATCH 7/7] Apply suggestions from code review Suggestions by rpetrusha Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Text.Json/JsonDocument.xml | 1 + xml/System.Text.Json/JsonElement.xml | 24 +++++++++++++++--------- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/xml/System.Text.Json/JsonDocument.xml b/xml/System.Text.Json/JsonDocument.xml index 4a10f1146de..7171982f4ab 100644 --- a/xml/System.Text.Json/JsonDocument.xml +++ b/xml/System.Text.Json/JsonDocument.xml @@ -71,6 +71,7 @@ A JsonDocument representation of the JSON value. The may be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object's lifetime. + Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must not be present. does not represent a valid single JSON value. contains unsupported options. diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index 8983656c08c..8c5fdb168e4 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -358,8 +358,10 @@ If a property is defined multiple times for the same object, the last such defin Gets the current JSON number as a . The current JSON number as a . - This method does not parse the contents of a JSON string value. -On .NET Core this method returns (or ) for values larger than (or smaller than ). + (or ) for values larger than (or smaller than ). +]]> This value's is not . The value cannot be represented as a . The parent has been disposed. @@ -497,11 +499,13 @@ On .NET Core this method returns Gets a string representation for the current value appropriate to the value type. A string representation for the current value appropriate to the value type. - For , is returned. -For , is returned. -For , is returned. -For , the value of () is returned. -For other types, the value of () is returned. + , is returned. +For , is returned. +For , is returned. +For , the value of is returned. +For other types, the value of is returned. +]]> The parent has been disposed. @@ -733,8 +737,10 @@ If a property is defined multiple times for the same object, the last such defin When the method returns, the JSON number represented as a single-precision floating point number. Attempts to represent the current JSON number as a . if the number can be represented as a , otherwise. - This method does not parse the contents of a JSON string value. -On .NET Core this method does not return for values larger than (or smaller than ), instead is returned and (or ) is emitted. + for values larger than (or smaller than ), instead is returned and (or ) is emitted. +]]> This value's is not . The parent has been disposed.