Skip to content

Adjust remarks for Assembly.Load on .NET Core #9764

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

Merged
merged 9 commits into from
Oct 24, 2024
Merged

Adjust remarks for Assembly.Load on .NET Core #9764

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
38029a8
Adjust remarks for Assembly.Load on .NET Core
agocke Mar 26, 2024
3610c3e
Attempt to fix up problems
agocke Apr 16, 2024
e78a4cc
Mark API as unsupported
agocke Apr 16, 2024
87bf285
Fix xrefs
agocke Apr 16, 2024
9fafa66
Respond to PR comments
agocke Aug 30, 2024
870fff0
Merge remote-tracking branch 'upstream/main' into add-netcore-remarks
agocke Aug 30, 2024
dbe92d0
Apply suggestions from code review
agocke Aug 30, 2024
75d9b2f
Apply suggestions from code review
gewarren Oct 24, 2024
5607fe4
Update xml/System.Reflection/Assembly.xml
gewarren Oct 24, 2024
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
60 changes: 55 additions & 5 deletions xml/System.Reflection/Assembly.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4128,7 +4128,17 @@ Note: In <see href="https://go.microsoft.com/fwlink/?LinkID=247912">.NET for Win
<param name="assemblyString">The long or short form of the assembly name.</param>
<summary>Loads an assembly with the specified name.</summary>
<returns>The loaded assembly.</returns>
<remarks>
<remarks FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0">
<format type="text/markdown"><![CDATA[

## Remarks

This API is present in .NET Core for compatibility, but it is recommended to use <xref:System.Reflection.AssemblyLoadContext> overloads in .NET Core 2.0 and later.

The assembly is loaded into the current AssemblyLoadContext.
]]></format>
</remarks>
<remarks FrameworkAlternate="netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1netframework-4.8.1">
<format type="text/markdown"><![CDATA[

## Remarks
Expand Down Expand Up @@ -4231,7 +4241,17 @@ To load the correct assembly, it's recommended to call the `Load` method by pass
<param name="rawSymbolStore">A byte array that contains the raw bytes representing the symbols for the assembly.</param>
<summary>Loads the assembly with a common object file format (COFF)-based image containing an emitted assembly, optionally including symbols for the assembly.</summary>
<returns>The loaded assembly.</returns>
<remarks>
<remarks FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0">
<format type="text/markdown"><![CDATA[

## Remarks

This API is present in .NET Core for compatibility, but it is recommended to use <xref:System.Reflection.AssemblyLoadContext> overloads in .NET Core 2.0 and later.

The assembly is loaded into the current AssemblyLoadContext.
]]></format>
</remarks>
<remarks FrameworkAlternate="netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1netframework-4.8.1">
<format type="text/markdown"><![CDATA[

## Remarks
Expand Down Expand Up @@ -4620,7 +4640,17 @@ The assembly is loaded using the supplied evidence. The raw bytes representing t
<param name="path">The fully qualified path of the file to load.</param>
<summary>Loads the contents of an assembly file on the specified path.</summary>
<returns>The loaded assembly.</returns>
<remarks>
<remarks FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0">
<format type="text/markdown"><![CDATA[

## Remarks

This API is present in .NET Core for compatibility, but it is recommended to use <xref:System.Reflection.AssemblyLoadContext> overloads in .NET Core 2.0 and later.

The assembly is loaded into a new AssemblyLoadContext created for this purpose.
]]></format>
</remarks>
<remarks FrameworkAlternate="netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1netframework-4.8.1">
<format type="text/markdown"><![CDATA[

## Remarks
Expand Down Expand Up @@ -4790,7 +4820,17 @@ Starting with .NET Framework 4, the ability to execute code in assemblies loaded
<param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
<summary>Loads an assembly given its file name or path.</summary>
<returns>The loaded assembly.</returns>
<remarks>
<remarks FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0">
<format type="text/markdown"><![CDATA[

## Remarks

This API is present in .NET Core for compatibility, but it is recommended to use <xref:System.Reflection.AssemblyLoadContext> overloads in .NET Core 2.0 and later.

The assembly is loaded into the default AssemblyLoadContext.
]]></format>
</remarks>
<remarks FrameworkAlternate="netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1netframework-4.8.1">
<format type="text/markdown"><![CDATA[

## Remarks
Expand Down Expand Up @@ -5041,7 +5081,17 @@ The ability to execute code in remote assemblies is disabled. See <see href="htt
<param name="hashAlgorithm">The hash algorithm used for hashing files and for generating the strong name.</param>
<summary>Loads an assembly given its file name or path, hash value, and hash algorithm.</summary>
<returns>The loaded assembly.</returns>
<remarks>
<remarks FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0">
<format type="text/markdown"><![CDATA[

## Remarks

This API is present in .NET Core for compatibility, but it is recommended to use <xref:System.Reflection.AssemblyLoadContext> overloads in .NET Core 2.0 and later.

The assembly is loaded into the default AssemblyLoadContext.
]]></format>
</remarks>
<remarks FrameworkAlternate="netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1netframework-4.8.1">
<format type="text/markdown"><![CDATA[

## Remarks
Expand Down