Skip to content

Commit 10ce63c

Browse files
gewarrengewarren
committed
STJ and BinaryData edits
1 parent 1d46154 commit 10ce63c

File tree

6 files changed

+80
-100
lines changed

6 files changed

+80
-100
lines changed

‎xml/System.Text.Json/JsonReaderOptions.xml‎

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ For more information, see [How to write custom serializers and deserializers wit
5656
<ReturnType>System.Boolean</ReturnType>
5757
</ReturnValue>
5858
<Docs>
59-
<summary>
60-
<para>Defines whether the <see cref="T:System.Text.Json.Utf8JsonReader" /> should tolerate zero or more top-level JSON values that are whitespace separated.</para>
61-
</summary>
62-
<value>To be added.</value>
63-
<remarks>By default, it's set to <see langword="false" />, and <exception cref="T:System.Text.Json.JsonException" /> is thrown if trailing content is encountered after the first top-level JSON value.</remarks>
59+
<summary>Gets or sets a value that indicates whether the <see cref="T:System.Text.Json.Utf8JsonReader" /> should tolerate zero or more top-level JSON values that are whitespace separated.</summary>
60+
<value>
61+
<see langword="true" /> if the <see cref="T:System.Text.Json.Utf8JsonReader" /> should tolerate zero or more top-level JSON values that are whitespace separated. The default is <see langword="false" />.</value>
62+
<remarks>To be added.</remarks>
63+
<exception cref="T:System.Text.Json.JsonException">Trailing content was encountered after the first top-level JSON value.</exception>
6464
</Docs>
6565
</Member>
6666
<Member MemberName="AllowTrailingCommas">
@@ -92,14 +92,12 @@ For more information, see [How to write custom serializers and deserializers wit
9292
<ReturnType>System.Boolean</ReturnType>
9393
</ReturnValue>
9494
<Docs>
95-
<summary>Gets or sets a value that defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read. </summary>
95+
<summary>Gets or sets a value that defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read.</summary>
9696
<value>
9797
<see langword="true" /> if an extra comma is allowed; otherwise, <see langword="false" />.</value>
9898
<remarks>
9999
<format type="text/markdown"><![CDATA[
100100
101-
## Remarks
102-
103101
By default, this property is set to `false`, and a <xref:System.Text.Json.JsonException> is thrown if a trailing comma is encountered.
104102
105103
]]></format>
@@ -140,8 +138,6 @@ By default, this property is set to `false`, and a <xref:System.Text.Json.JsonEx
140138
<remarks>
141139
<format type="text/markdown"><![CDATA[
142140
143-
## Remarks
144-
145141
By default, the reader throws a <xref:System.Text.Json.JsonException> if it encounters a comment.
146142
147143
]]></format>
@@ -180,15 +176,7 @@ By default, the reader throws a <xref:System.Text.Json.JsonException> if it enco
180176
<Docs>
181177
<summary>Gets or sets the maximum depth allowed when reading JSON, with the default (that is, 0) indicating a maximum depth of 64. </summary>
182178
<value>The maximum depth allowed when reading JSON.</value>
183-
<remarks>
184-
<format type="text/markdown"><![CDATA[
185-
186-
## Remarks
187-
188-
Reading past this depth will throw a <xref:System.Text.Json.JsonException>.
189-
190-
]]></format>
191-
</remarks>
179+
<remarks>Reading past this depth will throw a <see cref="T:System.Text.Json.JsonException" />.</remarks>
192180
<exception cref="T:System.ArgumentOutOfRangeException">The maximum depth is being set to a negative value.</exception>
193181
</Docs>
194182
</Member>

‎xml/System.Text.Json/JsonSerializer.xml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2493,7 +2493,7 @@ The <xref:System.Text.Json.JsonReaderOptions> used to create the instance of the
24932493
<exception cref="T:System.ArgumentNullException">
24942494
<paramref name="utf8Json" /> or <paramref name="jsonTypeInfo" /> is <see langword="null" />.</exception>
24952495
<exception cref="T:System.Text.Json.JsonException">
2496-
<para>The JSON is invalid, or when there is remaining data in the PipeReader.</para>
2496+
<para>The JSON is invalid, or there is remaining data in the PipeReader.</para>
24972497
</exception>
24982498
</Docs>
24992499
</Member>
@@ -2535,7 +2535,7 @@ The <xref:System.Text.Json.JsonReaderOptions> used to create the instance of the
25352535
<exception cref="T:System.ArgumentNullException">
25362536
<paramref name="utf8Json" /> or <paramref name="jsonTypeInfo" /> is <see langword="null" />.</exception>
25372537
<exception cref="T:System.Text.Json.JsonException">The JSON is invalid,
2538-
or when there is remaining data in the Stream.</exception>
2538+
or there is remaining data in the Stream.</exception>
25392539
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
25402540
</Docs>
25412541
</Member>
@@ -2596,7 +2596,7 @@ The <xref:System.Text.Json.JsonReaderOptions> used to create the instance of the
25962596
<exception cref="T:System.ArgumentNullException">
25972597
<paramref name="utf8Json" /> or <paramref name="returnType" /> is <see langword="null" />.</exception>
25982598
<exception cref="T:System.Text.Json.JsonException">
2599-
<para>The JSON is invalid, the <paramref name="returnType" /> is not compatible with the JSON, or when there is remaining data in the PipeReader.</para>
2599+
<para>The JSON is invalid, the <paramref name="returnType" /> is not compatible with the JSON, or there is remaining data in the PipeReader.</para>
26002600
</exception>
26012601
<exception cref="T:System.NotSupportedException">
26022602
<para>There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for <paramref name="returnType" /> or its serializable members.</para>
@@ -2643,7 +2643,7 @@ The <xref:System.Text.Json.JsonReaderOptions> used to create the instance of the
26432643
<exception cref="T:System.ArgumentNullException">
26442644
<paramref name="utf8Json" />, <paramref name="returnType" />, or <paramref name="context" /> is <see langword="null" />.</exception>
26452645
<exception cref="T:System.Text.Json.JsonException">
2646-
<para>The JSON is invalid, the <paramref name="returnType" /> is not compatible with the JSON, or when there is remaining data in the PipeReader.</para>
2646+
<para>The JSON is invalid, the <paramref name="returnType" /> is not compatible with the JSON, or there is remaining data in the PipeReader.</para>
26472647
</exception>
26482648
<exception cref="T:System.NotSupportedException">
26492649
<para>There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for <paramref name="returnType" /> or its serializable members.</para>
@@ -2851,7 +2851,7 @@ There is remaining data in the stream.</exception>
28512851
<exception cref="T:System.ArgumentNullException">
28522852
<paramref name="utf8Json" /> is <see langword="null" />.</exception>
28532853
<exception cref="T:System.Text.Json.JsonException">
2854-
<para>The JSON is invalid, <typeparamref name="TValue" /> is not compatible with the JSON, or when there is remaining data in the PipeReader.</para>
2854+
<para>The JSON is invalid, <typeparamref name="TValue" /> is not compatible with the JSON, or there is remaining data in the PipeReader.</para>
28552855
</exception>
28562856
<exception cref="T:System.NotSupportedException">
28572857
<para>There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</para>
@@ -2907,7 +2907,7 @@ There is remaining data in the stream.</exception>
29072907
<exception cref="T:System.ArgumentNullException">
29082908
<paramref name="utf8Json" /> or <paramref name="jsonTypeInfo" /> is <see langword="null" />.</exception>
29092909
<exception cref="T:System.Text.Json.JsonException">
2910-
<para>The JSON is invalid, <typeparamref name="TValue" /> is not compatible with the JSON, or when there is remaining data in the PipeReader.</para>
2910+
<para>The JSON is invalid, <typeparamref name="TValue" /> is not compatible with the JSON, or there is remaining data in the PipeReader.</para>
29112911
</exception>
29122912
</Docs>
29132913
</Member>

‎xml/System.Text.Json/JsonSerializerOptions.xml‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -192,13 +192,13 @@ similar to how <xref:System.Text.Json.Serialization.Metadata.JsonTypeInfoResolve
192192
<ReturnType>System.Boolean</ReturnType>
193193
</ReturnValue>
194194
<Docs>
195-
<summary>Defines whether duplicate property names are allowed when deserializing JSON objects.</summary>
196-
<value>To be added.</value>
195+
<summary>Gets or sets a value that indicates whether duplicate property names are allowed when deserializing JSON objects.</summary>
196+
<value><see langword="true" /> if duplicate property names are allowed when deserializing JSON objects. The default is <see langword="true" />.</value>
197197
<remarks>
198-
<para>By default, it's set to <see langword="true" />. If set to <see langword="false" />, <see cref="T:System.Text.Json.JsonException" /> is thrown when a duplicate property name is encountered during deserialization.</para>
198+
<para>If set to <see langword="false" />, <see cref="T:System.Text.Json.JsonException" /> is thrown when a duplicate property name is encountered during deserialization.</para>
199199
<para>Duplicate property names are not allowed in serialization.</para>
200200
</remarks>
201-
<exception cref="T:System.InvalidOperationException">Thrown if this property is set after serialization or deserialization has occurred.</exception>
201+
<exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
202202
</Docs>
203203
</Member>
204204
<Member MemberName="AllowOutOfOrderMetadataProperties">
@@ -218,9 +218,9 @@ similar to how <xref:System.Text.Json.Serialization.Metadata.JsonTypeInfoResolve
218218
<ReturnType>System.Boolean</ReturnType>
219219
</ReturnValue>
220220
<Docs>
221-
<summary>Allows JSON metadata properties to be specified after regular properties in a deserialized JSON object.</summary>
222-
<value>To be added.</value>
223-
<remarks>When set to <see langword="true" />, removes the requirement that JSON metadata properties, such as \\$id and \\$type, be specified at the very start of the deserialized JSON object. If you enable this setting, it can result in over-buffering when deserializing large JSON payloads in the context of streaming deserialization.
221+
<summary>Gets or sets a value that indicates whether JSON metadata properties can be specified after regular properties in a deserialized JSON object.</summary>
222+
<value><see langword="true" /> if JSON metadata properties, such as \\$id and \\$type, aren't required to be specified at the very start of the deserialized JSON object; <see langword="false" /> if JSON metadata properties must be specified before regular properties.</value>
223+
<remarks>If you enable this setting, it can result in over-buffering when deserializing large JSON payloads in the context of streaming deserialization.
224224
</remarks>
225225
<exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
226226
</Docs>
@@ -797,7 +797,7 @@ For more information, see [How to ignore properties with System.Text.Json](/dotn
797797
<remarks>Allowed characters are space and horizontal tab.</remarks>
798798
<exception cref="T:System.ArgumentOutOfRangeException">
799799
<paramref name="value" /> contains an invalid character.</exception>
800-
<exception cref="T:System.InvalidOperationException">Thrown if this property is set after serialization or deserialization has occurred.</exception>
800+
<exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
801801
</Docs>
802802
</Member>
803803
<Member MemberName="IndentSize">
@@ -822,7 +822,7 @@ For more information, see [How to ignore properties with System.Text.Json](/dotn
822822
<remarks>Allowed values are all integers between 0 and 127, included.</remarks>
823823
<exception cref="T:System.ArgumentOutOfRangeException">
824824
<paramref name="value" /> is out of the allowed range.</exception>
825-
<exception cref="T:System.InvalidOperationException">Thrown if this property is set after serialization or deserialization has occurred.</exception>
825+
<exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
826826
</Docs>
827827
</Member>
828828
<Member MemberName="IsReadOnly">
@@ -980,7 +980,7 @@ Going past this depth throws a <xref:System.Text.Json.JsonException>.
980980
<remarks>To be added.</remarks>
981981
<exception cref="T:System.ArgumentNullException">Thrown when the new line string is <see langword="null" />.</exception>
982982
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the new line string is not <c>\n</c> or <c>\r\n</c>.</exception>
983-
<exception cref="T:System.InvalidOperationException">Thrown if this property is set after serialization or deserialization has occurred.</exception>
983+
<exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
984984
</Docs>
985985
</Member>
986986
<Member MemberName="NumberHandling">

‎xml/System.Text.Json/JsonWriterOptions.xml‎

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
3434
## Remarks
3535
36-
By default, the JSON is written without any indentation or extra white space.
36+
By default, the JSON is written without any indentation or extra white space.
3737
Also, <xref:System.Text.Json.Utf8JsonWriter> throws an exception if the user attempts to write structurally invalid JSON.
3838
3939
For more information, see [How to write custom serializers and deserializers with System.Text.Json](/dotnet/standard/serialization/write-custom-serializer-deserializer#use-utf8jsonwriter).
@@ -195,18 +195,10 @@ For more information, see [How to write custom serializers and deserializers wit
195195
<ReturnType>System.Int32</ReturnType>
196196
</ReturnValue>
197197
<Docs>
198-
<summary>Gets or sets the maximum depth allowed when writing JSON, with the default (that is, 0) indicating a max depth of 1000.</summary>
198+
<summary>Gets or sets the maximum depth allowed when writing JSON, with the default (that is, 0) indicating a maximum depth of 1000.</summary>
199199
<value>To be added.</value>
200-
<remarks>
201-
<format type="text/markdown"><![CDATA[
202-
203-
## Remarks
204-
205-
Reading past this depth will throw a <exception cref="T:System.Text.Json.JsonException>.
206-
207-
]]></format>
208-
</remarks>
209-
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the max depth is set to a negative value.</exception>
200+
<remarks>Writing past this depth will throw a <see cref="T:System.Text.Json.JsonException" />.</remarks>
201+
<exception cref="T:System.ArgumentOutOfRangeException">The max depth is set to a negative value.</exception>
210202
</Docs>
211203
</Member>
212204
<Member MemberName="NewLine">
@@ -232,8 +224,8 @@ Reading past this depth will throw a <exception cref="T:System.Text.Json.JsonExc
232224
</summary>
233225
<value>To be added.</value>
234226
<remarks>To be added.</remarks>
235-
<exception cref="T:System.ArgumentNullException">Thrown when the new line string is <see langword="null" />.</exception>
236-
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the new line string is not <c>\n</c> or <c>\r\n</c>.</exception>
227+
<exception cref="T:System.ArgumentNullException">The new line string is <see langword="null" />.</exception>
228+
<exception cref="T:System.ArgumentOutOfRangeException">The new line string is not <c>\n</c> or <c>\r\n</c>.</exception>
237229
</Docs>
238230
</Member>
239231
<Member MemberName="SkipValidation">
@@ -264,12 +256,12 @@ Reading past this depth will throw a <exception cref="T:System.Text.Json.JsonExc
264256
<see langword="true" /> if structural validation is skipped and invalid JSON is allowed; <see langword="false" /> if an <see cref="T:System.InvalidOperationException" /> is thrown on any attempt to write invalid JSON.
265257
</value>
266258
<remarks>
267-
<format type="text/markdown"><![CDATA[
259+
<format type="text/markdown"><![CDATA[
268260
269261
## Remarks
270262
271263
If the JSON being written is known to be correct, then skipping validation (by setting this property to `true`) could improve performance.
272-
An example of invalid JSON where the writer will throw (when `SkipValidation` is set to `false`) is when you write a value within a JSON object without a property name.
264+
An example of invalid JSON where the writer will throw (when `SkipValidation` is set to `false`) is when you write a value within a JSON object without a property name.
273265
274266
]]></format>
275267
</remarks>

0 commit comments

Comments
 (0)