Skip to content

Commit b8e269c

Browse files
dotnet-policy-service[bot]dotnet-policy-service[bot]
authored
Merge pull request #11286 from dotnet/main
Merge main into live
2 parents d2c6e01 + a51f50c commit b8e269c

File tree

60 files changed

+764
-1073
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+764
-1073
lines changed

‎xml/System.CodeDom.Compiler/IndentedTextWriter.xml

Lines changed: 47 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -71,25 +71,25 @@
7171
<Docs>
7272
<summary>Provides a text writer that can indent new lines by a tab string token.</summary>
7373
<remarks>
74-
<format type="text/markdown"><![CDATA[
75-
76-
## Remarks
77-
<xref:System.CodeDom.Compiler.IndentedTextWriter> extends a <xref:System.IO.TextWriter> by providing methods that insert a tab string and track the current indentation level. Text formatted with multiple indentation levels is useful for generated code, so this class is used by CodeDOM code generator implementations.
78-
79-
The tab string is the string that each indentation consists of. Typically the tab string contains white space.
80-
74+
<format type="text/markdown"><![CDATA[
75+
76+
## Remarks
77+
<xref:System.CodeDom.Compiler.IndentedTextWriter> extends a <xref:System.IO.TextWriter> by providing methods that insert a tab string and track the current indentation level. Text formatted with multiple indentation levels is useful for generated code, so this class is used by CodeDOM code generator implementations.
78+
79+
The tab string is the string that each indentation consists of. Typically the tab string contains white space.
80+
8181
> [!NOTE]
82-
> This class contains a link demand and an inheritance demand at the class level that applies to all members. A <xref:System.Security.SecurityException> is thrown when either the immediate caller or the derived class does not have full-trust permission. For details about security demands, see [Link Demands](/dotnet/framework/misc/link-demands) and [Inheritance Demands](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)).
83-
84-
85-
86-
## Examples
87-
The following code example demonstrates using an <xref:System.CodeDom.Compiler.IndentedTextWriter> to write text at different levels of indentation.
88-
82+
> This class contains a link demand and an inheritance demand at the class level that applies to all members. A <xref:System.Security.SecurityException> is thrown when either the immediate caller or the derived class does not have full-trust permission. For details about security demands, see [Link Demands](/dotnet/framework/misc/link-demands) and [Inheritance Demands](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/x4yx82e6(v=vs.100)).
83+
84+
85+
86+
## Examples
87+
The following code example demonstrates using an <xref:System.CodeDom.Compiler.IndentedTextWriter> to write text at different levels of indentation.
88+
8989
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/IndentedTextWriterExample/CPP/form1.cpp" id="Snippet1":::
9090
:::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/IndentedTextWriter/Overview/form1.cs" id="Snippet1":::
91-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/IndentedTextWriterExample/VB/form1.vb" id="Snippet1":::
92-
91+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/IndentedTextWriterExample/VB/form1.vb" id="Snippet1":::
92+
9393
]]></format>
9494
</remarks>
9595
</Docs>
@@ -205,15 +205,15 @@
205205
<param name="tabString">The tab string to use for indentation.</param>
206206
<summary>Initializes a new instance of the <see cref="T:System.CodeDom.Compiler.IndentedTextWriter" /> class using the specified text writer and tab string.</summary>
207207
<remarks>
208-
<format type="text/markdown"><![CDATA[
209-
210-
## Examples
211-
The following code example demonstrates creating an <xref:System.CodeDom.Compiler.IndentedTextWriter> using a specified tab string.
212-
208+
<format type="text/markdown"><![CDATA[
209+
210+
## Examples
211+
The following code example demonstrates creating an <xref:System.CodeDom.Compiler.IndentedTextWriter> using a specified tab string.
212+
213213
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/IndentedTextWriterExample/CPP/form1.cpp" id="Snippet3":::
214214
:::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/IndentedTextWriter/Overview/form1.cs" id="Snippet3":::
215-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/IndentedTextWriterExample/VB/form1.vb" id="Snippet3":::
216-
215+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/IndentedTextWriterExample/VB/form1.vb" id="Snippet3":::
216+
217217
]]></format>
218218
</remarks>
219219
<altmember cref="T:System.IO.TextWriter" />
@@ -310,11 +310,11 @@
310310
<Docs>
311311
<summary>Specifies the default tab string. This field is constant.</summary>
312312
<remarks>
313-
<format type="text/markdown"><![CDATA[
314-
315-
## Remarks
316-
The default tab string consists of a single white space. (" ")
317-
313+
<format type="text/markdown"><![CDATA[
314+
315+
## Remarks
316+
The default tab string consists of a single white space. (" ")
317+
318318
]]></format>
319319
</remarks>
320320
</Docs>
@@ -352,7 +352,6 @@
352352
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.</summary>
353353
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> representing the asynchronous dispose operation.</returns>
354354
<remarks>To be added.</remarks>
355-
<inheritdoc />
356355
</Docs>
357356
</Member>
358357
<Member MemberName="Encoding">
@@ -447,11 +446,11 @@
447446
<Docs>
448447
<summary>Flushes the stream.</summary>
449448
<remarks>
450-
<format type="text/markdown"><![CDATA[
451-
452-
## Remarks
453-
This clears the stream of any data.
454-
449+
<format type="text/markdown"><![CDATA[
450+
451+
## Remarks
452+
This clears the stream of any data.
453+
455454
]]></format>
456455
</remarks>
457456
</Docs>
@@ -489,7 +488,6 @@
489488
<summary>Clears all buffers for this <see cref="T:System.CodeDom.Compiler.IndentedTextWriter" /> asynchronously and causes any buffered data to be written to the underlying device.</summary>
490489
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous flush operation.</returns>
491490
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:System.CodeDom.Compiler.IndentedTextWriter.Flush" />.</remarks>
492-
<inheritdoc />
493491
</Docs>
494492
</Member>
495493
<Member MemberName="FlushAsync">
@@ -580,15 +578,15 @@
580578
<summary>Gets or sets the number of spaces to indent.</summary>
581579
<value>The number of spaces to indent.</value>
582580
<remarks>
583-
<format type="text/markdown"><![CDATA[
584-
585-
## Examples
586-
The following code example demonstrates setting the indentation level of an <xref:System.CodeDom.Compiler.IndentedTextWriter>. The indentation level is the number of tab strings to prefix each line with.
587-
581+
<format type="text/markdown"><![CDATA[
582+
583+
## Examples
584+
The following code example demonstrates setting the indentation level of an <xref:System.CodeDom.Compiler.IndentedTextWriter>. The indentation level is the number of tab strings to prefix each line with.
585+
588586
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/IndentedTextWriterExample/CPP/form1.cpp" id="Snippet3":::
589587
:::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/IndentedTextWriter/Overview/form1.cs" id="Snippet3":::
590-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/IndentedTextWriterExample/VB/form1.vb" id="Snippet3":::
591-
588+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/IndentedTextWriterExample/VB/form1.vb" id="Snippet3":::
589+
592590
]]></format>
593591
</remarks>
594592
</Docs>
@@ -2687,7 +2685,6 @@
26872685
<summary>Asynchronously writes the line terminator to the underlying <see cref="T:System.IO.TextWriter" />.</summary>
26882686
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous line writing operation.</returns>
26892687
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:System.CodeDom.Compiler.IndentedTextWriter.WriteLine" />.</remarks>
2690-
<inheritdoc />
26912688
</Docs>
26922689
</Member>
26932690
<Member MemberName="WriteLineAsync">
@@ -2957,15 +2954,15 @@
29572954
<param name="s">The string to write.</param>
29582955
<summary>Writes the specified string to a line without tabs.</summary>
29592956
<remarks>
2960-
<format type="text/markdown"><![CDATA[
2961-
2962-
## Examples
2963-
The following code example demonstrates writing a line without tab string indentations.
2964-
2957+
<format type="text/markdown"><![CDATA[
2958+
2959+
## Examples
2960+
The following code example demonstrates writing a line without tab string indentations.
2961+
29652962
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/IndentedTextWriterExample/CPP/form1.cpp" id="Snippet6":::
29662963
:::code language="csharp" source="~/snippets/csharp/System.CodeDom.Compiler/IndentedTextWriter/Overview/form1.cs" id="Snippet6":::
2967-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/IndentedTextWriterExample/VB/form1.vb" id="Snippet6":::
2968-
2964+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/IndentedTextWriterExample/VB/form1.vb" id="Snippet6":::
2965+
29692966
]]></format>
29702967
</remarks>
29712968
</Docs>

‎xml/System.Collections.Frozen/FrozenDictionary`2.xml

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -848,7 +848,6 @@
848848
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
849849
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
850850
<remarks>To be added.</remarks>
851-
<inheritdoc />
852851
</Docs>
853852
</Member>
854853
<Member MemberName="System.Collections.ICollection.IsSynchronized">
@@ -876,7 +875,6 @@
876875
<value>
877876
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
878877
<remarks>To be added.</remarks>
879-
<inheritdoc />
880878
</Docs>
881879
</Member>
882880
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -903,7 +901,6 @@
903901
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
904902
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
905903
<remarks>To be added.</remarks>
906-
<inheritdoc />
907904
</Docs>
908905
</Member>
909906
<Member MemberName="System.Collections.IDictionary.Add">
@@ -935,7 +932,6 @@
935932
<param name="value">The <see cref="T:System.Object" /> to use as the value of the element to add.</param>
936933
<summary>Adds an element with the provided key and value to the <see cref="T:System.Collections.IDictionary" /> object.</summary>
937934
<remarks>To be added.</remarks>
938-
<inheritdoc />
939935
</Docs>
940936
</Member>
941937
<Member MemberName="System.Collections.IDictionary.Clear">
@@ -962,7 +958,6 @@
962958
<Docs>
963959
<summary>Removes all elements from the <see cref="T:System.Collections.IDictionary" /> object.</summary>
964960
<remarks>To be added.</remarks>
965-
<inheritdoc />
966961
</Docs>
967962
</Member>
968963
<Member MemberName="System.Collections.IDictionary.Contains">
@@ -994,7 +989,6 @@
994989
<returns>
995990
<see langword="true" /> if the <see cref="T:System.Collections.IDictionary" /> contains an element with the key; otherwise, <see langword="false" />.</returns>
996991
<remarks>To be added.</remarks>
997-
<inheritdoc />
998992
</Docs>
999993
</Member>
1000994
<Member MemberName="System.Collections.IDictionary.GetEnumerator">
@@ -1022,7 +1016,6 @@
10221016
<summary>Returns an <see cref="T:System.Collections.IDictionaryEnumerator" /> object for the <see cref="T:System.Collections.IDictionary" /> object.</summary>
10231017
<returns>An <see cref="T:System.Collections.IDictionaryEnumerator" /> object for the <see cref="T:System.Collections.IDictionary" /> object.</returns>
10241018
<remarks>To be added.</remarks>
1025-
<inheritdoc />
10261019
</Docs>
10271020
</Member>
10281021
<Member MemberName="System.Collections.IDictionary.IsFixedSize">
@@ -1050,7 +1043,6 @@
10501043
<value>
10511044
<see langword="true" /> if the <see cref="T:System.Collections.IDictionary" /> object has a fixed size; otherwise, <see langword="false" />.</value>
10521045
<remarks>To be added.</remarks>
1053-
<inheritdoc />
10541046
</Docs>
10551047
</Member>
10561048
<Member MemberName="System.Collections.IDictionary.IsReadOnly">
@@ -1078,7 +1070,6 @@
10781070
<value>
10791071
<see langword="true" /> if the <see cref="T:System.Collections.IDictionary" /> object is read-only; otherwise, <see langword="false" />.</value>
10801072
<remarks>To be added.</remarks>
1081-
<inheritdoc />
10821073
</Docs>
10831074
</Member>
10841075
<Member MemberName="System.Collections.IDictionary.Item">
@@ -1142,7 +1133,6 @@
11421133
<summary>Gets an <see cref="T:System.Collections.ICollection" /> object containing the keys of the <see cref="T:System.Collections.IDictionary" /> object.</summary>
11431134
<value>An <see cref="T:System.Collections.ICollection" /> object containing the keys of the <see cref="T:System.Collections.IDictionary" /> object.</value>
11441135
<remarks>To be added.</remarks>
1145-
<inheritdoc />
11461136
</Docs>
11471137
</Member>
11481138
<Member MemberName="System.Collections.IDictionary.Remove">
@@ -1172,7 +1162,6 @@
11721162
<param name="key">The key of the element to remove.</param>
11731163
<summary>Removes the element with the specified key from the <see cref="T:System.Collections.IDictionary" /> object.</summary>
11741164
<remarks>To be added.</remarks>
1175-
<inheritdoc />
11761165
</Docs>
11771166
</Member>
11781167
<Member MemberName="System.Collections.IDictionary.Values">
@@ -1199,7 +1188,6 @@
11991188
<summary>Gets an <see cref="T:System.Collections.ICollection" /> object containing the values in the <see cref="T:System.Collections.IDictionary" /> object.</summary>
12001189
<value>An <see cref="T:System.Collections.ICollection" /> object containing the values in the <see cref="T:System.Collections.IDictionary" /> object.</value>
12011190
<remarks>To be added.</remarks>
1202-
<inheritdoc />
12031191
</Docs>
12041192
</Member>
12051193
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -1227,7 +1215,6 @@
12271215
<summary>Returns an enumerator that iterates through a collection.</summary>
12281216
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
12291217
<remarks>To be added.</remarks>
1230-
<inheritdoc />
12311218
</Docs>
12321219
</Member>
12331220
<Member MemberName="TryGetAlternateLookup&lt;TAlternateKey&gt;">

‎xml/System.Collections.Frozen/FrozenSet`1.xml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -862,7 +862,6 @@
862862
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
863863
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
864864
<remarks>To be added.</remarks>
865-
<inheritdoc />
866865
</Docs>
867866
</Member>
868867
<Member MemberName="System.Collections.ICollection.IsSynchronized">
@@ -890,7 +889,6 @@
890889
<value>
891890
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
892891
<remarks>To be added.</remarks>
893-
<inheritdoc />
894892
</Docs>
895893
</Member>
896894
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -917,7 +915,6 @@
917915
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
918916
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
919917
<remarks>To be added.</remarks>
920-
<inheritdoc />
921918
</Docs>
922919
</Member>
923920
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -945,7 +942,6 @@
945942
<summary>Returns an enumerator that iterates through a collection.</summary>
946943
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
947944
<remarks>To be added.</remarks>
948-
<inheritdoc />
949945
</Docs>
950946
</Member>
951947
<Member MemberName="TryGetAlternateLookup&lt;TAlternate&gt;">

‎xml/System.Collections.Generic/OrderedDictionary`2+Enumerator.xml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,6 @@
130130
<summary>Gets both the key and the value of the current dictionary entry.</summary>
131131
<value>A <see cref="T:System.Collections.DictionaryEntry" /> containing both the key and the value of the current dictionary entry.</value>
132132
<remarks>This member is an explicit interface member implementation. It can be used only when the &lt;xref:System.Collections.Generic.OrderedDictionary`2.Enumerator&gt; instance is cast to an &lt;xref:System.Collections.IDictionaryEnumerator&gt; interface.</remarks>
133-
<inheritdoc />
134133
</Docs>
135134
</Member>
136135
<Member MemberName="System.Collections.IDictionaryEnumerator.Key">

0 commit comments

Comments
 (0)