From b454e8f0b0b97d1a21d068d0b5d69b9ed41d51e3 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Wed, 27 May 2026 18:12:47 -0700 Subject: [PATCH] remove .net fw remarks --- .../AsyncTaskMethodBuilder.xml | 68 ++++++------ .../AsyncTaskMethodBuilder`1.xml | 52 ++++----- .../AsyncVoidMethodBuilder.xml | 42 +++---- .../CompilationRelaxations.xml | 12 +- .../CompilationRelaxationsAttribute.xml | 8 -- .../DebugInfoGenerator.xml | 2 +- .../DisablePrivateReflectionAttribute.xml | 2 +- .../HasCopySemanticsAttribute.xml | 9 +- .../MethodImplOptions.xml | 18 +-- .../RequiredAttributeAttribute.xml | 13 +-- .../RuntimeHelpers.xml | 105 ++---------------- .../SpecialNameAttribute.xml | 20 +--- .../StringFreezingAttribute.xml | 39 ++----- 13 files changed, 121 insertions(+), 269 deletions(-) diff --git a/xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder.xml b/xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder.xml index 767d7d0792e..8583c0c8f39 100644 --- a/xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder.xml +++ b/xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder.xml @@ -62,11 +62,11 @@ Represents a builder for asynchronous methods that return a task. - @@ -219,7 +219,7 @@ The type of the state machine. The awaiter. The state machine. - Schedules the state machine to proceed to the next action when the specified awaiter completes. This method can be called from partially trusted code. + Schedules the state machine to proceed to the next action when the specified awaiter completes. To be added. @@ -267,11 +267,11 @@ Creates an instance of the type. A new instance of the builder. - @@ -322,19 +322,19 @@ The exception to bind to the task. Marks the task as failed and binds the specified exception to the task. - is . - The task has already completed. - - -or- - + The task has already completed. + + -or- + The builder is not initialized. @@ -381,17 +381,17 @@ Marks the task as successfully completed. - - The task has already completed. - - -or- - + The task has already completed. + + -or- + The builder is not initialized. @@ -553,11 +553,11 @@ Gets the task for this builder. The task for this builder. - The builder is not initialized. diff --git a/xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder`1.xml b/xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder`1.xml index 4e8d2300d46..d956ad68875 100644 --- a/xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder`1.xml +++ b/xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder`1.xml @@ -73,11 +73,11 @@ The result to use to complete the task. Represents a builder for asynchronous methods that returns a task and provides a parameter for the result. - @@ -230,7 +230,7 @@ The type of the state machine. The awaiter. The state machine. - Schedules the state machine to proceed to the next action when the specified awaiter completes. This method can be called from partially trusted code. + Schedules the state machine to proceed to the next action when the specified awaiter completes. To be added. @@ -284,11 +284,11 @@ Creates an instance of the class. A new instance of the builder. - @@ -339,11 +339,11 @@ The exception to bind to the task. Marks the task as failed and binds the specified exception to the task. - @@ -397,11 +397,11 @@ The result to use to complete the task. Marks the task as successfully completed. - The task has already completed. @@ -565,11 +565,11 @@ Gets the task for this builder. The task for this builder. - diff --git a/xml/System.Runtime.CompilerServices/AsyncVoidMethodBuilder.xml b/xml/System.Runtime.CompilerServices/AsyncVoidMethodBuilder.xml index fd0e7bc7225..52ab314fe9d 100644 --- a/xml/System.Runtime.CompilerServices/AsyncVoidMethodBuilder.xml +++ b/xml/System.Runtime.CompilerServices/AsyncVoidMethodBuilder.xml @@ -62,11 +62,11 @@ Represents a builder for asynchronous methods that do not return a value. - @@ -219,7 +219,7 @@ The type of the state machine. The awaiter. The state machine. - Schedules the state machine to proceed to the next action when the specified awaiter completes. This method can be called from partially trusted code. + Schedules the state machine to proceed to the next action when the specified awaiter completes. To be added. @@ -267,11 +267,11 @@ Creates an instance of the class. A new instance of the builder. - @@ -322,11 +322,11 @@ The exception to bind. Binds an exception to the method builder. - @@ -377,11 +377,11 @@ Marks the method builder as successfully completed. - The builder is not initialized. diff --git a/xml/System.Runtime.CompilerServices/CompilationRelaxations.xml b/xml/System.Runtime.CompilerServices/CompilationRelaxations.xml index 53ad132ea32..e41c05cf1cb 100644 --- a/xml/System.Runtime.CompilerServices/CompilationRelaxations.xml +++ b/xml/System.Runtime.CompilerServices/CompilationRelaxations.xml @@ -50,11 +50,11 @@ Specifies parameters that control the strictness of the code generated by the common language runtime's just-in-time (JIT) compiler. - enumeration with the attribute. - + enumeration with the attribute. + ]]> @@ -96,7 +96,7 @@ 8 - 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 string interning, internally requires building auxiliary tables that consume memory resources. + 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 string interning, internally requires building auxiliary tables that consume memory resources. diff --git a/xml/System.Runtime.CompilerServices/CompilationRelaxationsAttribute.xml b/xml/System.Runtime.CompilerServices/CompilationRelaxationsAttribute.xml index 3a8ae3e50bd..7e32ebc0897 100644 --- a/xml/System.Runtime.CompilerServices/CompilationRelaxationsAttribute.xml +++ b/xml/System.Runtime.CompilerServices/CompilationRelaxationsAttribute.xml @@ -61,12 +61,8 @@ ## Remarks Apply the attribute to assemblies to specify assembly compilation parameters. Use the enumeration to specify compilation options. - This attribute is ignored in version 1.0 of the Microsoft .NET Framework. - The classes in are for compiler writers' use only. - - ## Examples The following example demonstrates how to apply the . @@ -137,8 +133,6 @@ ## Remarks Apply the attribute to assemblies to specify assembly compilation parameters. - This attribute is ignored in version 1.0 of the Microsoft .NET Framework. - ]]> @@ -188,8 +182,6 @@ ## Remarks Apply the attribute to assemblies to specify assembly compilation parameters. - This attribute is ignored in version 1.0 of the Microsoft .NET Framework. - ]]> diff --git a/xml/System.Runtime.CompilerServices/DebugInfoGenerator.xml b/xml/System.Runtime.CompilerServices/DebugInfoGenerator.xml index 9615a786259..428e1911955 100644 --- a/xml/System.Runtime.CompilerServices/DebugInfoGenerator.xml +++ b/xml/System.Runtime.CompilerServices/DebugInfoGenerator.xml @@ -133,7 +133,7 @@ Creates a program database (PDB) symbol generator. A PDB symbol generator. To be added. - .NET Core and .NET 5+ only: In all cases. + In all cases. diff --git a/xml/System.Runtime.CompilerServices/DisablePrivateReflectionAttribute.xml b/xml/System.Runtime.CompilerServices/DisablePrivateReflectionAttribute.xml index a3472f3423a..a90b0108c47 100644 --- a/xml/System.Runtime.CompilerServices/DisablePrivateReflectionAttribute.xml +++ b/xml/System.Runtime.CompilerServices/DisablePrivateReflectionAttribute.xml @@ -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 or , can be used to get information about private members at runtime. When applies to an assembly, the attribute makes information about private members in that assembly's types unavailable to runtime reflection. diff --git a/xml/System.Runtime.CompilerServices/HasCopySemanticsAttribute.xml b/xml/System.Runtime.CompilerServices/HasCopySemanticsAttribute.xml index 40136e90eaa..93ca5b4413a 100644 --- a/xml/System.Runtime.CompilerServices/HasCopySemanticsAttribute.xml +++ b/xml/System.Runtime.CompilerServices/HasCopySemanticsAttribute.xml @@ -87,14 +87,7 @@ Initializes a new instance of the class. - - - + To be added. diff --git a/xml/System.Runtime.CompilerServices/MethodImplOptions.xml b/xml/System.Runtime.CompilerServices/MethodImplOptions.xml index cdf3b1239ef..713def44e14 100644 --- a/xml/System.Runtime.CompilerServices/MethodImplOptions.xml +++ b/xml/System.Runtime.CompilerServices/MethodImplOptions.xml @@ -55,16 +55,16 @@ Specifies constants that define the details of how a method is implemented. - attribute. - - You can specify multiple values by using the bitwise OR operator. - + attribute. + + You can specify multiple values by using the bitwise OR operator. + > [!NOTE] -> Locking on the instance or on the type, as with the `Synchronized` flag, is not recommended for public types, because code other than your own can take locks on public types and instances. This might cause deadlocks or other synchronization problems. - +> Locking on the instance or on the type, as with the `Synchronized` flag, is not recommended for public types, because code other than your own can take locks on public types and instances. This might cause deadlocks or other synchronization problems. + ]]> diff --git a/xml/System.Runtime.CompilerServices/RequiredAttributeAttribute.xml b/xml/System.Runtime.CompilerServices/RequiredAttributeAttribute.xml index d67f1881725..f4819682a9e 100644 --- a/xml/System.Runtime.CompilerServices/RequiredAttributeAttribute.xml +++ b/xml/System.Runtime.CompilerServices/RequiredAttributeAttribute.xml @@ -112,9 +112,7 @@ - A type that an importing compiler must fully understand. - - This parameter is not supported in the .NET Framework version 2.0 and later. + A type that an importing compiler must fully understand. This parameter is not supported. Initializes a new instance of the class. To be added. @@ -159,14 +157,7 @@ Gets a type that an importing compiler must fully understand. A type that an importing compiler must fully understand. - - - + To be added. diff --git a/xml/System.Runtime.CompilerServices/RuntimeHelpers.xml b/xml/System.Runtime.CompilerServices/RuntimeHelpers.xml index f4dce165679..523868a46ec 100644 --- a/xml/System.Runtime.CompilerServices/RuntimeHelpers.xml +++ b/xml/System.Runtime.CompilerServices/RuntimeHelpers.xml @@ -274,9 +274,6 @@ This method is intended for compiler use rather than use directly in code. `T` m If the stack space is sufficient, the exception is not thrown, and most .NET types and members can still be called. -> [!NOTE] -> This method is not part of the constrained execution region (CER) support, and should not be confused with the method. - ]]> The available stack space is insufficient to execute the average .NET function. @@ -407,14 +404,7 @@ This method is intended for compiler use rather than use directly in code. `T` m A delegate to the code to run if an exception occurs. The data to pass to and . Executes code using a while using another to execute additional code in case of an exception. - - - + To be added. @@ -856,28 +846,7 @@ This method is intended for compiler use rather than use directly in code. `T` m Designates a body of code as a constrained execution region (CER). - - method and the `try` block. For more information about CERs, see the classes in the namespace. - - CERs that are marked using the method do not work perfectly when a is generated from the `try` block. For more information, see the method. - - The method calls the method. - - - -## Examples - The following example shows how to reliably set handles by using the method. To reliably set a handle to a specified pre-existing handle, you must ensure that the allocation of the native handle and the subsequent recording of that handle within a object is atomic. Any failure between these operations (such as a thread abort or out-of-memory exception) will result in the native handle being leaked. You can use the method to make sure that the handle is not leaked. - - :::code language="csharp" source="~/snippets/csharp/System.Runtime.CompilerServices/RuntimeHelpers/Overview/sample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Runtime.CompilerServices/RuntimeHelpers/Overview/sample.vb" id="Snippet1"::: - - ]]> - + To be added. @@ -932,14 +901,7 @@ This method is intended for compiler use rather than use directly in code. `T` m Designates a body of code as a constrained execution region (CER) without performing any probing. - - method. - - ]]> - + To be added. @@ -988,22 +950,7 @@ This method is intended for compiler use rather than use directly in code. `T` m The event delegate to prepare. Provides a way for applications to dynamically prepare event delegates. - - event delegates such as , , and are not automatically prepared at startup. You can use the following methods to prepare them: - -- Attribute the method by using the attribute. - -- Attribute the method by using the attribute. - -- Call the method to dynamically prepare the delegate. - - For more information, see the article [Keep Your Code Running with the Reliability Features of the .NET Framework](https://learn.microsoft.com/archive/msdn-magazine/2005/october/using-the-reliability-features-of-the-net-framework) in the MSDN Magazine. - - ]]> - + To be added. @@ -1047,14 +994,7 @@ This method is intended for compiler use rather than use directly in code. `T` m The delegate type to prepare. Indicates that the specified delegate should be prepared for inclusion in a constrained execution region (CER). - - - + To be added. @@ -1114,14 +1054,7 @@ This method is intended for compiler use rather than use directly in code. `T` m A handle to the method to prepare. Prepares a method for inclusion in a constrained execution region (CER). - - method to handle virtual calls that are made inside a constrained execution region (CER). At JIT compilation time, the common language runtime does not usually have enough information about the target of a virtual call. Therefore, the runtime does not initially prepare that segment of the call graph. If the code that is using the CER has enough knowledge to determine the target at any point in time before the CER is actually entered, it can call to perform the same runtime preparation normally done for a CER rooted at the method specified as an argument. - - ]]> - + To be added. @@ -1174,16 +1107,7 @@ This method is intended for compiler use rather than use directly in code. `T` m A handle to the method to prepare. The instantiation to pass to the method. Prepares a method for inclusion in a constrained execution region (CER) with the specified instantiation. - - method. The common language runtime cannot prepare constrained execution regions (CERs) rooted in a method that has generic type parameters (either a type parameter on the class containing the method or one on the method itself) when those type parameters are instantiated as reference types. - - You can use this overload to pass a specific instantiation (such as an array of types), specifying class type parameters first (if any), followed by method type parameters (if any). The runtime prepares that instantiation of the method. (This is necessary only if the instantiations you use contain at least one reference type parameter.) Thus, you can use a CER-style `try` clause in a generic method (or a nongeneric method on a generic class) and it will work reliably with instantiations of or other value types. To instantiate reference types such as , you must use an explicit method on the CER root method first. - - ]]> - + To be added. @@ -1233,19 +1157,8 @@ This method is intended for compiler use rather than use directly in code. `T` m - Probes for a certain amount of stack space to ensure that a stack overflow cannot happen within a subsequent block of code (assuming that your code uses only a finite and moderate amount of stack space). We recommend that you use a constrained execution region (CER) instead of this method. - - method, you should use a standard CER. That is, if you are planning to use a moderate amount of stack space, call the method immediately before your `try`/`finally` or `try`/`catch` block. If you are calling a recursive method or plan to use a lot of stack space, you must use the method. - - ]]> - + Probes for a certain amount of stack space to ensure that a stack overflow cannot happen within a subsequent block of code (assuming that your code uses only a finite and moderate amount of stack space). + To be added. diff --git a/xml/System.Runtime.CompilerServices/SpecialNameAttribute.xml b/xml/System.Runtime.CompilerServices/SpecialNameAttribute.xml index c1cdfbad516..ddb53d76bb6 100644 --- a/xml/System.Runtime.CompilerServices/SpecialNameAttribute.xml +++ b/xml/System.Runtime.CompilerServices/SpecialNameAttribute.xml @@ -49,15 +49,8 @@ - Indicates that a type or member is treated in a special way by the runtime or tools. This class cannot be inherited. - - class is not currently used in the .NET Framework, but is reserved for future use. - - ]]> - + Indicates that a type or member is treated in a special way by the runtime or tools. This class cannot be inherited. + To be added. @@ -94,14 +87,7 @@ Initializes a new instance of the class. - - class is not currently used in the .NET Framework, but is reserved for future use. - - ]]> - + To be added. diff --git a/xml/System.Runtime.CompilerServices/StringFreezingAttribute.xml b/xml/System.Runtime.CompilerServices/StringFreezingAttribute.xml index 4c9e2619136..e606dd24cfb 100644 --- a/xml/System.Runtime.CompilerServices/StringFreezingAttribute.xml +++ b/xml/System.Runtime.CompilerServices/StringFreezingAttribute.xml @@ -50,30 +50,7 @@ Deprecated. Freezes a string literal when creating native images using the Ngen.exe (Native Image Generator). This class cannot be inherited. - - [!NOTE] -> The class has been deprecated in the .NET Framework version 3.5 Service Pack 1 (SP1) and later versions. - - A frozen string is a string literal object that is compatible with the managed heap and has been serialized into a native image by the [Ngen.exe (Native Image Generator)](/dotnet/framework/tools/ngen-exe-native-image-generator). The attribute allows you to optimize your code by pre-allocating string literals during native image generation rather than at run time. After a string literal has been frozen, code can simply refer to the string using the address in the native image. - - The must be applied on the assembly level. - - Note that the common language runtime (CLR) cannot unload any native image that has a frozen string because any object in the heap might refer to the frozen string. Therefore, you should use the class only in cases where the native image that contains the frozen string is shared heavily. - - - -## Examples - The following code example demonstrates how to apply the to an assembly. - - :::code language="csharp" source="~/snippets/csharp/System.Runtime.CompilerServices/StringFreezingAttribute/Overview/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Runtime.CompilerServices/StringFreezingAttribute/Overview/example.vb" id="Snippet1"::: - - ]]> - + To be added. @@ -111,14 +88,14 @@ Initializes a new instance of the class. - to an assembly. - + to an assembly. + :::code language="csharp" source="~/snippets/csharp/System.Runtime.CompilerServices/StringFreezingAttribute/Overview/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Runtime.CompilerServices/StringFreezingAttribute/Overview/example.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Runtime.CompilerServices/StringFreezingAttribute/Overview/example.vb" id="Snippet1"::: + ]]>