Skip to content

Commit 6339fca

Browse files
authored
Fix Utf8JsonWriter WriteXValue methods documentation to remove array-specific language (#11476)
1 parent bc7a520 commit 6339fca

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

xml/System.Text.Json/Utf8JsonWriter.xml

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -781,8 +781,8 @@ The bytes are encoded before writing.
781781
<Parameter Name="bytes" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
782782
</Parameters>
783783
<Docs>
784-
<param name="bytes">The binary data to be written as a Base64 encoded JSON string element of a JSON array.</param>
785-
<summary>Writes the raw bytes value as a Base64 encoded JSON string as an element of a JSON array.</summary>
784+
<param name="bytes">The binary data to be written as a Base64 encoded JSON string.</param>
785+
<summary>Writes the raw bytes value as a Base64 encoded JSON string.</summary>
786786
<remarks>
787787
<format type="text/markdown"><![CDATA[
788788
@@ -996,8 +996,8 @@ The property name should already be escaped when the instance of <xref:System.Te
996996
<Parameter Name="value" Type="System.Boolean" />
997997
</Parameters>
998998
<Docs>
999-
<param name="value">The value to be written as a JSON literal <b>true</b> or <b>false</b> as an element of a JSON array.</param>
1000-
<summary>Writes a <see cref="T:System.Boolean" /> value (as a JSON literal <b>true</b> or <b>false</b>) as an element of a JSON array.</summary>
999+
<param name="value">The value to be written as a JSON literal <b>true</b> or <b>false</b>.</param>
1000+
<summary>Writes a <see cref="T:System.Boolean" /> value (as a JSON literal <b>true</b> or <b>false</b>).</summary>
10011001
<remarks>To be added.</remarks>
10021002
<exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
10031003
</Docs>
@@ -1381,7 +1381,7 @@ The property name should already be escaped when the instance of <xref:System.Te
13811381
</ReturnValue>
13821382
<Parameters />
13831383
<Docs>
1384-
<summary>Writes the JSON literal <b>null</b> as an element of a JSON array.</summary>
1384+
<summary>Writes the JSON literal <b>null</b>.</summary>
13851385
<remarks>To be added.</remarks>
13861386
<exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
13871387
</Docs>
@@ -2720,8 +2720,8 @@ The property name should already be escaped when the instance of <xref:System.Te
27202720
<Parameter Name="value" Type="System.Decimal" />
27212721
</Parameters>
27222722
<Docs>
2723-
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
2724-
<summary>Writes a <see cref="T:System.Decimal" /> value (as a JSON number) as an element of a JSON array.</summary>
2723+
<param name="value">The value to be written as a JSON number.</param>
2724+
<summary>Writes a <see cref="T:System.Decimal" /> value (as a JSON number).</summary>
27252725
<remarks>
27262726
<format><![CDATA[
27272727
@@ -2760,8 +2760,8 @@ This method writes the <xref:System.Decimal> value using the default <xref:Syste
27602760
<Parameter Name="value" Type="System.Double" />
27612761
</Parameters>
27622762
<Docs>
2763-
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
2764-
<summary>Writes a <see cref="T:System.Double" /> value (as a JSON number) as an element of a JSON array.</summary>
2763+
<param name="value">The value to be written as a JSON number.</param>
2764+
<summary>Writes a <see cref="T:System.Double" /> value (as a JSON number).</summary>
27652765
<remarks>
27662766
<format><![CDATA[
27672767
@@ -2800,8 +2800,8 @@ This method writes the <xref:System.Double> value using the default <xref:System
28002800
<Parameter Name="value" Type="System.Int32" />
28012801
</Parameters>
28022802
<Docs>
2803-
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
2804-
<summary>Writes an <see cref="T:System.Int32" /> value (as a JSON number) as an element of a JSON array.</summary>
2803+
<param name="value">The value to be written as a JSON number.</param>
2804+
<summary>Writes an <see cref="T:System.Int32" /> value (as a JSON number).</summary>
28052805
<remarks>
28062806
<format><![CDATA[
28072807
@@ -2840,8 +2840,8 @@ This method writes the <xref:System.Int32> value using the default <xref:System.
28402840
<Parameter Name="value" Type="System.Int64" />
28412841
</Parameters>
28422842
<Docs>
2843-
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
2844-
<summary>Writes an <see cref="T:System.Int64" /> value (as a JSON number) as an element of a JSON array.</summary>
2843+
<param name="value">The value to be written as a JSON number.</param>
2844+
<summary>Writes an <see cref="T:System.Int64" /> value (as a JSON number).</summary>
28452845
<remarks>
28462846
<format><![CDATA[
28472847
@@ -2880,8 +2880,8 @@ This method writes the <xref:System.Int64> value using the default <xref:System.
28802880
<Parameter Name="value" Type="System.Single" />
28812881
</Parameters>
28822882
<Docs>
2883-
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
2884-
<summary>Writes a <see cref="T:System.Single" /> value (as a JSON number) as an element of a JSON array.</summary>
2883+
<param name="value">The value to be written as a JSON number.</param>
2884+
<summary>Writes a <see cref="T:System.Single" /> value (as a JSON number).</summary>
28852885
<remarks>
28862886
<format><![CDATA[
28872887
@@ -2926,8 +2926,8 @@ This method writes the <xref:System.Single> value using the default <xref:System
29262926
<Parameter Name="value" Type="System.UInt32" />
29272927
</Parameters>
29282928
<Docs>
2929-
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
2930-
<summary>Writes a <see cref="T:System.UInt32" /> value (as a JSON number) as an element of a JSON array.</summary>
2929+
<param name="value">The value to be written as a JSON number.</param>
2930+
<summary>Writes a <see cref="T:System.UInt32" /> value (as a JSON number).</summary>
29312931
<remarks>
29322932
<format><![CDATA[
29332933
@@ -2972,8 +2972,8 @@ This method writes the <xref:System.UInt32> value using the default <xref:System
29722972
<Parameter Name="value" Type="System.UInt64" />
29732973
</Parameters>
29742974
<Docs>
2975-
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
2976-
<summary>Writes a <see cref="T:System.UInt64" /> value (as a JSON number) as an element of a JSON array.</summary>
2975+
<param name="value">The value to be written as a JSON number.</param>
2976+
<summary>Writes a <see cref="T:System.UInt64" /> value (as a JSON number).</summary>
29772977
<remarks>
29782978
<format><![CDATA[
29792979
@@ -5093,8 +5093,8 @@ The property name and value should already be escaped when the instance of <xref
50935093
<Parameter Name="value" Type="System.DateTime" />
50945094
</Parameters>
50955095
<Docs>
5096-
<param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
5097-
<summary>Writes a <see cref="T:System.DateTime" /> value (as a JSON string) as an element of a JSON array.</summary>
5096+
<param name="value">The value to be written as a JSON string.</param>
5097+
<summary>Writes a <see cref="T:System.DateTime" /> value (as a JSON string).</summary>
50985098
<remarks>
50995099
<format><![CDATA[
51005100
@@ -5134,8 +5134,8 @@ for example, 2017-06-12T05:30:45.7680000.
51345134
<Parameter Name="value" Type="System.DateTimeOffset" />
51355135
</Parameters>
51365136
<Docs>
5137-
<param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
5138-
<summary>Writes a <see cref="T:System.DateTimeOffset" /> value (as a JSON string) as an element of a JSON array.</summary>
5137+
<param name="value">The value to be written as a JSON string.</param>
5138+
<summary>Writes a <see cref="T:System.DateTimeOffset" /> value (as a JSON string).</summary>
51395139
<remarks>
51405140
<format><![CDATA[
51415141
@@ -5174,8 +5174,8 @@ This method writes the <xref:System.DateTimeOffset> using the ISO 8601-1 extende
51745174
<Parameter Name="value" Type="System.Guid" />
51755175
</Parameters>
51765176
<Docs>
5177-
<param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
5178-
<summary>Writes a <see cref="T:System.Guid" /> value (as a JSON string) as an element of a JSON array.</summary>
5177+
<param name="value">The value to be written as a JSON string.</param>
5178+
<summary>Writes a <see cref="T:System.Guid" /> value (as a JSON string).</summary>
51795179
<remarks>
51805180
<format><![CDATA[
51815181
@@ -5214,8 +5214,8 @@ This method writes the <xref:System.Guid> value using the default <xref:System.B
52145214
<Parameter Name="utf8Value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
52155215
</Parameters>
52165216
<Docs>
5217-
<param name="utf8Value">The UTF-8 encoded value to be written as a JSON string element of a JSON array.</param>
5218-
<summary>Writes a UTF-8 text value (as a JSON string) as an element of a JSON array.</summary>
5217+
<param name="utf8Value">The UTF-8 encoded value to be written as a JSON string.</param>
5218+
<summary>Writes a UTF-8 text value (as a JSON string).</summary>
52195219
<remarks>
52205220
<format><![CDATA[
52215221
@@ -5255,8 +5255,8 @@ The value is escaped before writing.
52555255
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
52565256
</Parameters>
52575257
<Docs>
5258-
<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
5259-
<summary>Writes a UTF-16 text value (as a JSON string) as an element of a JSON array.</summary>
5258+
<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string.</param>
5259+
<summary>Writes a UTF-16 text value (as a JSON string).</summary>
52605260
<remarks>
52615261
<format><![CDATA[
52625262
@@ -5297,8 +5297,8 @@ The value is escaped before writing.
52975297
<Parameter Name="value" Type="System.String" />
52985298
</Parameters>
52995299
<Docs>
5300-
<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
5301-
<summary>Writes a string text value (as a JSON string) as an element of a JSON array.</summary>
5300+
<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string.</param>
5301+
<summary>Writes a string text value (as a JSON string).</summary>
53025302
<remarks>
53035303
<format><![CDATA[
53045304
@@ -5340,8 +5340,8 @@ If `value` is `null`, the JSON **null** value is written, as if the <xref:System
53405340
<Parameter Name="value" Type="System.Text.Json.JsonEncodedText" />
53415341
</Parameters>
53425342
<Docs>
5343-
<param name="value">The JSON encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
5344-
<summary>Writes the pre-encoded text value (as a JSON string) as an element of a JSON array.</summary>
5343+
<param name="value">The JSON encoded value to be written as a UTF-8 transcoded JSON string.</param>
5344+
<summary>Writes the pre-encoded text value (as a JSON string).</summary>
53455345
<remarks>
53465346
<format type="text/markdown"><![CDATA[
53475347

0 commit comments

Comments
 (0)