You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: xml/System.Text.Json/JsonDocumentOptions.xml
+37-11Lines changed: 37 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@
14
14
</Base>
15
15
<Interfaces />
16
16
<Docs>
17
-
<summary>To be added.</summary>
17
+
<summary>Provides the ability for the user to define custom behavior when parsing JSON to create a <seecref="T:System.Text.Json.JsonDocument" />.</summary>
18
18
<remarks>To be added.</remarks>
19
19
</Docs>
20
20
<Members>
@@ -39,9 +39,17 @@
39
39
<ReturnType>System.Boolean</ReturnType>
40
40
</ReturnValue>
41
41
<Docs>
42
-
<summary>To be added.</summary>
43
-
<value>To be added.</value>
44
-
<remarks>To be added.</remarks>
42
+
<summary>Gets or sets a value that indicates 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>
43
+
<value><seelangword="true"/> if an extra comma at the end of a list of JSON values in an object or array is allowed; otherwise, <seelangword="false"/>. Default is <seelangword="false"/></value>
44
+
<remarks>
45
+
<formattype="text/markdown"><![CDATA[
46
+
47
+
## Remarks
48
+
49
+
By default, `AllowTrailingCommas` is set to `false`, and a <xref:System.Text.Json.JsonException> is thrown if a trailing comma is encountered.
<summary>Gets or sets a value that determines how the <seecref="T:System.Text.Json.JsonDocument" /> handles comments when reading through the JSON data.</summary>
77
+
<value>One of the enumeration values that indicates how comments are handled.</value>
78
+
<remarks>
79
+
<formattype="text/markdown"><![CDATA[
80
+
81
+
## Remarks
82
+
83
+
By default, a <exception cref="T:System.Text.Json.JsonException> is thrown if a comment is encountered.
84
+
85
+
]]></format>
86
+
</remarks>
87
+
<exceptioncref="T:System.ArgumentOutOfRangeException">The comment handling enum is set to a value that is not supported (or not within the <seecref="T:System.Text.Json.JsonCommentHandling" /> enum range).</exception>
71
88
</Docs>
72
89
</Member>
73
90
<MemberMemberName="MaxDepth">
@@ -91,10 +108,19 @@
91
108
<ReturnType>System.Int32</ReturnType>
92
109
</ReturnValue>
93
110
<Docs>
94
-
<summary>To be added.</summary>
95
-
<value>To be added.</value>
96
-
<remarks>To be added.</remarks>
111
+
<summary>Gets or sets the maximum depth allowed when parsing JSON data, with the default (that is, 0) indicating a maximum depth of 64.</summary>
112
+
<value>The maximum depth allowed when parsing JSON data.</value>
113
+
<remarks>
114
+
<formattype="text/markdown"><![CDATA[
115
+
116
+
## Remarks
117
+
118
+
Parsing past this depth will throw a <exception cref="T:System.Text.Json.JsonException>.
119
+
120
+
]]></format>
121
+
</remarks>
122
+
<exceptioncref="T:System.ArgumentOutOfRangeException">The max depth is set to a negative value.</exception>
0 commit comments