Skip to content

Commit 215d1a3

Browse files
sdmacleasdmaclea
committed
AssemblyLoadContext preview5 doc updates
1 parent 3bbaa66 commit 215d1a3

File tree

2 files changed

+53
-23
lines changed

2 files changed

+53
-23
lines changed

‎xml/System.Runtime.Loader/AssemblyLoadContext+ContextualReflectionScope.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</Interface>
1919
</Interfaces>
2020
<Docs>
21-
<summary>To be added.</summary>
21+
<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>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -42,9 +42,9 @@
4242
</ReturnValue>
4343
<Parameters />
4444
<Docs>
45-
<summary>To be added.</summary>
45+
<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>
4646
<remarks>To be added.</remarks>
4747
</Docs>
4848
</Member>
4949
</Members>
50-
</Type>
50+
</Type>

‎xml/System.Runtime.Loader/AssemblyLoadContext.xml

Lines changed: 50 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,15 @@ This constructor is protected. It can only be called from the <xref:System.Runti
126126
<param name="isCollectible">
127127
<see langword="true" /> to enable garbage collection; otherwise, <see langword="false" />.</param>
128128
<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>
129-
<remarks>To be added.</remarks>
129+
<remarks>
130+
<format type="text/markdown"><![CDATA[
131+
132+
## Remarks
133+
134+
This constructor is protected. It can only be called from the <xref:System.Runtime.Loader.AssemblyLoadContext> class or its derived classes.
135+
136+
]]></format>
137+
</remarks>
130138
</Docs>
131139
</Member>
132140
<Member MemberName=".ctor">
@@ -145,9 +153,10 @@ This constructor is protected. It can only be called from the <xref:System.Runti
145153
<Parameter Name="isCollectible" Type="System.Boolean" Index="1" FrameworkAlternate="netcore-3.0" />
146154
</Parameters>
147155
<Docs>
148-
<param name="name">To be added.</param>
149-
<param name="isCollectible">To be added.</param>
150-
<summary>To be added.</summary>
156+
<param name="name">Value for <see cref="P:System.Runtime.Loader.AssemblyLoadContext.Name" /> in the new instance. Value can be <see langword="null" />.</param>
157+
<param name="isCollectible">
158+
<see langword="true" /> to enable garbage collection; otherwise, <see langword="false" />.</param>
159+
<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>
151160
<remarks>To be added.</remarks>
152161
</Docs>
153162
</Member>
@@ -167,8 +176,8 @@ This constructor is protected. It can only be called from the <xref:System.Runti
167176
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.Runtime.Loader.AssemblyLoadContext&gt;</ReturnType>
168177
</ReturnValue>
169178
<Docs>
170-
<summary>To be added.</summary>
171-
<value>To be added.</value>
179+
<summary>Returns an IEnumerable for all <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> instances.</summary>
180+
<value>An IEnumerable for all <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> instances.</value>
172181
<remarks>To be added.</remarks>
173182
</Docs>
174183
</Member>
@@ -188,8 +197,8 @@ This constructor is protected. It can only be called from the <xref:System.Runti
188197
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.Reflection.Assembly&gt;</ReturnType>
189198
</ReturnValue>
190199
<Docs>
191-
<summary>To be added.</summary>
192-
<value>To be added.</value>
200+
<summary>Returns an IEnumerable for the <see cref="T:System.Reflection.Assembly" /> instances loaded in the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
201+
<value>An IEnumerable for the <see cref="T:System.Reflection.Assembly" /> instances loaded in the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</value>
193202
<remarks>To be added.</remarks>
194203
</Docs>
195204
</Member>
@@ -209,9 +218,16 @@ This constructor is protected. It can only be called from the <xref:System.Runti
209218
<ReturnType>System.Runtime.Loader.AssemblyLoadContext</ReturnType>
210219
</ReturnValue>
211220
<Docs>
212-
<summary>To be added.</summary>
213-
<value>To be added.</value>
214-
<remarks>To be added.</remarks>
221+
<summary>The <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> set by most recent call to <see cref="M:System.Runtime.Loader.AssemblyLoadContext.EnterContextualReflection" />.</summary>
222+
<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>
223+
<remarks>
224+
<format type="text/markdown"><![CDATA[
225+
226+
## Remarks
227+
For more information, see [AssemblyLoadContext.CurrentContextualReflectionContext design doc in .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/design-docs/AssemblyLoadContext.ContextualReflection.md).
228+
229+
]]></format>
230+
</remarks>
215231
</Docs>
216232
</Member>
217233
<Member MemberName="Default">
@@ -259,9 +275,16 @@ This constructor is protected. It can only be called from the <xref:System.Runti
259275
</ReturnValue>
260276
<Parameters />
261277
<Docs>
262-
<summary>To be added.</summary>
263-
<returns>To be added.</returns>
264-
<remarks>To be added.</remarks>
278+
<summary>Sets <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" /> to <see langword="this" /> <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
279+
<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>
280+
<remarks>
281+
<format type="text/markdown"><![CDATA[
282+
283+
## Remarks
284+
For more information, see [AssemblyLoadContext.CurrentContextualReflectionContext design doc in .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/design-docs/AssemblyLoadContext.ContextualReflection.md).
285+
286+
]]></format>
287+
</remarks>
265288
</Docs>
266289
</Member>
267290
<Member MemberName="EnterContextualReflection">
@@ -283,10 +306,17 @@ This constructor is protected. It can only be called from the <xref:System.Runti
283306
<Parameter Name="activating" Type="System.Reflection.Assembly" Index="0" FrameworkAlternate="netcore-3.0" />
284307
</Parameters>
285308
<Docs>
286-
<param name="activating">To be added.</param>
287-
<summary>To be added.</summary>
288-
<returns>To be added.</returns>
289-
<remarks>To be added.</remarks>
309+
<param name="activating">Assembly which will be used to determine the requested <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> instance.</param>
310+
<summary>Sets <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" /> to the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> which loaded activating.</summary>
311+
<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>
312+
<remarks>
313+
<format type="text/markdown"><![CDATA[
314+
315+
## Remarks
316+
For more information, see [AssemblyLoadContext.CurrentContextualReflectionContext design doc in .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/design-docs/AssemblyLoadContext.ContextualReflection.md).
317+
318+
]]></format>
319+
</remarks>
290320
</Docs>
291321
</Member>
292322
<Member MemberName="GetAssemblyName">
@@ -739,8 +769,8 @@ For more information, see [How to use and debug assembly unloadability in .NET C
739769
<ReturnType>System.String</ReturnType>
740770
</ReturnValue>
741771
<Docs>
742-
<summary>To be added.</summary>
743-
<value>To be added.</value>
772+
<summary>Optional name of the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
773+
<value>Optional name of the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />. Value can be <see langword="null" />.</value>
744774
<remarks>To be added.</remarks>
745775
</Docs>
746776
</Member>

0 commit comments

Comments
 (0)