Skip to content

Commit a61a79d

Browse files
mairawmairaw
authored
fix cdata formatting (#2893)
1 parent c78326d commit a61a79d

File tree

8 files changed

+91
-182
lines changed

8 files changed

+91
-182
lines changed

‎xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@
2121
<Docs>
2222
<summary>When placed on a property of type <see cref="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>
2323
<remarks>
24-
<format type="text/markdown">
25-
<![CDATA[
24+
<format type="text/markdown"><![CDATA[
2625
2726
## Remarks
2827
@@ -34,8 +33,7 @@ During serialization, the name of the extension data property is not included in
3433
3534
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.
3635
37-
]]>
38-
</format>
36+
]]></format>
3937
</remarks>
4038
</Docs>
4139
<Members>

‎xml/System.Text.Json/JsonElement.xml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -195,15 +195,13 @@ This method does not parse the contents of a JSON string value.
195195
<summary>Gets the value of the element as a byte array.</summary>
196196
<returns>The value decoded as a byte array.</returns>
197197
<remarks>
198-
<format type="text/markdown">
199-
<![CDATA[
198+
<format type="text/markdown"><![CDATA[
200199
201200
## Remarks
202201
203202
This method does not create a byte representation of values other than base 64-encoded JSON strings.
204203
205-
]]>
206-
</format>
204+
]]></format>
207205
</remarks>
208206
<exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
209207
<exception cref="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
881879
<see langword="true" /> if the entire token value is encoded as valid base 64 text and can be successfully decoded to bytes.
882880
<see langword="false" /> otherwise.</returns>
883881
<remarks>
884-
<format type="text/markdown">
885-
<![CDATA[
882+
<format type="text/markdown"><![CDATA[
886883
887884
## Remarks
888885
889886
This method does not create a byte array representation of values other than base 64-encoded JSON strings.
890887
891-
]]>
892-
</format>
888+
]]></format>
893889
</remarks>
894890
<exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
895891
<exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>

‎xml/System.Text.Json/JsonEncodedText.xml

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,13 @@
2525
<Docs>
2626
<summary>Provides methods to transform UTF-8 or UTF-16 encoded text into a form that is suitable for JSON.</summary>
2727
<remarks>
28-
<format type="text/markdown">
29-
<![CDATA[
28+
<format type="text/markdown"><![CDATA[
3029
3130
## Remarks
3231
3332
This type can be used to cache and store known strings used for writing JSON ahead of time by pre-encoding them up front.
3433
35-
]]>
36-
</format>
34+
]]></format>
3735
</remarks>
3836
</Docs>
3937
<Members>
@@ -160,15 +158,13 @@ This type can be used to cache and store known strings used for writing JSON ahe
160158
<summary>Determines whether this instance and a specified object, which must also be a <see cref="T:System.Text.Json.JsonEncodedText" /> instance, have the same value.</summary>
161159
<returns><see langword="true" /> if the current instance and <paramref name="obj" /> are equal; otherwise, <see langword="false" />.</returns>
162160
<remarks>
163-
<format type="text/markdown">
164-
<![CDATA[
161+
<format type="text/markdown"><![CDATA[
165162
166163
## Remarks
167164
168165
If `obj` is `null`, the method returns `false`.
169166
170-
]]>
171-
</format>
167+
]]></format>
172168
</remarks>
173169
</Docs>
174170
</Member>
@@ -198,15 +194,13 @@ If `obj` is `null`, the method returns `false`.
198194
<summary>Determines whether this instance and another specified <see cref="T:System.Text.Json.JsonEncodedText" /> instance have the same value.</summary>
199195
<returns><see langword="true" /> if this instance and <paramref name="other" /> have the same value; otherwise, <see langword="false" />.</returns>
200196
<remarks>
201-
<format type="text/markdown">
202-
<![CDATA[
197+
<format type="text/markdown"><![CDATA[
203198
204199
## Remarks
205200
206201
Default instances of <xref:System.Text.Json.JsonEncodedText> are treated as equal.
207202
208-
]]>
209-
</format>
203+
]]></format>
210204
</remarks>
211205
</Docs>
212206
</Member>
@@ -230,15 +224,13 @@ Default instances of <xref:System.Text.Json.JsonEncodedText> are treated as equa
230224
<summary>Returns the hash code for this <see cref="T:System.Text.Json.JsonEncodedText" />.</summary>
231225
<returns>The hash code for this instance.</returns>
232226
<remarks>
233-
<format type="text/markdown">
234-
<![CDATA[
227+
<format type="text/markdown"><![CDATA[
235228
236229
## Remarks
237230
238231
This method returns 0 on a default instance of <xref:System.Text.Json.JsonEncodedText>.
239232
240-
]]>
241-
</format>
233+
]]></format>
242234
</remarks>
243235
</Docs>
244236
</Member>
@@ -262,15 +254,13 @@ This method returns 0 on a default instance of <xref:System.Text.Json.JsonEncode
262254
<summary>Converts the value of this instance to a <see cref="T:System.String" />.</summary>
263255
<returns>The underlying UTF-16 encoded string.</returns>
264256
<remarks>
265-
<format type="text/markdown">
266-
<![CDATA[
257+
<format type="text/markdown"><![CDATA[
267258
268259
## Remarks
269260
270261
This method returns an empty string on a default instance of <xref:System.Text.Json.JsonEncodedText>.
271262
272-
]]>
273-
</format>
263+
]]></format>
274264
</remarks>
275265
</Docs>
276266
</Member>

‎xml/System.Text.Json/JsonException.xml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -128,15 +128,13 @@
128128
<param name="bytePositionInLine">The byte count within the current line (starting at 0) where the invalid JSON was encountered.</param>
129129
<summary>Creates a new exception object to relay error information to the user.</summary>
130130
<remarks>
131-
<format type="text/markdown">
132-
<![CDATA[
131+
<format type="text/markdown"><![CDATA[
133132
134133
## Remarks
135134
136135
Note that `bytePositionInLine` counts the number of bytes (that is, UTF-8 code units), and not characters or scalars.
137136
138-
]]>
139-
</format>
137+
]]></format>
140138
</remarks>
141139
</Docs>
142140
</Member>
@@ -167,15 +165,13 @@ Note that `bytePositionInLine` counts the number of bytes (that is, UTF-8 code
167165
<param name="innerException">The exception that caused the current exception.</param>
168166
<summary>Creates a new exception object to relay error information to the user that includes a specified inner exception.</summary>
169167
<remarks>
170-
<format type="text/markdown">
171-
<![CDATA[
168+
<format type="text/markdown"><![CDATA[
172169
173170
## Remarks
174171
175172
Note that the `bytePositionInLine` counts the number of bytes (that is, UTF-8 code units), and not characters or scalars.
176173
177-
]]>
178-
</format>
174+
]]></format>
179175
</remarks>
180176
</Docs>
181177
</Member>

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

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,13 @@
4242
<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>
4343
<value><see langword="true" /> if an exra comma is allowed; otherwise, <see langword="false" />.</value>
4444
<remarks>
45-
<format type="text/markdown">
46-
<![CDATA[
45+
<format type="text/markdown"><![CDATA[
4746
4847
## Remarks
4948
5049
By default, this property is set to `false`, and a <xref:System.Text.Json.JsonException> is thrown if a trailing comma is encountered.
5150
52-
]]>
53-
</format>
51+
]]></format>
5452
</remarks>
5553
</Docs>
5654
</Member>
@@ -113,15 +111,13 @@ By default, the reader throws a <xref:System.Text.Json.JsonException> if it enco
113111
<summary>Gets or sets the maximum depth allowed when reading JSON, with the default (that is, 0) indicating a maximum depth of 64. </summary>
114112
<value>The maximum depth allowed when reading JSON.</value>
115113
<remarks>
116-
<format type="text/markdown">
117-
<![CDATA[
114+
<format type="text/markdown"><![CDATA[
118115
119116
## Remarks
120117
121118
Reading past this depth will throw a <exception cref="T:System.Text.Json.JsonException>.
122119
123-
]]>
124-
</format>
120+
]]></format>
125121
</remarks>
126122
<exception cref="T:System.ArgumentOutOfRangeException">The maximum depth is being set to a negative value.</exception>
127123
</Docs>

‎xml/System.Text.Json/JsonTokenType.xml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,15 +116,13 @@
116116
<Docs>
117117
<summary>There is no value (as distinct from <see cref="F:System.Text.Json.JsonTokenType.Null" />).</summary>
118118
<remarks>
119-
<format type="text/markdown">
120-
<![CDATA[
119+
<format type="text/markdown"><![CDATA[
121120
122121
## Remarks
123122
124123
This is the default token type if no data has been read by the <xref:System.Text.Json.Utf8JsonReader>.
125124
126-
]]>
127-
</format>
125+
]]></format>
128126
</remarks>
129127
</Docs>
130128
</Member>

‎xml/System.Text.Json/Utf8JsonReader.xml

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@
2121
<Docs>
2222
<summary>Provides a high-performance API for forward-only, read-only access to the UTF-8 encoded JSON text.</summary>
2323
<remarks>
24-
<format type="text/markdown">
25-
<![CDATA[
24+
<format type="text/markdown"><![CDATA[
2625
2726
## Remarks
2827
@@ -106,8 +105,7 @@ To be able to set max depth while reading OR allow skipping comments, create an
106105
<param name="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 <see cref="T:System.Text.Json.Utf8JsonReader" /> and pass that back.</param>
107106
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> class.</summary>
108107
<remarks>
109-
<format type="text/markdown">
110-
<![CDATA[
108+
<format type="text/markdown"><![CDATA[
111109
112110
## Remarks
113111
@@ -142,8 +140,7 @@ This is the reason why the constructor accepts a <xref:System.Text.Json.JsonRead
142140
<param name="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 <see cref="T:System.Text.Json.Utf8JsonReader" /> and pass that back.</param>
143141
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> class.</summary>
144142
<remarks>
145-
<format type="text/markdown">
146-
<![CDATA[
143+
<format type="text/markdown"><![CDATA[
147144
148145
## Remarks
149146
@@ -194,8 +191,7 @@ This is the reason why the constructor accepts a <xref:System.Text.Json.JsonRead
194191
<summary>Gets the depth of the current token.</summary>
195192
<value>The depth of the current token.</value>
196193
<remarks>
197-
<format type="text/markdown">
198-
<![CDATA[
194+
<format type="text/markdown"><![CDATA[
199195
200196
## Remarks
201197
@@ -224,8 +220,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a
224220
<summary>Gets the current snapshot of the <see cref="T:System.Text.Json.Utf8JsonReader" /> state that must be captured by the caller and passed back in to the <see cref="T:System.Text.Json.Utf8JsonReader" /> constructor with more data.</summary>
225221
<value>To be added.</value>
226222
<remarks>
227-
<format type="text/markdown">
228-
<![CDATA[
223+
<format type="text/markdown"><![CDATA[
229224
230225
## Remarks
231226
@@ -873,8 +868,7 @@ The current depth exceeds the recursive limit set by the maximum depth.</excepti
873868
<Docs>
874869
<summary>Skips the children of the current JSON token.</summary>
875870
<remarks>
876-
<format type="text/markdown">
877-
<![CDATA[
871+
<format type="text/markdown"><![CDATA[
878872
879873
## Remarks
880874
@@ -884,8 +878,7 @@ When <xref:System.Text.Json.Utf8JsonReader.TokenType> (originally, or after adva
884878
885879
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.
886880
887-
]]>
888-
</format>
881+
]]></format>
889882
</remarks>
890883
<exception cref="T:System.InvalidOperationException">The reader was given partial data with more data to follow (that is, <see cref="P:System.Text.Json.Utf8JsonReader.IsFinalBlock" /> is <see langword="false" />).</exception>
891884
<exception cref="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
919912
<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>
920913
<value>The starting index of the last processed JSON token within the given UTF-8 encoded input text.</value>
921914
<remarks>
922-
<format type="text/markdown">
923-
<![CDATA[
915+
<format type="text/markdown"><![CDATA[
924916
925917
## Remarks
926918
927919
For JSON strings (including property names), this value points to before the start quote.
928920
929921
For comments, this value points to before the first comment delimiter (that is, '/').
930922
931-
]]>
932-
</format>
923+
]]></format>
933924
</remarks>
934925
</Docs>
935926
</Member>
@@ -1406,8 +1397,7 @@ This method only parses <xref:System.Guid> values with hyphens and without any s
14061397
<returns>
14071398
<see langword="true" /> if there was enough data for the children to be skipped successfully; otherwise, <see langword="false" />.</returns>
14081399
<remarks>
1409-
<format type="text/markdown">
1410-
<![CDATA[
1400+
<format type="text/markdown"><![CDATA[
14111401
14121402
## Remarks
14131403
@@ -1454,8 +1444,7 @@ The current depth exceeds the recursive limit set by the maximum depth.</excepti
14541444
Otherwise, <see cref="P:System.Text.Json.Utf8JsonReader.ValueSequence" /> contains the token value.</summary>
14551445
<value>To be added.</value>
14561446
<remarks>
1457-
<format type="text/markdown">
1458-
<![CDATA[
1447+
<format type="text/markdown"><![CDATA[
14591448
14601449
## Remarks
14611450

0 commit comments

Comments
 (0)