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.Serialization/JsonExtensionDataAttribute.xml
+2-4Lines changed: 2 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,7 @@
21
21
<Docs>
22
22
<summary>When placed on a property of type <seecref="T:System.Collections.Generic.IDictionary`2" />, any properties that do not have a matching member are added to that dictionary during deserialization and written during serialization.</summary>
23
23
<remarks>
24
-
<formattype="text/markdown">
25
-
<![CDATA[
24
+
<formattype="text/markdown"><![CDATA[
26
25
27
26
## Remarks
28
27
@@ -34,8 +33,7 @@ During serialization, the name of the extension data property is not included in
34
33
35
34
If there is more than one property on a type with this extension data attribute, or if the property itself is not of the correct <see cref="T:System.Collections.Generic.IDictionary`2" /> type, an <xref:System.InvalidOperationException> is thrown during the first serialization or deserialization of that type.
Copy file name to clipboardExpand all lines: xml/System.Text.Json/JsonElement.xml
+4-8Lines changed: 4 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -195,15 +195,13 @@ This method does not parse the contents of a JSON string value.
195
195
<summary>Gets the value of the element as a byte array.</summary>
196
196
<returns>The value decoded as a byte array.</returns>
197
197
<remarks>
198
-
<formattype="text/markdown">
199
-
<![CDATA[
198
+
<formattype="text/markdown"><![CDATA[
200
199
201
200
## Remarks
202
201
203
202
This method does not create a byte representation of values other than base 64-encoded JSON strings.
204
203
205
-
]]>
206
-
</format>
204
+
]]></format>
207
205
</remarks>
208
206
<exceptioncref="T:System.InvalidOperationException">This value's <seecref="P:System.Text.Json.JsonElement.ValueKind" /> is not <seecref="F:System.Text.Json.JsonValueKind.String" />.</exception>
209
207
<exceptioncref="T:System.FormatException">The value is not encoded as base 64 text and hence cannot be decoded to bytes.</exception>
@@ -881,15 +879,13 @@ For other types, the value of <xref:System.Text.Json.JsonElement.GetRawText> is
881
879
<seelangword="true" /> if the entire token value is encoded as valid base 64 text and can be successfully decoded to bytes.
882
880
<seelangword="false" /> otherwise.</returns>
883
881
<remarks>
884
-
<formattype="text/markdown">
885
-
<![CDATA[
882
+
<formattype="text/markdown"><![CDATA[
886
883
887
884
## Remarks
888
885
889
886
This method does not create a byte array representation of values other than base 64-encoded JSON strings.
890
887
891
-
]]>
892
-
</format>
888
+
]]></format>
893
889
</remarks>
894
890
<exceptioncref="T:System.InvalidOperationException">This value's <seecref="P:System.Text.Json.JsonElement.ValueKind" /> is not <seecref="F:System.Text.Json.JsonValueKind.String" />.</exception>
895
891
<exceptioncref="T:System.ObjectDisposedException">The parent <seecref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
Copy file name to clipboardExpand all lines: xml/System.Text.Json/JsonEncodedText.xml
+10-20Lines changed: 10 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -25,15 +25,13 @@
25
25
<Docs>
26
26
<summary>Provides methods to transform UTF-8 or UTF-16 encoded text into a form that is suitable for JSON.</summary>
27
27
<remarks>
28
-
<formattype="text/markdown">
29
-
<![CDATA[
28
+
<formattype="text/markdown"><![CDATA[
30
29
31
30
## Remarks
32
31
33
32
This type can be used to cache and store known strings used for writing JSON ahead of time by pre-encoding them up front.
34
33
35
-
]]>
36
-
</format>
34
+
]]></format>
37
35
</remarks>
38
36
</Docs>
39
37
<Members>
@@ -160,15 +158,13 @@ This type can be used to cache and store known strings used for writing JSON ahe
160
158
<summary>Determines whether this instance and a specified object, which must also be a <seecref="T:System.Text.Json.JsonEncodedText" /> instance, have the same value.</summary>
161
159
<returns><seelangword="true" /> if the current instance and <paramrefname="obj" /> are equal; otherwise, <seelangword="false" />.</returns>
162
160
<remarks>
163
-
<formattype="text/markdown">
164
-
<![CDATA[
161
+
<formattype="text/markdown"><![CDATA[
165
162
166
163
## Remarks
167
164
168
165
If `obj` is `null`, the method returns `false`.
169
166
170
-
]]>
171
-
</format>
167
+
]]></format>
172
168
</remarks>
173
169
</Docs>
174
170
</Member>
@@ -198,15 +194,13 @@ If `obj` is `null`, the method returns `false`.
198
194
<summary>Determines whether this instance and another specified <seecref="T:System.Text.Json.JsonEncodedText" /> instance have the same value.</summary>
199
195
<returns><seelangword="true" /> if this instance and <paramrefname="other" /> have the same value; otherwise, <seelangword="false" />.</returns>
200
196
<remarks>
201
-
<formattype="text/markdown">
202
-
<![CDATA[
197
+
<formattype="text/markdown"><![CDATA[
203
198
204
199
## Remarks
205
200
206
201
Default instances of <xref:System.Text.Json.JsonEncodedText> are treated as equal.
207
202
208
-
]]>
209
-
</format>
203
+
]]></format>
210
204
</remarks>
211
205
</Docs>
212
206
</Member>
@@ -230,15 +224,13 @@ Default instances of <xref:System.Text.Json.JsonEncodedText> are treated as equa
230
224
<summary>Returns the hash code for this <seecref="T:System.Text.Json.JsonEncodedText" />.</summary>
231
225
<returns>The hash code for this instance.</returns>
232
226
<remarks>
233
-
<formattype="text/markdown">
234
-
<![CDATA[
227
+
<formattype="text/markdown"><![CDATA[
235
228
236
229
## Remarks
237
230
238
231
This method returns 0 on a default instance of <xref:System.Text.Json.JsonEncodedText>.
239
232
240
-
]]>
241
-
</format>
233
+
]]></format>
242
234
</remarks>
243
235
</Docs>
244
236
</Member>
@@ -262,15 +254,13 @@ This method returns 0 on a default instance of <xref:System.Text.Json.JsonEncode
262
254
<summary>Converts the value of this instance to a <seecref="T:System.String" />.</summary>
Copy file name to clipboardExpand all lines: xml/System.Text.Json/JsonReaderOptions.xml
+4-8Lines changed: 4 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -42,15 +42,13 @@
42
42
<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>
43
43
<value><seelangword="true" /> if an exra comma is allowed; otherwise, <seelangword="false" />.</value>
44
44
<remarks>
45
-
<formattype="text/markdown">
46
-
<![CDATA[
45
+
<formattype="text/markdown"><![CDATA[
47
46
48
47
## Remarks
49
48
50
49
By default, this property is set to `false`, and a <xref:System.Text.Json.JsonException> is thrown if a trailing comma is encountered.
51
50
52
-
]]>
53
-
</format>
51
+
]]></format>
54
52
</remarks>
55
53
</Docs>
56
54
</Member>
@@ -113,15 +111,13 @@ By default, the reader throws a <xref:System.Text.Json.JsonException> if it enco
113
111
<summary>Gets or sets the maximum depth allowed when reading JSON, with the default (that is, 0) indicating a maximum depth of 64. </summary>
114
112
<value>The maximum depth allowed when reading JSON.</value>
115
113
<remarks>
116
-
<formattype="text/markdown">
117
-
<![CDATA[
114
+
<formattype="text/markdown"><![CDATA[
118
115
119
116
## Remarks
120
117
121
118
Reading past this depth will throw a <exception cref="T:System.Text.Json.JsonException>.
122
119
123
-
]]>
124
-
</format>
120
+
]]></format>
125
121
</remarks>
126
122
<exceptioncref="T:System.ArgumentOutOfRangeException">The maximum depth is being set to a negative value.</exception>
Copy file name to clipboardExpand all lines: xml/System.Text.Json/Utf8JsonReader.xml
+11-22Lines changed: 11 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,7 @@
21
21
<Docs>
22
22
<summary>Provides a high-performance API for forward-only, read-only access to the UTF-8 encoded JSON text.</summary>
23
23
<remarks>
24
-
<formattype="text/markdown">
25
-
<![CDATA[
24
+
<formattype="text/markdown"><![CDATA[
26
25
27
26
## Remarks
28
27
@@ -106,8 +105,7 @@ To be able to set max depth while reading OR allow skipping comments, create an
106
105
<paramname="state">If this is the first call to the constructor, pass in a default state. Otherwise, capture the state from the previous instance of the <seecref="T:System.Text.Json.Utf8JsonReader" /> and pass that back.</param>
107
106
<summary>Initializes a new instance of the <seecref="T:System.Text.Json.Utf8JsonReader" /> class.</summary>
108
107
<remarks>
109
-
<formattype="text/markdown">
110
-
<![CDATA[
108
+
<formattype="text/markdown"><![CDATA[
111
109
112
110
## Remarks
113
111
@@ -142,8 +140,7 @@ This is the reason why the constructor accepts a <xref:System.Text.Json.JsonRead
142
140
<paramname="state">A struct that contains the reader state. On the first call to the constructor, it should reflect a default state; otherwise, it should capture the state from the previous instance instance of the <seecref="T:System.Text.Json.Utf8JsonReader" /> and pass that back.</param>
143
141
<summary>Initializes a new instance of the <seecref="T:System.Text.Json.Utf8JsonReader" /> class.</summary>
144
142
<remarks>
145
-
<formattype="text/markdown">
146
-
<![CDATA[
143
+
<formattype="text/markdown"><![CDATA[
147
144
148
145
## Remarks
149
146
@@ -194,8 +191,7 @@ This is the reason why the constructor accepts a <xref:System.Text.Json.JsonRead
194
191
<summary>Gets the depth of the current token.</summary>
195
192
<value>The depth of the current token.</value>
196
193
<remarks>
197
-
<formattype="text/markdown">
198
-
<![CDATA[
194
+
<formattype="text/markdown"><![CDATA[
199
195
200
196
## Remarks
201
197
@@ -224,8 +220,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a
224
220
<summary>Gets the current snapshot of the <seecref="T:System.Text.Json.Utf8JsonReader" /> state that must be captured by the caller and passed back in to the <seecref="T:System.Text.Json.Utf8JsonReader" /> constructor with more data.</summary>
225
221
<value>To be added.</value>
226
222
<remarks>
227
-
<formattype="text/markdown">
228
-
<![CDATA[
223
+
<formattype="text/markdown"><![CDATA[
229
224
230
225
## Remarks
231
226
@@ -873,8 +868,7 @@ The current depth exceeds the recursive limit set by the maximum depth.</excepti
873
868
<Docs>
874
869
<summary>Skips the children of the current JSON token.</summary>
875
870
<remarks>
876
-
<formattype="text/markdown">
877
-
<![CDATA[
871
+
<formattype="text/markdown"><![CDATA[
878
872
879
873
## Remarks
880
874
@@ -884,8 +878,7 @@ When <xref:System.Text.Json.Utf8JsonReader.TokenType> (originally, or after adva
884
878
885
879
For all other token types, the reader does not move. After the next call to <xref:System.Text.Json.Utf8JsonReader.Read>, the reader will be at the next value (when in an array), the next property name (when in an object), or the end array/object token.
886
880
887
-
]]>
888
-
</format>
881
+
]]></format>
889
882
</remarks>
890
883
<exceptioncref="T:System.InvalidOperationException">The reader was given partial data with more data to follow (that is, <seecref="P:System.Text.Json.Utf8JsonReader.IsFinalBlock" /> is <seelangword="false" />).</exception>
891
884
<exceptioncref="T:System.Text.Json.JsonException">An invalid JSON token was encountered while skipping, according to the JSON RFC.
@@ -919,17 +912,15 @@ The current depth exceeds the recursive limit set by the maximum depth.</excepti
919
912
<summary>Gets the index that the last processed JSON token starts at (within the given UTF-8 encoded input text), skipping any white space.</summary>
920
913
<value>The starting index of the last processed JSON token within the given UTF-8 encoded input text.</value>
921
914
<remarks>
922
-
<formattype="text/markdown">
923
-
<![CDATA[
915
+
<formattype="text/markdown"><![CDATA[
924
916
925
917
## Remarks
926
918
927
919
For JSON strings (including property names), this value points to before the start quote.
928
920
929
921
For comments, this value points to before the first comment delimiter (that is, '/').
930
922
931
-
]]>
932
-
</format>
923
+
]]></format>
933
924
</remarks>
934
925
</Docs>
935
926
</Member>
@@ -1406,8 +1397,7 @@ This method only parses <xref:System.Guid> values with hyphens and without any s
1406
1397
<returns>
1407
1398
<seelangword="true" /> if there was enough data for the children to be skipped successfully; otherwise, <seelangword="false" />.</returns>
1408
1399
<remarks>
1409
-
<formattype="text/markdown">
1410
-
<![CDATA[
1400
+
<formattype="text/markdown"><![CDATA[
1411
1401
1412
1402
## Remarks
1413
1403
@@ -1454,8 +1444,7 @@ The current depth exceeds the recursive limit set by the maximum depth.</excepti
1454
1444
Otherwise, <seecref="P:System.Text.Json.Utf8JsonReader.ValueSequence" /> contains the token value.</summary>
0 commit comments