Skip to content

Fix Utf8JsonWriter WriteXValue methods documentation to remove array-specific language #11476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 19, 2025
Merged

Fix Utf8JsonWriter WriteXValue methods documentation to remove array-specific language #11476

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eda78aa
Initial plan for issue
Copilot Jun 19, 2025
e9c2b6f
Fix WriteXValue method documentation to remove array-specific language
Copilot Jun 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 33 additions & 33 deletions xml/System.Text.Json/Utf8JsonWriter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -781,8 +781,8 @@ The bytes are encoded before writing.
<Parameter Name="bytes" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
</Parameters>
<Docs>
<param name="bytes">The binary data to be written as a Base64 encoded JSON string element of a JSON array.</param>
<summary>Writes the raw bytes value as a Base64 encoded JSON string as an element of a JSON array.</summary>
<param name="bytes">The binary data to be written as a Base64 encoded JSON string.</param>
<summary>Writes the raw bytes value as a Base64 encoded JSON string.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down Expand Up @@ -996,8 +996,8 @@ The property name should already be escaped when the instance of <xref:System.Te
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<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>
<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>
<param name="value">The value to be written as a JSON literal <b>true</b> or <b>false</b>.</param>
<summary>Writes a <see cref="T:System.Boolean" /> value (as a JSON literal <b>true</b> or <b>false</b>).</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
</Docs>
Expand Down Expand Up @@ -1381,7 +1381,7 @@ The property name should already be escaped when the instance of <xref:System.Te
</ReturnValue>
<Parameters />
<Docs>
<summary>Writes the JSON literal <b>null</b> as an element of a JSON array.</summary>
<summary>Writes the JSON literal <b>null</b>.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
</Docs>
Expand Down Expand Up @@ -2720,8 +2720,8 @@ The property name should already be escaped when the instance of <xref:System.Te
<Parameter Name="value" Type="System.Decimal" />
</Parameters>
<Docs>
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
<summary>Writes a <see cref="T:System.Decimal" /> value (as a JSON number) as an element of a JSON array.</summary>
<param name="value">The value to be written as a JSON number.</param>
<summary>Writes a <see cref="T:System.Decimal" /> value (as a JSON number).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -2760,8 +2760,8 @@ This method writes the <xref:System.Decimal> value using the default <xref:Syste
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
<summary>Writes a <see cref="T:System.Double" /> value (as a JSON number) as an element of a JSON array.</summary>
<param name="value">The value to be written as a JSON number.</param>
<summary>Writes a <see cref="T:System.Double" /> value (as a JSON number).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -2800,8 +2800,8 @@ This method writes the <xref:System.Double> value using the default <xref:System
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
<summary>Writes an <see cref="T:System.Int32" /> value (as a JSON number) as an element of a JSON array.</summary>
<param name="value">The value to be written as a JSON number.</param>
<summary>Writes an <see cref="T:System.Int32" /> value (as a JSON number).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -2840,8 +2840,8 @@ This method writes the <xref:System.Int32> value using the default <xref:System.
<Parameter Name="value" Type="System.Int64" />
</Parameters>
<Docs>
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
<summary>Writes an <see cref="T:System.Int64" /> value (as a JSON number) as an element of a JSON array.</summary>
<param name="value">The value to be written as a JSON number.</param>
<summary>Writes an <see cref="T:System.Int64" /> value (as a JSON number).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -2880,8 +2880,8 @@ This method writes the <xref:System.Int64> value using the default <xref:System.
<Parameter Name="value" Type="System.Single" />
</Parameters>
<Docs>
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
<summary>Writes a <see cref="T:System.Single" /> value (as a JSON number) as an element of a JSON array.</summary>
<param name="value">The value to be written as a JSON number.</param>
<summary>Writes a <see cref="T:System.Single" /> value (as a JSON number).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -2926,8 +2926,8 @@ This method writes the <xref:System.Single> value using the default <xref:System
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
<summary>Writes a <see cref="T:System.UInt32" /> value (as a JSON number) as an element of a JSON array.</summary>
<param name="value">The value to be written as a JSON number.</param>
<summary>Writes a <see cref="T:System.UInt32" /> value (as a JSON number).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -2972,8 +2972,8 @@ This method writes the <xref:System.UInt32> value using the default <xref:System
<Parameter Name="value" Type="System.UInt64" />
</Parameters>
<Docs>
<param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
<summary>Writes a <see cref="T:System.UInt64" /> value (as a JSON number) as an element of a JSON array.</summary>
<param name="value">The value to be written as a JSON number.</param>
<summary>Writes a <see cref="T:System.UInt64" /> value (as a JSON number).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -5093,8 +5093,8 @@ The property name and value should already be escaped when the instance of <xref
<Parameter Name="value" Type="System.DateTime" />
</Parameters>
<Docs>
<param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
<summary>Writes a <see cref="T:System.DateTime" /> value (as a JSON string) as an element of a JSON array.</summary>
<param name="value">The value to be written as a JSON string.</param>
<summary>Writes a <see cref="T:System.DateTime" /> value (as a JSON string).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -5134,8 +5134,8 @@ for example, 2017-06-12T05:30:45.7680000.
<Parameter Name="value" Type="System.DateTimeOffset" />
</Parameters>
<Docs>
<param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
<summary>Writes a <see cref="T:System.DateTimeOffset" /> value (as a JSON string) as an element of a JSON array.</summary>
<param name="value">The value to be written as a JSON string.</param>
<summary>Writes a <see cref="T:System.DateTimeOffset" /> value (as a JSON string).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -5174,8 +5174,8 @@ This method writes the <xref:System.DateTimeOffset> using the ISO 8601-1 extende
<Parameter Name="value" Type="System.Guid" />
</Parameters>
<Docs>
<param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
<summary>Writes a <see cref="T:System.Guid" /> value (as a JSON string) as an element of a JSON array.</summary>
<param name="value">The value to be written as a JSON string.</param>
<summary>Writes a <see cref="T:System.Guid" /> value (as a JSON string).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -5214,8 +5214,8 @@ This method writes the <xref:System.Guid> value using the default <xref:System.B
<Parameter Name="utf8Value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
</Parameters>
<Docs>
<param name="utf8Value">The UTF-8 encoded value to be written as a JSON string element of a JSON array.</param>
<summary>Writes a UTF-8 text value (as a JSON string) as an element of a JSON array.</summary>
<param name="utf8Value">The UTF-8 encoded value to be written as a JSON string.</param>
<summary>Writes a UTF-8 text value (as a JSON string).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -5255,8 +5255,8 @@ The value is escaped before writing.
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
<summary>Writes a UTF-16 text value (as a JSON string) as an element of a JSON array.</summary>
<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string.</param>
<summary>Writes a UTF-16 text value (as a JSON string).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -5297,8 +5297,8 @@ The value is escaped before writing.
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
<summary>Writes a string text value (as a JSON string) as an element of a JSON array.</summary>
<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string.</param>
<summary>Writes a string text value (as a JSON string).</summary>
<remarks>
<format><![CDATA[

Expand Down Expand Up @@ -5340,8 +5340,8 @@ If `value` is `null`, the JSON **null** value is written, as if the <xref:System
<Parameter Name="value" Type="System.Text.Json.JsonEncodedText" />
</Parameters>
<Docs>
<param name="value">The JSON encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
<summary>Writes the pre-encoded text value (as a JSON string) as an element of a JSON array.</summary>
<param name="value">The JSON encoded value to be written as a UTF-8 transcoded JSON string.</param>
<summary>Writes the pre-encoded text value (as a JSON string).</summary>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down