Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 070125c

Browse files
safernRon Petrusha
safern
authored and
Ron Petrusha
committed
Fix JSON Writer docs for data writter as Base64-encoded text (dotnet#2976)
* Fix JSON Writer docs for data writter as Base64-encoded text * feedback * more feedback
1 parent 954cf8e commit 070125c

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

‎xml/System.Text.Json/JsonElement.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -210,12 +210,12 @@ This method does not parse the contents of a JSON string value.
210210
211211
## Remarks
212212
213-
This method does not create a byte representation of values other than base 64-encoded JSON strings.
213+
This method does not create a byte representation of values other than Base64 encoded JSON strings.
214214
215215
]]></format>
216216
</remarks>
217217
<exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
218-
<exception cref="T:System.FormatException">The value is not encoded as base 64 text and hence cannot be decoded to bytes.</exception>
218+
<exception cref="T:System.FormatException">The value is not encoded as Base64 text and hence cannot be decoded to bytes.</exception>
219219
<exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
220220
</Docs>
221221
</Member>
@@ -940,16 +940,16 @@ This method does not parse the contents of a JSON string value.
940940
<Parameter Name="value" Type="System.Byte[]" RefType="out" />
941941
</Parameters>
942942
<Docs>
943-
<param name="value">If the method succeeds, contains the decoded binary representation of the base 64 text.</param>
944-
<summary>Attempts to represent the current JSON string as a byte array, assuming that it is base 64-encoded.</summary>
945-
<returns><see langword="true" /> if the entire token value is encoded as valid base 64 text and can be successfully decoded to bytes.
943+
<param name="value">If the method succeeds, contains the decoded binary representation of the Base64 text.</param>
944+
<summary>Attempts to represent the current JSON string as a byte array, assuming that it is Base64 encoded.</summary>
945+
<returns><see langword="true" /> if the entire token value is encoded as valid Base64 text and can be successfully decoded to bytes.
946946
<see langword="false" /> otherwise.</returns>
947947
<remarks>
948948
<format type="text/markdown"><![CDATA[
949949
950950
## Remarks
951951
952-
This method does not create a byte array representation of values other than base 64-encoded JSON strings.
952+
This method does not create a byte array representation of values other than Base64 encoded JSON strings.
953953
954954
]]></format>
955955
</remarks>

‎xml/System.Text.Json/Utf8JsonWriter.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -444,8 +444,8 @@ The <xref:System.Text.Json.Utf8JsonWriter> will continue to use the original wri
444444
</Parameters>
445445
<Docs>
446446
<param name="utf8PropertyName">The UTF-8 encoded name of the property to write.</param>
447-
<param name="bytes">The binary data to be written as a base 64 encoded JSON string as part of the name/value pair.</param>
448-
<summary>Writes the property name and raw bytes value (as a base 64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
447+
<param name="bytes">The binary data to write as Base64 encoded text.</param>
448+
<summary>Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
449449
<remarks>
450450
<format type="text/markdown"><![CDATA[
451451
@@ -480,8 +480,8 @@ The property name is escaped before writing.
480480
</Parameters>
481481
<Docs>
482482
<param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
483-
<param name="bytes">The binary data to be written as a base 64 encoded JSON string as part of the name/value pair.</param>
484-
<summary>Writes the property name and raw bytes value (as a base 64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
483+
<param name="bytes">The binary data to write as Base64 encoded text.</param>
484+
<summary>Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
485485
<remarks>
486486
<format type="text/markdown"><![CDATA[
487487
@@ -516,7 +516,7 @@ The property name is escaped before writing.
516516
</Parameters>
517517
<Docs>
518518
<param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
519-
<param name="bytes">The binary data to be written as a base 64 encoded JSON string as part of the name/value pair.</param>
519+
<param name="bytes">The binary data to write as Base64 encoded text.</param>
520520
<summary>Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
521521
<remarks>
522522
<format type="text/markdown"><![CDATA[
@@ -553,8 +553,8 @@ The property name is escaped before writing.
553553
</Parameters>
554554
<Docs>
555555
<param name="propertyName">The JSON-encoded name of the property to write.</param>
556-
<param name="bytes">The binary data to be written as a base 64 encoded JSON string as part of the name/value pair.</param>
557-
<summary>Writes the pre-encoded property name and raw bytes value (as a base 64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
556+
<param name="bytes">The binary data to write as Base64 encoded text.</param>
557+
<summary>Writes the pre-encoded property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
558558
<remarks>
559559
<format type="text/markdown"><![CDATA[
560560
@@ -586,8 +586,8 @@ The property name should already be escaped when the instance of <xref:System.Te
586586
<Parameter Name="bytes" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
587587
</Parameters>
588588
<Docs>
589-
<param name="bytes">The binary data to be written as a base 64 encoded JSON string element of a JSON array.</param>
590-
<summary>Writes the raw bytes value as base 64 encoded JSON string as an element of a JSON array.</summary>
589+
<param name="bytes">The binary data to be written as a Base64 encoded JSON string element of a JSON array.</param>
590+
<summary>Writes the raw bytes value as a Base64 encoded JSON string as an element of a JSON array.</summary>
591591
<remarks>
592592
<format type="text/markdown"><![CDATA[
593593

0 commit comments

Comments
 (0)