Skip to content

Commit 954b302

Browse files
authored
Merge pull request #1975 from sdmaclea/unloadability
AssemblyLoadContext unloadability documentation
2 parents 0b2626f + f965ecd commit 954b302

File tree

3 files changed

+51
-17
lines changed

3 files changed

+51
-17
lines changed

xml/System.Reflection/Assembly.xml

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3076,9 +3076,16 @@
30763076
<ReturnType>System.Boolean</ReturnType>
30773077
</ReturnValue>
30783078
<Docs>
3079-
<summary>To be added.</summary>
3080-
<value>To be added.</value>
3081-
<remarks>To be added.</remarks>
3079+
<summary>Gets a value that indicates whether this assembly is held in a collectible <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
3080+
<value><see langword="true" /> if this assembly is held in a collectible <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />; otherwise, <see langword="false" />.</value>
3081+
<remarks>
3082+
<format type="text/markdown"><![CDATA[
3083+
3084+
## Remarks
3085+
For more information see <see href="/en-us/dotnet/standard/assembly/unloadability-howto">How to use and debug assembly unloadability in .NET Core</see>.
3086+
3087+
]]></format>
3088+
</remarks>
30823089
</Docs>
30833090
</Member>
30843091
<Member MemberName="IsDefined">
@@ -5770,4 +5777,4 @@ The ability to execute code in remote assemblies is disabled. See <see href="htt
57705777
</Docs>
57715778
</Member>
57725779
</Members>
5773-
</Type>
5780+
</Type>

xml/System.Reflection/MemberInfo.xml

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -591,9 +591,16 @@
591591
<ReturnType>System.Boolean</ReturnType>
592592
</ReturnValue>
593593
<Docs>
594-
<summary>To be added.</summary>
595-
<value>To be added.</value>
596-
<remarks>To be added.</remarks>
594+
<summary>Gets a value that indicates whether this <see cref="T:System.Reflection.MemberInfo" /> object is part of an assembly held in a collectible <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
595+
<value><see langword="true" /> if the <see cref="T:System.Reflection.MemberInfo" /> is part of an assembly held in a collectible assembly load context; otherwise, <see langword="false" />.</value>
596+
<remarks>
597+
<format type="text/markdown"><![CDATA[
598+
599+
## Remarks
600+
For more information see <see href="/en-us/dotnet/standard/assembly/unloadability-howto">How to use and debug assembly unloadability in .NET Core</see>.
601+
602+
]]></format>
603+
</remarks>
597604
</Docs>
598605
</Member>
599606
<Member MemberName="IsDefined">
@@ -1387,4 +1394,4 @@
13871394
</Docs>
13881395
</Member>
13891396
</Members>
1390-
</Type>
1397+
</Type>

xml/System.Runtime.Loader/AssemblyLoadContext.xml

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@
7171
]]></format>
7272
</remarks>
7373
<related type="Article" href="https://github.com/dotnet/coreclr/blob/master/Documentation/design-docs/assemblyloadcontext.md">AssemblyLoadContext CoreCLR design document</related>
74+
<related type="Article" href="/en-us/dotnet/standard/assembly/unloadability-howto">How to use and debug assembly unloadability in .NET Core</related>.
75+
<related type="Article" href="https://github.com/dotnet/coreclr/blob/master/Documentation/design-docs/unloadability.md">AssemblyLoadContext unloadability design document</related>
7476
</Docs>
7577
<Members>
7678
<Member MemberName=".ctor">
@@ -121,8 +123,8 @@ This constructor is protected. It can only be called from the <xref:System.Runti
121123
<Parameter Name="isCollectible" Type="System.Boolean" Index="0" FrameworkAlternate="netcore-3.0" />
122124
</Parameters>
123125
<Docs>
124-
<param name="isCollectible">To be added.</param>
125-
<summary>To be added.</summary>
126+
<param name="isCollectible"><see langword="true" /> to enable garbage collection; otherwise, <see langword="false" />.</param>
127+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> class with a value that indicates whether garbage collection is enabled. </summary>
126128
<remarks>To be added.</remarks>
127129
</Docs>
128130
</Member>
@@ -239,9 +241,16 @@ This constructor is protected. It can only be called from the <xref:System.Runti
239241
<ReturnType>System.Boolean</ReturnType>
240242
</ReturnValue>
241243
<Docs>
242-
<summary>To be added.</summary>
243-
<value>To be added.</value>
244-
<remarks>To be added.</remarks>
244+
<summary>Gets a value that indicates whether this <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> is collectible.</summary>
245+
<value><see langword="true" /> if this <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> is collectible; otherwise, <see langword="false" />. If a value is not specified in the constructor, the value is <see langword="false" />.</value>
246+
<remarks>
247+
<format type="text/markdown"><![CDATA[
248+
249+
## Remarks
250+
For more information see <see href="/en-us/dotnet/standard/assembly/unloadability-howto">How to use and debug assembly unloadability in .NET Core</see>.
251+
252+
]]></format>
253+
</remarks>
245254
</Docs>
246255
</Member>
247256
<Member MemberName="Load">
@@ -720,8 +729,19 @@ This constructor is protected. It can only be called from the <xref:System.Runti
720729
</ReturnValue>
721730
<Parameters />
722731
<Docs>
723-
<summary>To be added.</summary>
724-
<remarks>To be added.</remarks>
732+
<summary>Initiates an unload of this <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
733+
<remarks>
734+
<format type="text/markdown"><![CDATA[
735+
736+
## Remarks
737+
738+
+ An AssemblyLoadContext can only be unloaded if it is collectible.
739+
+ Unloading will occur asynchronously.
740+
+ Unloading will not occur while there are references to the AssemblyLoadContext.
741+
742+
]]></format>
743+
</remarks>
744+
<exception cref="T:System.InvalidOperationException">Unloading is not allowed.</exception>
725745
</Docs>
726746
</Member>
727747
<Member MemberName="Unloading">
@@ -747,9 +767,9 @@ This constructor is protected. It can only be called from the <xref:System.Runti
747767
<ReturnType>System.Action&lt;System.Runtime.Loader.AssemblyLoadContext&gt;</ReturnType>
748768
</ReturnValue>
749769
<Docs>
750-
<summary>Occurs when the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> is unloaded .</summary>
770+
<summary>Occurs when the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> is unloaded.</summary>
751771
<remarks>To be added.</remarks>
752772
</Docs>
753773
</Member>
754774
</Members>
755-
</Type>
775+
</Type>

0 commit comments

Comments
 (0)