Skip to content

Improve AssemblyLoadContext documentation #2833

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 1 commit into from
Jul 26, 2019
Merged

Improve AssemblyLoadContext documentation #2833

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
38 changes: 27 additions & 11 deletions xml/System.Runtime.Loader/AssemblyLoadContext.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,12 +730,12 @@ Each <xref:System.Runtime.Loader.AssemblyLoadContext> can load only:
<Docs>
<param name="unmanagedDllName">Name of the unmanaged library. Typically this is the filename without its path or extensions. </param>
<summary>Allows derived class to load an unmanaged library by name.</summary>
<returns>A handle to the loaded library, or <see langword="null" />.</returns>
<returns>A handle to the loaded library, or <see cref="F:System.IntPtr.Zero" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The default implementation always return `null`. When `null` is returned, the runtime loads the library with its default policy.
The default implementation always returns <xref:System.IntPtr.Zero?displayProperty=nameWithType>. When <xref:System.IntPtr.Zero?displayProperty=nameWithType> is returned, the runtime loads the library with its default policy.

This virtual method can be overridden to customize the unmanaged library search algorithm. When overridden the name can be used to identify the library. The loaded library does not need to match the requested name, but can be transformed as needed. This could include adjusting the name for platform specific naming.

Expand Down Expand Up @@ -893,9 +893,17 @@ This event is raised if the native library cannot be resolved by the default res
<Parameter Name="directoryPath" Type="System.String" />
</Parameters>
<Docs>
<param name="directoryPath">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="directoryPath">The full path to the directory where the optimization profiles are stored.</param>
<summary>Sets the root path where the optimization profiles for this load context are stored.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The profile optimization improves the startup performance of the load context on multicore computers by performing background compilation of methods that are likely to be executed, based on profiles created during previous compilations. For more information, see <xref:System.Runtime.ProfileOptimization>.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="StartProfileOptimization">
Expand Down Expand Up @@ -924,9 +932,17 @@ This event is raised if the native library cannot be resolved by the default res
<Parameter Name="profile" Type="System.String" />
</Parameters>
<Docs>
<param name="profile">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="profile">The name of the optimization profile.</param>
<summary>Starts the profile optimization for the specified profile.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The profile optimization improves the startup performance of the load context on multicore computers by performing background compilation of methods that are likely to be executed, based on profiles created during previous compilations. For more information, see <xref:System.Runtime.ProfileOptimization>.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
Expand All @@ -946,8 +962,8 @@ This event is raised if the native library cannot be resolved by the default res
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns the string representation of this load context.</summary>
<returns>The string representation of this load context.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1011,4 +1027,4 @@ This event is raised if the native library cannot be resolved by the default res
</Docs>
</Member>
</Members>
</Type>
</Type>