Skip to content

AssemblyLoadContext preview5 doc updates #2549

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 3 commits into from
Jun 7, 2019
+55 −25
Merged

AssemblyLoadContext preview5 doc updates #2549

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
215d1a3
AssemblyLoadContext preview5 doc updates
sdmaclea Jun 5, 2019
11b51e8
PR Feedback
sdmaclea Jun 6, 2019
c696c8d
Clean up IEnumerable
sdmaclea Jun 6, 2019
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
6 changes: 3 additions & 3 deletions xml/System.Runtime.Loader/AssemblyLoadContext+ContextualReflectionScope.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</Interface>
</Interfaces>
<Docs>
<summary>To be added.</summary>
<summary>Return type used exclusively for <see cref="M:System.Runtime.Loader.AssemblyLoadContext.EnterContextualReflection" />. Intended to be used as an <see cref="T:System.IDisposable" /> in a <see langword="using" /> block.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -42,9 +42,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Sets <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" /> to the value preceding the call to <see cref="M:System.Runtime.Loader.AssemblyLoadContext.EnterContextualReflection" /> which returned this instance.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>
70 changes: 50 additions & 20 deletions xml/System.Runtime.Loader/AssemblyLoadContext.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,15 @@ This constructor is protected. It can only be called from the <xref:System.Runti
<param name="isCollectible">
<see langword="true" /> to enable garbage collection; otherwise, <see langword="false" />.</param>
<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>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This constructor is protected. It can only be called from the <xref:System.Runtime.Loader.AssemblyLoadContext> class or its derived classes.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand All @@ -145,9 +153,10 @@ This constructor is protected. It can only be called from the <xref:System.Runti
<Parameter Name="isCollectible" Type="System.Boolean" Index="1" FrameworkAlternate="netcore-3.0" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<param name="isCollectible">To be added.</param>
<summary>To be added.</summary>
<param name="name">Value for <see cref="P:System.Runtime.Loader.AssemblyLoadContext.Name" /> in the new instance. Value can be <see langword="null" />.</param>
<param name="isCollectible">
<see langword="true" /> to enable garbage collection; otherwise, <see langword="false" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> class with a name and a value that indicates whether garbage collection is enabled.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -167,8 +176,8 @@ This constructor is protected. It can only be called from the <xref:System.Runti
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.Runtime.Loader.AssemblyLoadContext&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Returns an IEnumerable for all <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> instances.</summary>
<value>An IEnumerable for all <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> instances.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -188,8 +197,8 @@ This constructor is protected. It can only be called from the <xref:System.Runti
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.Reflection.Assembly&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Returns an IEnumerable for the <see cref="T:System.Reflection.Assembly" /> instances loaded in the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
<value>An IEnumerable for the <see cref="T:System.Reflection.Assembly" /> instances loaded in the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -209,9 +218,16 @@ This constructor is protected. It can only be called from the <xref:System.Runti
<ReturnType>System.Runtime.Loader.AssemblyLoadContext</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>The <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> set by most recent call to <see cref="M:System.Runtime.Loader.AssemblyLoadContext.EnterContextualReflection" />.</summary>
<value>The <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> set by most recent call to <see cref="M:System.Runtime.Loader.AssemblyLoadContext.EnterContextualReflection" />. Value can be <see langword="null" />. The value is stored in an <see cref="T:System.Threading.AsyncLocal`1" />, so the value is unique per asynchronous context.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
For more information, see [AssemblyLoadContext.CurrentContextualReflectionContext design doc in .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/design-docs/AssemblyLoadContext.ContextualReflection.md).

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Default">
Expand Down Expand Up @@ -259,9 +275,16 @@ This constructor is protected. It can only be called from the <xref:System.Runti
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Sets <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" /> to <see langword="this" /> <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
<returns>A <see cref="T:System.Runtime.Loader.AssemblyLoadContext.ContextualReflectionScope" /> to restore the previous value of <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" />. Intended to be used as an <see cref="T:System.IDisposable" /> in a <see langword="using" /> block.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
For more information, see [AssemblyLoadContext.CurrentContextualReflectionContext design doc in .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/design-docs/AssemblyLoadContext.ContextualReflection.md).

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="EnterContextualReflection">
Expand All @@ -283,10 +306,17 @@ This constructor is protected. It can only be called from the <xref:System.Runti
<Parameter Name="activating" Type="System.Reflection.Assembly" Index="0" FrameworkAlternate="netcore-3.0" />
</Parameters>
<Docs>
<param name="activating">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="activating">Assembly which will be used to determine the requested <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> instance.</param>
<summary>Sets <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" /> to the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> which loaded activating.</summary>
<returns>A <see cref="T:System.Runtime.Loader.AssemblyLoadContext.ContextualReflectionScope" /> to restore the previous value of <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" />. Intended to be used as an <see cref="T:System.IDisposable" /> in a <see langword="using" /> block.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
For more information, see [AssemblyLoadContext.CurrentContextualReflectionContext design doc in .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/design-docs/AssemblyLoadContext.ContextualReflection.md).

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetAssemblyName">
Expand Down Expand Up @@ -739,8 +769,8 @@ For more information, see [How to use and debug assembly unloadability in .NET C
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Optional name of the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
<value>Optional name of the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />. Value can be <see langword="null" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down