Skip to content

Remove .NET Framework remarks (System.Runtime.CompilerServices) #12666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gewarren wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remove .NET Framework remarks (System.Runtime.CompilerServices) #12666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 34 additions & 34 deletions xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@
<Docs>
<summary>Represents a builder for asynchronous methods that return a task.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -219,7 +219,7 @@
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
<param name="awaiter">The awaiter.</param>
<param name="stateMachine">The state machine.</param>
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes. This method can be called from partially trusted code.</summary>
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -267,11 +267,11 @@
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncTaskMethodBuilder" /> type.</summary>
<returns>A new instance of the builder.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -322,19 +322,19 @@
<param name="exception">The exception to bind to the task.</param>
<summary>Marks the task as failed and binds the specified exception to the task.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="exception" /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The task has already completed.
-or-
<exception cref="T:System.InvalidOperationException">The task has already completed.

-or-

The builder is not initialized.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -381,17 +381,17 @@
<Docs>
<summary>Marks the task as successfully completed.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The task has already completed.
-or-
<exception cref="T:System.InvalidOperationException">The task has already completed.

-or-

The builder is not initialized.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -553,11 +553,11 @@
<summary>Gets the task for this builder.</summary>
<value>The task for this builder.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The builder is not initialized.</exception>
Expand Down
52 changes: 26 additions & 26 deletions xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,11 @@
<typeparam name="TResult">The result to use to complete the task.</typeparam>
<summary>Represents a builder for asynchronous methods that returns a task and provides a parameter for the result.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -230,7 +230,7 @@
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
<param name="awaiter">The awaiter.</param>
<param name="stateMachine">The state machine.</param>
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes. This method can be called from partially trusted code.</summary>
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -284,11 +284,11 @@
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1" /> class.</summary>
<returns>A new instance of the builder.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -339,11 +339,11 @@
<param name="exception">The exception to bind to the task.</param>
<summary>Marks the task as failed and binds the specified exception to the task.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
Expand Down Expand Up @@ -397,11 +397,11 @@
<param name="result">The result to use to complete the task.</param>
<summary>Marks the task as successfully completed.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The task has already completed.</exception>
Expand Down Expand Up @@ -565,11 +565,11 @@
<summary>Gets the task for this builder.</summary>
<value>The task for this builder.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
</Docs>
Expand Down
42 changes: 21 additions & 21 deletions xml/System.Runtime.CompilerServices/AsyncVoidMethodBuilder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@
<Docs>
<summary>Represents a builder for asynchronous methods that do not return a value.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -219,7 +219,7 @@
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
<param name="awaiter">The awaiter.</param>
<param name="stateMachine">The state machine.</param>
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes. This method can be called from partially trusted code.</summary>
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -267,11 +267,11 @@
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncVoidMethodBuilder" /> class.</summary>
<returns>A new instance of the builder.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -322,11 +322,11 @@
<param name="exception">The exception to bind.</param>
<summary>Binds an exception to the method builder.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
Expand Down Expand Up @@ -377,11 +377,11 @@
<Docs>
<summary>Marks the method builder as successfully completed.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type and its members are intended for use by the compiler.
<format type="text/markdown"><![CDATA[

## Remarks
This type and its members are intended for use by the compiler.

]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The builder is not initialized.</exception>
Expand Down
12 changes: 6 additions & 6 deletions xml/System.Runtime.CompilerServices/CompilationRelaxations.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@
<Docs>
<summary>Specifies parameters that control the strictness of the code generated by the common language runtime's just-in-time (JIT) compiler.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Runtime.CompilerServices.CompilationRelaxations> enumeration with the <xref:System.Runtime.CompilerServices.CompilationRelaxationsAttribute> attribute.
<format type="text/markdown"><![CDATA[

## Remarks
Use the <xref:System.Runtime.CompilerServices.CompilationRelaxations> enumeration with the <xref:System.Runtime.CompilerServices.CompilationRelaxationsAttribute> attribute.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -96,7 +96,7 @@
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary>Marks an assembly as not requiring string-literal interning. In an application domain, the common language runtime creates one string object for each unique string literal, rather than making multiple copies. This behavior, called <see href="https://learn.microsoft.com/dotnet/api/system.string.intern">string interning</see>, internally requires building auxiliary tables that consume memory resources.</summary>
<summary>Marks an assembly as not requiring string-literal interning. Te common language runtime creates one string object for each unique string literal, rather than making multiple copies. This behavior, called <see href="https://learn.microsoft.com/dotnet/api/system.string.intern">string interning</see>, internally requires building auxiliary tables that consume memory resources.</summary>
</Docs>
</Member>
</Members>
Expand Down
8 changes: 0 additions & 8 deletions xml/System.Runtime.CompilerServices/CompilationRelaxationsAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,8 @@
## Remarks
Apply the <xref:System.Runtime.CompilerServices.CompilationRelaxationsAttribute> attribute to assemblies to specify assembly compilation parameters. Use the <xref:System.Runtime.CompilerServices.CompilationRelaxations> enumeration to specify compilation options.

This attribute is ignored in version 1.0 of the Microsoft .NET Framework.

The classes in <xref:System.Runtime.CompilerServices> are for compiler writers' use only.



## Examples
The following example demonstrates how to apply the <xref:System.Runtime.CompilerServices.CompilationRelaxationsAttribute>.

Expand Down Expand Up @@ -137,8 +133,6 @@
## Remarks
Apply the <xref:System.Runtime.CompilerServices.CompilationRelaxationsAttribute> attribute to assemblies to specify assembly compilation parameters.

This attribute is ignored in version 1.0 of the Microsoft .NET Framework.

]]></format>
</remarks>
<altmember cref="T:System.Runtime.CompilerServices.CompilationRelaxations" />
Expand Down Expand Up @@ -188,8 +182,6 @@
## Remarks
Apply the <xref:System.Runtime.CompilerServices.CompilationRelaxationsAttribute> attribute to assemblies to specify assembly compilation parameters.

This attribute is ignored in version 1.0 of the Microsoft .NET Framework.

]]></format>
</remarks>
<altmember cref="T:System.Runtime.CompilerServices.CompilationRelaxations" />
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Runtime.CompilerServices/DebugInfoGenerator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
<summary>Creates a program database (PDB) symbol generator.</summary>
<returns>A PDB symbol generator.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.PlatformNotSupportedException">.NET Core and .NET 5+ only: In all cases.</exception>
<exception cref="T:System.PlatformNotSupportedException">In all cases.</exception>
</Docs>
</Member>
<Member MemberName="MarkSequencePoint">
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Runtime.CompilerServices/DisablePrivateReflectionAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
## Remarks

> [!NOTE]
> The .NET Framework, .NET Core, and .NET runtimes do not consistently enforce this attribute. Developers should not rely on this attribute to restrict access to an assembly's non-public members.
> The .NET runtime does not consistently enforce this attribute. Don't rely on this attribute to restrict access to an assembly's non-public members.

Ordinarily, reflection methods, such a <xref:System.Type.GetMethod*?displayProperty=nameWithType> or <xref:System.Reflection.PropertyInfo.GetValue*?displayProperty=nameWithType>, can be used to get information about private members at runtime. When applies to an assembly, the <xref:System.Runtime.CompilerServices.DisablePrivateReflectionAttribute> attribute makes information about private members in that assembly's types unavailable to runtime reflection.

Expand Down
9 changes: 1 addition & 8 deletions xml/System.Runtime.CompilerServices/HasCopySemanticsAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,7 @@
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.HasCopySemanticsAttribute" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
This class is not used in the .NET Framework version 2.0 and is reserved for future use.

]]></format>
</remarks>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading
Loading