Skip to content

Commit e415273

Browse files
authored
Add remarks to AssemblyLoadContext load methods documenting default context probing behavior (#12236)
1 parent 9109c76 commit e415273

1 file changed

Lines changed: 27 additions & 3 deletions

File tree

xml/System.Runtime.Loader/AssemblyLoadContext.xml

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -691,7 +691,15 @@ Each <xref:System.Runtime.Loader.AssemblyLoadContext> can load only:
691691
<param name="assemblyPath">The fully qualified path of the file to load.</param>
692692
<summary>Loads the contents of an assembly file on the specified path.</summary>
693693
<returns>The loaded assembly.</returns>
694-
<remarks>To be added.</remarks>
694+
<remarks>
695+
<format type="text/markdown"><![CDATA[
696+
697+
## Remarks
698+
699+
When this method is called on the <xref:System.Runtime.Loader.AssemblyLoadContext.Default> context, if the assembly name matches an assembly that's part of the default probing path, the assembly from the default probing path is loaded instead of the assembly at the specified path. For more information about default probing, see [Managed assembly loading algorithm](/dotnet/core/dependency-loading/loading-managed).
700+
701+
]]></format>
702+
</remarks>
695703
<exception cref="T:System.ArgumentException">The <paramref name="assemblyPath" /> argument is not an absolute path.</exception>
696704
<exception cref="T:System.ArgumentNullException">The <paramref name="assemblyPath" /> argument is <see langword="null" />.</exception>
697705
<exception cref="T:System.IO.FileLoadException">A file that was found could not be loaded.</exception>
@@ -813,7 +821,15 @@ Each <xref:System.Runtime.Loader.AssemblyLoadContext> can load only:
813821
<param name="assembly">A byte array that is a COFF-based image containing a managed assembly.</param>
814822
<summary>Loads the assembly with a common object file format (COFF)-based image containing a managed assembly.</summary>
815823
<returns>The loaded assembly.</returns>
816-
<remarks>To be added.</remarks>
824+
<remarks>
825+
<format type="text/markdown"><![CDATA[
826+
827+
## Remarks
828+
829+
When this method is called on the <xref:System.Runtime.Loader.AssemblyLoadContext.Default> context, if the assembly name matches an assembly that's part of the default probing path, the assembly from the default probing path is loaded instead of the assembly from the stream. For more information about default probing, see [Managed assembly loading algorithm](/dotnet/core/dependency-loading/loading-managed).
830+
831+
]]></format>
832+
</remarks>
817833
<exception cref="T:System.ArgumentNullException">
818834
<paramref name="assembly" /> is <see langword="null" />.</exception>
819835
<exception cref="T:System.BadImageFormatException">
@@ -873,7 +889,15 @@ Each <xref:System.Runtime.Loader.AssemblyLoadContext> can load only:
873889
<param name="assemblySymbols">A byte array that contains the raw bytes representing the symbols for the assembly.</param>
874890
<summary>Loads the assembly with a common object file format (COFF)-based image containing a managed assembly, optionally including symbols for the assembly.</summary>
875891
<returns>The loaded assembly.</returns>
876-
<remarks>To be added.</remarks>
892+
<remarks>
893+
<format type="text/markdown"><![CDATA[
894+
895+
## Remarks
896+
897+
When this method is called on the <xref:System.Runtime.Loader.AssemblyLoadContext.Default> context, if the assembly name matches an assembly that's part of the default probing path, the assembly from the default probing path is loaded instead of the assembly from the stream. For more information about default probing, see [Managed assembly loading algorithm](/dotnet/core/dependency-loading/loading-managed).
898+
899+
]]></format>
900+
</remarks>
877901
<exception cref="T:System.ArgumentNullException">
878902
<paramref name="assembly" /> is <see langword="null" />.</exception>
879903
<exception cref="T:System.BadImageFormatException">

0 commit comments

Comments
 (0)