Skip to content

Commit 41b2f3d

Browse files
jkoritzinskyRon Petrusha
authored andcommitted
Add some api-docs for AssemblyDependencyResolver. (#2361)
* Add some api-docs for AssemblyDependencyResolver. * Apply suggestions from code review Co-Authored-By: jkoritzinsky <[email protected]>
1 parent c68ce3c commit 41b2f3d

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

xml/System.Runtime.Loader/AssemblyDependencyResolver.xml

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,17 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
18-
<remarks>To be added.</remarks>
17+
<summary>Allows a program to resolve assemblies and native libraries to paths based on the dependencies of a given assembly.</summary>
18+
<remarks>
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
The `AssemblyDependencyResolver` class enables application developers to more easily develop a plugin architecture in conjunction with custom <xref:System.Runtime.Loader.AssemblyLoadContext?displayProperty=nameWithType> instances to isolate plugins and also enable plugins to load dependencies.
23+
24+
The [tutorial on creating a .NET Core application with plugins](https://docs.microsoft.com/dotnet/core/tutorials/creating-app-with-plugin-support) describes how to create a custom <xref:System.Runtime.Loader.AssemblyLoadContext> that uses an `AssemblyDependencyResolver` to resolve the dependencies of the plugin and correctly isolate the plugin's dependencies from the hosting application.
25+
26+
]]></format>
27+
</remarks>
1928
</Docs>
2029
<Members>
2130
<Member MemberName=".ctor">
@@ -34,9 +43,9 @@
3443
<Parameter Name="componentAssemblyPath" Type="System.String" />
3544
</Parameters>
3645
<Docs>
37-
<param name="componentAssemblyPath">To be added.</param>
38-
<summary>To be added.</summary>
39-
<remarks>To be added.</remarks>
46+
<param name="componentAssemblyPath">The path to the component or plugin's managed entry point.</param>
47+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Loader.AssemblyDependencyResolver" /> class with a path to a component's assembly.</summary>
48+
<remarks>`componentAssemblyPath` can be a relative or an absolute path. The assembly must have an accompanying deps.json file in the same directory that describes the assembly's dependencies. This file is output during the build process.</remarks>
4049
</Docs>
4150
</Member>
4251
<Member MemberName="ResolveAssemblyToPath">
@@ -57,9 +66,9 @@
5766
<Parameter Name="assemblyName" Type="System.Reflection.AssemblyName" />
5867
</Parameters>
5968
<Docs>
60-
<param name="assemblyName">To be added.</param>
61-
<summary>To be added.</summary>
62-
<returns>To be added.</returns>
69+
<param name="assemblyName">The assembly name to resolve.</param>
70+
<summary>Resolves a path to an assembly with the given assembly name based on the component's dependencies.</summary>
71+
<returns>The path to an assembly with the given name from the component's deps.json file, or <c>null</c> if the assembly does not exist in the deps.json file or is not on disk in the location specified by the deps.json file.</returns>
6372
<remarks>To be added.</remarks>
6473
</Docs>
6574
</Member>
@@ -82,11 +91,11 @@
8291
<Parameter Name="unmanagedDllName" Type="System.String" />
8392
</Parameters>
8493
<Docs>
85-
<param name="unmanagedDllName">To be added.</param>
86-
<summary>To be added.</summary>
87-
<returns>To be added.</returns>
94+
<param name="unmanagedDllName">The name of the native library to resolve.</param>
95+
<summary>Resolves a path to a native library with the given name based on the component's dependencies.</summary>
96+
<returns>The path to a native library with the given name from the component's deps.json file and the current runtime identifier, or <c>null</c> if the assembly does not exist in the deps.json file or is not on disk in the location specified by the deps.json file.</returns>
8897
<remarks>To be added.</remarks>
8998
</Docs>
9099
</Member>
91100
</Members>
92-
</Type>
101+
</Type>

0 commit comments

Comments
 (0)