Skip to content

Commit 2edad53

Browse files
carlossanlopRon Petrusha
authored andcommitted
Automatically port System.Text.Json.JsonDocumentOptions (#2885)
* Automatically port System.Text.Json.JsonDocumentOptions * Update JsonDocumentOptions.xml * extra endline for remarks
1 parent af399a0 commit 2edad53

File tree

1 file changed

+37
-11
lines changed

1 file changed

+37
-11
lines changed

xml/System.Text.Json/JsonDocumentOptions.xml

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<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 <see cref="T:System.Text.Json.JsonDocument" />.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -39,9 +39,17 @@
3939
<ReturnType>System.Boolean</ReturnType>
4040
</ReturnValue>
4141
<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><see langword="true"/> if an extra comma at the end of a list of JSON values in an object or array is allowed; otherwise, <see langword="false"/>. Default is <see langword="false"/></value>
44+
<remarks>
45+
<format type="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.
50+
51+
]]></format>
52+
</remarks>
4553
</Docs>
4654
</Member>
4755
<Member MemberName="CommentHandling">
@@ -65,9 +73,18 @@
6573
<ReturnType>System.Text.Json.JsonCommentHandling</ReturnType>
6674
</ReturnValue>
6775
<Docs>
68-
<summary>To be added.</summary>
69-
<value>To be added.</value>
70-
<remarks>To be added.</remarks>
76+
<summary>Gets or sets a value that determines how the <see cref="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+
<format type="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+
<exception cref="T:System.ArgumentOutOfRangeException">The comment handling enum is set to a value that is not supported (or not within the <see cref="T:System.Text.Json.JsonCommentHandling" /> enum range).</exception>
7188
</Docs>
7289
</Member>
7390
<Member MemberName="MaxDepth">
@@ -91,10 +108,19 @@
91108
<ReturnType>System.Int32</ReturnType>
92109
</ReturnValue>
93110
<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+
<format type="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+
<exception cref="T:System.ArgumentOutOfRangeException">The max depth is set to a negative value.</exception>
97123
</Docs>
98124
</Member>
99125
</Members>
100-
</Type>
126+
</Type>

0 commit comments

Comments
 (0)