Skip to content

Commit 97af5ee

Browse files
gewarrengewarren
committed
remove inheritdocs that cause bad IntelliSense files
1 parent 1223b8c commit 97af5ee

24 files changed

+49
-177
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.Threading.Tasks/Task.xml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7403,7 +7403,6 @@ The returned task will complete when any of the supplied tasks has completed. T
74037403
<summary>To be added.</summary>
74047404
<returns>To be added.</returns>
74057405
<remarks>To be added.</remarks>
7406-
<inheritdoc cref="M:System.Threading.Tasks.Task.WhenEach(System.Threading.Tasks.Task[])" />
74077406
</Docs>
74087407
</Member>
74097408
<Member MemberName="WhenEach">
@@ -7455,7 +7454,6 @@ The returned task will complete when any of the supplied tasks has completed. T
74557454
<summary>To be added.</summary>
74567455
<returns>To be added.</returns>
74577456
<remarks>To be added.</remarks>
7458-
<inheritdoc cref="M:System.Threading.Tasks.Task.WhenEach(System.Threading.Tasks.Task[])" />
74597457
</Docs>
74607458
</Member>
74617459
<Member MemberName="WhenEach">
@@ -7548,7 +7546,6 @@ The returned task will complete when any of the supplied tasks has completed. T
75487546
<summary>To be added.</summary>
75497547
<returns>To be added.</returns>
75507548
<remarks>To be added.</remarks>
7551-
<inheritdoc cref="M:System.Threading.Tasks.Task.WhenEach(System.Threading.Tasks.Task[])" />
75527549
</Docs>
75537550
</Member>
75547551
<Member MemberName="WhenEach&lt;TResult&gt;">
@@ -7611,7 +7608,6 @@ The returned task will complete when any of the supplied tasks has completed. T
76117608
<summary>To be added.</summary>
76127609
<returns>To be added.</returns>
76137610
<remarks>To be added.</remarks>
7614-
<inheritdoc cref="M:System.Threading.Tasks.Task.WhenEach(System.Threading.Tasks.Task[])" />
76157611
</Docs>
76167612
</Member>
76177613
<Member MemberName="WhenEach&lt;TResult&gt;">
@@ -7665,7 +7661,6 @@ The returned task will complete when any of the supplied tasks has completed. T
76657661
<summary>To be added.</summary>
76667662
<returns>To be added.</returns>
76677663
<remarks>To be added.</remarks>
7668-
<inheritdoc cref="M:System.Threading.Tasks.Task.WhenEach(System.Threading.Tasks.Task[])" />
76697664
</Docs>
76707665
</Member>
76717666
<Member MemberName="Yield">

‎xml/System/Byte.xml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2234,7 +2234,6 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
22342234

22352235
]]></format>
22362236
</remarks>
2237-
<inheritdoc cref="M:System.Numerics.INumber`1.Sign(`0)" />
22382237
</Docs>
22392238
</Member>
22402239
<Member MemberName="System.IComparable.CompareTo">
@@ -3352,7 +3351,6 @@ This member is an explicit interface member implementation. It can be used only
33523351
<summary>Gets the number of bytes that will be written as part of <see cref="M:System.Numerics.IBinaryInteger`1.TryWriteLittleEndian(System.Span{System.Byte},System.Int32@)" />.</summary>
33533352
<returns>The number of bytes that will be written as part of <see cref="M:System.Numerics.IBinaryInteger`1.TryWriteLittleEndian(System.Span{System.Byte},System.Int32@)" />.</returns>
33543353
<remarks>To be added.</remarks>
3355-
<inheritdoc cref="M:System.Numerics.IBinaryInteger`1.GetByteCount" />
33563354
</Docs>
33573355
</Member>
33583356
<Member MemberName="System.Numerics.IBinaryInteger&lt;System.Byte&gt;.GetShortestBitLength">

‎xml/System/Char.xml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6147,7 +6147,6 @@ This member is an explicit interface member implementation. It can be used only
61476147
<summary>Gets the number of bytes that will be written as part of <see cref="M:System.Numerics.IBinaryInteger`1.TryWriteLittleEndian(System.Span{System.Byte},System.Int32@)" />.</summary>
61486148
<returns>The number of bytes that will be written as part of <see cref="M:System.Numerics.IBinaryInteger`1.TryWriteLittleEndian(System.Span{System.Byte},System.Int32@)" />.</returns>
61496149
<remarks>To be added.</remarks>
6150-
<inheritdoc cref="M:System.Numerics.IBinaryInteger`1.GetByteCount" />
61516150
</Docs>
61526151
</Member>
61536152
<Member MemberName="System.Numerics.IBinaryInteger&lt;System.Char&gt;.GetShortestBitLength">

