Skip to content

Commit eb63b3e

Browse files
authored
fix cdata formatting (#2855)
1 parent 7f1dd78 commit eb63b3e

File tree

10 files changed

+28
-54
lines changed

10 files changed

+28
-54
lines changed

xml/System.Text.RegularExpressions/GroupCollection.xml

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -816,16 +816,13 @@ This member is an explicit interface member implementation. It can be used only
816816
<summary>Provides an enumerator that iterates through the group collection.</summary>
817817
<returns>An enumerator that contains all names and objects in the <see cref="T:System.Text.RegularExpressions.Group" /> collection.</returns>
818818
<remarks>
819-
<format type="text/markdown">
820-
<![CDATA[
819+
<format type="text/markdown"><![CDATA[
821820
822821
## Remarks
823822
824-
825823
Instead of calling this method to retrieve an enumerator that lets you iterate through the <xref:System.Text.RegularExpressions.Group> objects in the collection, you should use the group iteration construct (such as `foreach` in C# and `For Each`…`Next` in Visual Basic) that is provided by your programming language.
826824
827-
]]>
828-
</format>
825+
]]></format>
829826
</remarks>
830827
</Docs>
831828
</Member>
@@ -859,15 +856,13 @@ Instead of calling this method to retrieve an enumerator that lets you iterate t
859856
<summary>Provides an enumerator that iterates through the group collection.</summary>
860857
<returns>An enumerator that contains all <see cref="T:System.Text.RegularExpressions.Group" /> objects in the group collection.</returns>
861858
<remarks>
862-
<format type="text/markdown">
863-
<![CDATA[
859+
<format type="text/markdown"><![CDATA[
864860
865861
## Remarks
866862
867863
Instead of calling this method to retrieve an enumerator that lets you iterate through the <xref:System.Text.RegularExpressions.Group> objects in the collection, you should use the group iteration construct (such as `foreach` in C# and `For Each`…`Next` in Visual Basic) that is provided by your programming language.
868864
869-
]]>
870-
</format>
865+
]]></format>
871866
</remarks>
872867
</Docs>
873868
</Member>

xml/System/FormattableString.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,7 @@
146146
<summary>Returns a result string in which arguments are formatted by using the conventions of the current culture.</summary>
147147
<returns>The string that results from formatting the current instance by using the conventions of the current culture.</returns>
148148
<remarks>
149-
<format type="text/markdown">
150-
<![CDATA[
149+
<format type="text/markdown"><![CDATA[
151150
152151
### Remarks
153152
@@ -163,7 +162,8 @@ Within the scope of that import directive, an interpolated string may be formatt
163162
CurrentCulture($"{{ lat = {latitude}; lon = {longitude} }}");
164163
```
165164
166-
]]></format>.</remarks>
165+
]]></format>
166+
</remarks>
167167
</Docs>
168168
</Member>
169169
<Member MemberName="Format">

xml/System/Index.xml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,13 @@
6969
<param name="fromEnd">A boolean indicating if the index is from the start (<see langword="false" />) or from the end (<see langword="true" />) of a collection.</param>
7070
<summary>Initializes a new <see cref="T:System.Index" /> with a specified index position and a value that indicates if the index is from the start or the end of a collection.</summary>
7171
<remarks>
72-
<format type="text/markdown">
73-
<![CDATA[
72+
<format type="text/markdown"><![CDATA[
7473
7574
### Remarks
7675
7776
If the <see cref="T:System.Index" /> is constructed from the end, an index value of 1 points to the last element, and an index value of 0 points beyond last element.
7877
79-
]]>
80-
</format>
78+
]]></format>
8179
</remarks>
8280
</Docs>
8381
</Member>
@@ -278,17 +276,15 @@ If the <see cref="T:System.Index" /> is constructed from the end, an index value
278276
<summary>Calculates the offset from the start using the given collection length.</summary>
279277
<returns>The offset.</returns>
280278
<remarks>
281-
<format type="text/markdown">
282-
<![CDATA[
279+
<format type="text/markdown"><![CDATA[
283280
284281
## Remarks
285282
286283
For performance reasons, this method does not validate if `length` or the returned value are negative. It also doesn't validate if the returned value is greater than `length`.
287284
288285
Collections are not expected to have a non-negative length/count. If this method's returned offset is negative and is then used to index a collection, the runtime will throw <xref:System.ArgumentOutOfRangeException>, which will have the same effect as validation.
289286
290-
]]>
291-
</format>
287+
]]></format>
292288
</remarks>
293289
</Docs>
294290
</Member>

xml/System/Range.xml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@
2929
<Docs>
3030
<summary>Represents a range that has start and end indexes.</summary>
3131
<remarks>
32-
<format type="text/markdown">
33-
<![CDATA[
32+
<format type="text/markdown"><![CDATA[
3433
3534
### Remarks
3635
@@ -42,8 +41,7 @@
4241
int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 }
4342
```
4443
45-
]]>
46-
</format>
44+
]]></format>
4745
</remarks>
4846
</Docs>
4947
<Members>
@@ -267,15 +265,13 @@
267265
<summary>Returns a <see cref="T:System.Range.OffsetAndLength" /> instance with the starting offset and length of a range.</summary>
268266
<returns>The starting offset and length of the range.</returns>
269267
<remarks>
270-
<format type="text/markdown">
271-
<![CDATA[
268+
<format type="text/markdown"><![CDATA[
272269
273270
## Remarks
274271
275272
For performance reasons, this method does't validate `length` to ensure that it is not negative. It does ensure that `length` is within the current `Range` instance.
276273
277-
]]>
278-
</format>
274+
]]></format>
279275
</remarks>
280276
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="length" /> is outside the bounds of the current range. </exception>
281277
</Docs>

xml/System/ReadOnlySpan`1.xml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,15 +145,13 @@ A `ReadOnlySpan<T>` instance is often used to reference the elements of an array
145145
<param name="length">The number of elements to include.</param>
146146
<summary>Creates a new <see cref="T:System.ReadOnlySpan`1" /> that includes a specified number of elements of an array starting at a specified index.</summary>
147147
<remarks>
148-
<format type="text/markdown">
149-
<![CDATA[
148+
<format type="text/markdown"><![CDATA[
150149
151150
### Remarks
152151
153152
This method returns `default` when `array` is `null`.
154153
155-
]]>
156-
</format>
154+
]]></format>
157155
</remarks>
158156
<exception cref="T:System.ArgumentOutOfRangeException">
159157
<paramref name="array" /> is <see langword="null" />, but <paramref name="start" /> or <paramref name="length" /> is non-zero.

xml/System/SequencePosition.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,7 @@ Equality does not guarantee that the two instances point to the same location in
143143
144144
Equality does not guarantee that the two instances point to the same location in a <xref:System.Buffers.ReadOnlySequence`1>.
145145
146-
]]>
147-
</format>
146+
]]></format>
148147
</remarks>
149148
</Docs>
150149
</Member>

xml/System/Span`1.xml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,15 +201,13 @@ If `array` is `null`, this constructor returns a `null` `Span<T>`.
201201
<param name="length">The number of elements to include in the new <see cref="T:System.Span`1" />. </param>
202202
<summary>Creates a new <see cref="T:System.Span`1" /> object that includes a specified number of elements of an array starting at a specified index.</summary>
203203
<remarks>
204-
<format type="text/markdown">
205-
<![CDATA[
204+
<format type="text/markdown"><![CDATA[
206205
207206
### Remarks
208207
209208
This method returns `default` when `array` is `null`.
210209
211-
]]>
212-
</format>
210+
]]></format>
213211
</remarks>
214212
<exception cref="T:System.ArgumentOutOfRangeException">
215213
<paramref name="array" /> is <see langword="null" />, but <paramref name="start" /> or <paramref name="length" /> is non-zero.

xml/System/String.xml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4764,15 +4764,13 @@ Depending on Why you want to call the `Copy` method, there are a number of alter
47644764
<summary>Returns an enumeration of <see cref="T:System.Text.Rune" /> from this string.</summary>
47654765
<returns>A string rune enumerator.</returns>
47664766
<remarks>
4767-
<format type="text/markdown">
4768-
<![CDATA[
4767+
<format type="text/markdown"><![CDATA[
47694768

47704769
### Remarks
47714770

47724771
Invalid sequences are represented in the enumeration by <xref:System.Text.Rune.ReplacementChar?displayProperty=nameWithType>.
47734772

4774-
]]>
4775-
</format>
4773+
]]></format>
47764774
</remarks>
47774775
</Docs>
47784776
</Member>
@@ -6425,15 +6423,13 @@ String 'This is a string.' in domain 'NewDomain': 75CC8236
64256423
<summary>Returns a reference to the element of the string at index zero.</summary>
64266424
<returns>A character representing the reference to the element of the string at index zero.</returns>
64276425
<remarks>
6428-
<format type="text/markdown">
6429-
<![CDATA[
6426+
<format type="text/markdown"><![CDATA[
64306427

64316428
## Remarks
64326429

64336430
The `GetPinnableReference` method returns a character that can be used for pinning a <xref:System.String> in memory. It is required to support the use of a <xref:System.String> within a fixed statement.
64346431

6435-
]]>
6436-
</format>
6432+
]]></format>
64376433
</remarks>
64386434
<exception cref="T:System.NullReferenceException">The string is null.</exception>
64396435
</Docs>

xml/System/ValueTuple.xml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1125,15 +1125,13 @@ The <xref:System.ValueTuple> type is not serializable in .NET Core 1.x or in the
11251125
<summary>Returns the string representation of this <see cref="T:System.ValueTuple" /> instance.</summary>
11261126
<returns>This method always returns "()".</returns>
11271127
<remarks>
1128-
<format type="text/markdown">
1129-
<![CDATA[
1128+
<format type="text/markdown"><![CDATA[
11301129
11311130
## Remarks
11321131
11331132
The string returned by this method takes the form `()`.
11341133
1135-
]]>
1136-
</format>
1134+
]]></format>
11371135
</remarks>
11381136
</Docs>
11391137
</Member>

xml/System/ValueTuple`2.xml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -514,17 +514,15 @@ The <xref:System.ValueTuple%602> type is not serializable in .NET Core 1.x or in
514514
<returns>
515515
<see langword="true" /> if the current instance is equal to the specified objects; otherwise, <see langword="false" />.</returns>
516516
<remarks>
517-
<format type="text/markdown">
518-
<![CDATA[
517+
<format type="text/markdown"><![CDATA[
519518
520519
### Remarks
521520
522521
This member is an explicit interface member implementation. It can be used only when the <xref:System.ValueTuple`2> instance is cast to an <xref:System.Collections.IStructuralEquatable> interface.
523522
524523
The <xref:System.Collections.IEqualityComparer.Equals(System.Object,System.Object)?displayProperty=nameWithType> implementation is called only if `other` is not `null`, and if it can be successfully cast to a <xref:System.ValueTuple`2> whose components are of the same types as those of the current instance. The <xref:System.Collections.IStructuralEquatable.Equals(System.Object,System.Collections.IEqualityComparer)?displayProperty=nameWithType> method first passes the <xref:System.ValueTuple`2.Item1> values of the <xref:System.ValueTuple`2> objects to be compared to the <xref:System.Collections.IEqualityComparer.Equals(System.Object,System.Object)> implementation. If this method call returns `true`, the method is called again and passed the <xref:System.ValueTuple`2.Item2> values of the two <xref:System.ValueTuple`2> instances.
525524
526-
]]>
527-
</format>
525+
]]></format>
528526
</remarks>
529527
</Docs>
530528
</Member>

0 commit comments

Comments
 (0)