Skip to content

Commit 7c450f2

Browse files
author
Ron Petrusha
authored
Update JsonReaderOptions.xml
1 parent 56710b2 commit 7c450f2

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

xml/System.Text.Json/JsonReaderOptions.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@
3434
<ReturnType>System.Boolean</ReturnType>
3535
</ReturnValue>
3636
<Docs>
37-
<summary>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. By default, it's set to false, and a <exception cref="T:System.Text.Json.JsonException" /> is thrown if a trailing comma is encountered.</summary>
38-
<value>To be added.</value>
37+
<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>
38+
<value><see langword="true" /> if an exra comma is allowed; otherwise, <see langword="false" />.</value>
3939
<remarks>
4040
<format type="text/markdown">
4141
<![CDATA[
4242
4343
## Remarks
4444
45-
By default, it's set to `false`, and <exception cref="T:System.Text.Json.JsonException> is thrown if a trailing comma is encountered.
45+
By default, this property is set to `false`, and a <xref:System.Text.Json.JsonException> is thrown if a trailing comma is encountered.
4646
4747
]]>
4848
</format>
@@ -65,7 +65,7 @@ By default, it's set to `false`, and <exception cref="T:System.Text.Json.JsonExc
6565
<ReturnType>System.Text.Json.JsonCommentHandling</ReturnType>
6666
</ReturnValue>
6767
<Docs>
68-
<summary>Gets or sets how the <see cref="T:System.Text.Json.Utf8JsonReader" /> struct handles comments when reading through the JSON data.</summary>
68+
<summary>Gets or sets a value that determines how the <see cref="T:System.Text.Json.Utf8JsonReader" /> handles comments when reading through the JSON data.</summary>
6969
<value>One of the enumeration values that indicates how comments are handled.</value>
7070
<remarks>
7171
<format type="text/markdown"><![CDATA[
@@ -76,7 +76,7 @@ By default, the reader throws a <xref:System.Text.Json.JsonReaderException> if i
7676
7777
]]></format>
7878
</remarks>
79-
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the comment handling enum is set to a value that is not supported (i.e. not within the <see cref="T:System.Text.Json.JsonCommentHandling" /> enum range).</exception>
79+
<exception cref="T:System.ArgumentOutOfRangeException">The property is being set to a value that is not a member of the <see cref="T:System.Text.Json.JsonCommentHandling" /> enumeration.</exception>
8080
</Docs>
8181
</Member>
8282
<Member MemberName="MaxDepth">
@@ -95,8 +95,8 @@ By default, the reader throws a <xref:System.Text.Json.JsonReaderException> if i
9595
<ReturnType>System.Int32</ReturnType>
9696
</ReturnValue>
9797
<Docs>
98-
<summary>Gets or sets the maximum depth allowed when reading JSON, with the default (i.e. 0) indicating a max depth of 64. Reading past this depth will throw a <exception cref="T:System.Text.Json.JsonException" />.</summary>
99-
<value>To be added.</value>
98+
<summary>Gets or sets the maximum depth allowed when reading JSON, with the default (i.e. 0) indicating a maximum depth of 64. </summary>
99+
<value>The maximum depth allowed when reading JSON.</value>
100100
<remarks>
101101
<format type="text/markdown">
102102
<![CDATA[
@@ -108,8 +108,8 @@ Reading past this depth will throw a <exception cref="T:System.Text.Json.JsonExc
108108
]]>
109109
</format>
110110
</remarks>
111-
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the max depth is set to a negative value.</exception>
111+
<exception cref="T:System.ArgumentOutOfRangeException">The maximum depth is being set to a negative value.</exception>
112112
</Docs>
113113
</Member>
114114
</Members>
115-
</Type>
115+
</Type>

0 commit comments

Comments
 (0)