‎xml/System/DateTime.xml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5131,7 +5131,6 @@ juillet 2009
51315131
The equivalent method for this operator is <xref:System.DateTime.Compare%28System.DateTime%2CSystem.DateTime%29?displayProperty=nameWithType>]]></format>
51325132
</remarks>
51335133
<altmember cref="M:System.DateTime.CompareTo(System.DateTime)" />
5134-
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_GreaterThan(`0,`1)" />
51355134
</Docs>
51365135
</Member>
51375136
<Member MemberName="op_GreaterThanOrEqual">
@@ -5198,7 +5197,6 @@ juillet 2009
51985197
The equivalent method for this operator is <xref:System.DateTime.Compare%28System.DateTime%2CSystem.DateTime%29?displayProperty=nameWithType>]]></format>
51995198
</remarks>
52005199
<altmember cref="M:System.DateTime.CompareTo(System.DateTime)" />
5201-
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_GreaterThanOrEqual(`0,`1)" />
52025200
</Docs>
52035201
</Member>
52045202
<Member MemberName="op_Inequality">
@@ -5331,7 +5329,6 @@ juillet 2009
53315329
The equivalent method for this operator is <xref:System.DateTime.Compare%28System.DateTime%2CSystem.DateTime%29?displayProperty=nameWithType>]]></format>
53325330
</remarks>
53335331
<altmember cref="M:System.DateTime.CompareTo(System.DateTime)" />
5334-
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_LessThan(`0,`1)" />
53355332
</Docs>
53365333
</Member>
53375334
<Member MemberName="op_LessThanOrEqual">
@@ -5398,7 +5395,6 @@ juillet 2009
53985395
The equivalent method for this operator is <xref:System.DateTime.Compare%28System.DateTime%2CSystem.DateTime%29?displayProperty=nameWithType>]]></format>
53995396
</remarks>
54005397
<altmember cref="M:System.DateTime.CompareTo(System.DateTime)" />
5401-
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_LessThanOrEqual(`0,`1)" />
54025398
</Docs>
54035399
</Member>
54045400
<MemberGroup MemberName="op_Subtraction">

‎xml/System/DateTimeOffset.xml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3652,7 +3652,6 @@ If you rely on properties such as <xref:System.DateTimeOffset.Now> or <xref:Syst
36523652

36533653
The equivalent method for this operator is <xref:System.DateTimeOffset.Compare%28System.DateTimeOffset%2CSystem.DateTimeOffset%29?displayProperty=nameWithType>]]></format>
36543654
</remarks>
3655-
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_GreaterThan(`0,`1)" />
36563655
</Docs>
36573656
</Member>
36583657
<Member MemberName="op_GreaterThanOrEqual">
@@ -3725,7 +3724,6 @@ If you rely on properties such as <xref:System.DateTimeOffset.Now> or <xref:Syst
37253724

37263725
The equivalent method for this operator is <xref:System.DateTimeOffset.Compare%28System.DateTimeOffset%2CSystem.DateTimeOffset%29?displayProperty=nameWithType>]]></format>
37273726
</remarks>
3728-
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_GreaterThanOrEqual(`0,`1)" />
37293727
</Docs>
37303728
</Member>
37313729
<Member MemberName="op_Implicit">
@@ -3942,7 +3940,6 @@ If you rely on properties such as <xref:System.DateTimeOffset.Now> or <xref:Syst
39423940

39433941
The equivalent method for this operator is <xref:System.DateTimeOffset.Compare%28System.DateTimeOffset%2CSystem.DateTimeOffset%29?displayProperty=nameWithType>]]></format>
39443942
</remarks>
3945-
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_LessThan(`0,`1)" />
39463943
</Docs>
39473944
</Member>
39483945
<Member MemberName="op_LessThanOrEqual">
@@ -4015,7 +4012,6 @@ If you rely on properties such as <xref:System.DateTimeOffset.Now> or <xref:Syst
40154012

40164013
The equivalent method for this operator is <xref:System.DateTimeOffset.Compare%28System.DateTimeOffset%2CSystem.DateTimeOffset%29?displayProperty=nameWithType>]]></format>
40174014
</remarks>
4018-
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_LessThanOrEqual(`0,`1)" />
40194015
</Docs>
40204016
</Member>
40214017
<MemberGroup MemberName="op_Subtraction">

0 commit comments

Comments
 (0)