Skip to content

Commit 299da9f

Browse files
maryamariyancarlossanlopgewarren
authored
Extensions: DI, Configuration, Caching.Memory docs (#4107)
* More docs on: - Microsoft.Extensions.Caching.Memory - Microsoft.Extensions.Configuration - Microsoft.Extensions.DependencyInjection * Apply suggestions from code review Applies PR feedback Co-authored-by: Carlos Sanchez <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Carlos Sanchez <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent 40f4180 commit 299da9f

File tree

8 files changed

+55
-44
lines changed

8 files changed

+55
-44
lines changed

‎xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="MemoryCache" FullName="Microsoft.Extensions.Caching.Memory.MemoryCache">
1+
<Type Name="MemoryCache" FullName="Microsoft.Extensions.Caching.Memory.MemoryCache">
22
<TypeSignature Language="C#" Value="public class MemoryCache : IDisposable, Microsoft.Extensions.Caching.Memory.IMemoryCache" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MemoryCache extends System.Object implements class Microsoft.Extensions.Caching.Memory.IMemoryCache, class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Caching.Memory.MemoryCache" />
@@ -175,8 +175,8 @@
175175
</Parameters>
176176
<Docs>
177177
<param name="key">To be added.</param>
178-
<summary>To be added.</summary>
179-
<returns>To be added.</returns>
178+
<summary>Creates or overwrites an entry in the cache.</summary>
179+
<returns>The newly created <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry" /> instance.</returns>
180180
<remarks>To be added.</remarks>
181181
<inheritdoc />
182182
</Docs>
@@ -208,7 +208,7 @@
208208
</ReturnValue>
209209
<Parameters />
210210
<Docs>
211-
<summary>To be added.</summary>
211+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
212212
<remarks>To be added.</remarks>
213213
</Docs>
214214
</Member>
@@ -301,7 +301,7 @@
301301
</Parameters>
302302
<Docs>
303303
<param name="key">To be added.</param>
304-
<summary>To be added.</summary>
304+
<summary>Removes the object associated with the given key.</summary>
305305
<remarks>To be added.</remarks>
306306
<inheritdoc />
307307
</Docs>
@@ -338,8 +338,9 @@
338338
<Docs>
339339
<param name="key">To be added.</param>
340340
<param name="result">To be added.</param>
341-
<summary>To be added.</summary>
342-
<returns>To be added.</returns>
341+
<summary>Gets the item associated with this key if present.</summary>
342+
<returns>
343+
<see langword="true" /> if the key was found.</returns>
343344
<remarks>To be added.</remarks>
344345
<inheritdoc />
345346
</Docs>

‎xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="MemoryCacheOptions" FullName="Microsoft.Extensions.Caching.Memory.MemoryCacheOptions">
1+
<Type Name="MemoryCacheOptions" FullName="Microsoft.Extensions.Caching.Memory.MemoryCacheOptions">
22
<TypeSignature Language="C#" Value="public class MemoryCacheOptions : Microsoft.Extensions.Options.IOptions&lt;Microsoft.Extensions.Caching.Memory.MemoryCacheOptions&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MemoryCacheOptions extends System.Object implements class Microsoft.Extensions.Options.IOptions`1&lt;class Microsoft.Extensions.Caching.Memory.MemoryCacheOptions&gt;" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions" />
@@ -192,7 +192,7 @@
192192
<ReturnType>Microsoft.Extensions.Caching.Memory.MemoryCacheOptions</ReturnType>
193193
</ReturnValue>
194194
<Docs>
195-
<summary>To be added.</summary>
195+
<summary>Gets the default configured <typeparamref name="TOptions" /> instance.</summary>
196196
<value>To be added.</value>
197197
<remarks>To be added.</remarks>
198198
</Docs>

‎xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ChainedConfigurationProvider" FullName="Microsoft.Extensions.Configuration.ChainedConfigurationProvider">
1+
<Type Name="ChainedConfigurationProvider" FullName="Microsoft.Extensions.Configuration.ChainedConfigurationProvider">
22
<TypeSignature Language="C#" Value="public class ChainedConfigurationProvider : Microsoft.Extensions.Configuration.IConfigurationProvider" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ChainedConfigurationProvider extends System.Object implements class Microsoft.Extensions.Configuration.IConfigurationProvider" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Configuration.ChainedConfigurationProvider" />
@@ -81,7 +81,7 @@
8181
</ReturnValue>
8282
<Parameters />
8383
<Docs>
84-
<summary>To be added.</summary>
84+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
8585
<remarks>To be added.</remarks>
8686
<inheritdoc />
8787
</Docs>

‎xml/Microsoft.Extensions.Configuration/ConfigurationRoot.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ConfigurationRoot" FullName="Microsoft.Extensions.Configuration.ConfigurationRoot">
1+
<Type Name="ConfigurationRoot" FullName="Microsoft.Extensions.Configuration.ConfigurationRoot">
22
<TypeSignature Language="C#" Value="public class ConfigurationRoot : Microsoft.Extensions.Configuration.IConfigurationRoot" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConfigurationRoot extends System.Object implements class Microsoft.Extensions.Configuration.IConfiguration, class Microsoft.Extensions.Configuration.IConfigurationRoot" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Configuration.ConfigurationRoot" />
@@ -91,7 +91,7 @@
9191
</ReturnValue>
9292
<Parameters />
9393
<Docs>
94-
<summary>To be added.</summary>
94+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
9595
<remarks>To be added.</remarks>
9696
<inheritdoc />
9797
</Docs>

‎xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="FileConfigurationProvider" FullName="Microsoft.Extensions.Configuration.FileConfigurationProvider">
1+
<Type Name="FileConfigurationProvider" FullName="Microsoft.Extensions.Configuration.FileConfigurationProvider">
22
<TypeSignature Language="C#" Value="public abstract class FileConfigurationProvider : Microsoft.Extensions.Configuration.ConfigurationProvider" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit FileConfigurationProvider extends Microsoft.Extensions.Configuration.ConfigurationProvider" FrameworkAlternate="dotnet-plat-ext-1.0;dotnet-plat-ext-1.1;dotnet-plat-ext-2.0;dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Configuration.FileConfigurationProvider" />
@@ -84,7 +84,7 @@
8484
</ReturnValue>
8585
<Parameters />
8686
<Docs>
87-
<summary>To be added.</summary>
87+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
8888
<remarks>To be added.</remarks>
8989
<inheritdoc />
9090
</Docs>

‎xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="DefaultServiceProviderFactory" FullName="Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory">
1+
<Type Name="DefaultServiceProviderFactory" FullName="Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory">
22
<TypeSignature Language="C#" Value="public class DefaultServiceProviderFactory : Microsoft.Extensions.DependencyInjection.IServiceProviderFactory&lt;Microsoft.Extensions.DependencyInjection.IServiceCollection&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DefaultServiceProviderFactory extends System.Object implements class Microsoft.Extensions.DependencyInjection.IServiceProviderFactory`1&lt;class Microsoft.Extensions.DependencyInjection.IServiceCollection&gt;" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory" />
@@ -109,8 +109,8 @@
109109
</Parameters>
110110
<Docs>
111111
<param name="services">To be added.</param>
112-
<summary>To be added.</summary>
113-
<returns>To be added.</returns>
112+
<summary>Creates a container builder from an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.</summary>
113+
<returns>A container builder that can be used to create an <see cref="T:System.IServiceProvider" />.</returns>
114114
<remarks>To be added.</remarks>
115115
<inheritdoc />
116116
</Docs>
@@ -144,8 +144,8 @@
144144
</Parameters>
145145
<Docs>
146146
<param name="containerBuilder">To be added.</param>
147-
<summary>To be added.</summary>
148-
<returns>To be added.</returns>
147+
<summary>Creates an <see cref="T:System.IServiceProvider" /> from the container builder.</summary>
148+
<returns>An <see cref="T:System.IServiceProvider" />.</returns>
149149
<remarks>To be added.</remarks>
150150
<inheritdoc />
151151
</Docs>

‎xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ServiceCollection" FullName="Microsoft.Extensions.DependencyInjection.ServiceCollection">
1+
<Type Name="ServiceCollection" FullName="Microsoft.Extensions.DependencyInjection.ServiceCollection">
22
<TypeSignature Language="C#" Value="public class ServiceCollection : Microsoft.Extensions.DependencyInjection.IServiceCollection, System.Collections.Generic.ICollection&lt;Microsoft.Extensions.DependencyInjection.ServiceDescriptor&gt;, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.DependencyInjection.ServiceDescriptor&gt;, System.Collections.Generic.IList&lt;Microsoft.Extensions.DependencyInjection.ServiceDescriptor&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ServiceCollection extends System.Object implements class Microsoft.Extensions.DependencyInjection.IServiceCollection, class System.Collections.Generic.ICollection`1&lt;class Microsoft.Extensions.DependencyInjection.ServiceDescriptor&gt;, class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.DependencyInjection.ServiceDescriptor&gt;, class System.Collections.Generic.IList`1&lt;class Microsoft.Extensions.DependencyInjection.ServiceDescriptor&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.DependencyInjection.ServiceCollection" />
@@ -99,7 +99,7 @@
9999
</ReturnValue>
100100
<Parameters />
101101
<Docs>
102-
<summary>To be added.</summary>
102+
<summary>Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
103103
<remarks>To be added.</remarks>
104104
<inheritdoc />
105105
</Docs>
@@ -134,8 +134,9 @@
134134
</Parameters>
135135
<Docs>
136136
<param name="item">To be added.</param>
137-
<summary>To be added.</summary>
138-
<returns>To be added.</returns>
137+
<summary>Determines whether the <see cref="T:System.Collections.Generic.ICollection`1" /> contains a specific value.</summary>
138+
<returns>
139+
<see langword="true" /> if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />.</returns>
139140
<remarks>To be added.</remarks>
140141
<inheritdoc />
141142
</Docs>
@@ -172,7 +173,7 @@
172173
<Docs>
173174
<param name="array">To be added.</param>
174175
<param name="arrayIndex">To be added.</param>
175-
<summary>To be added.</summary>
176+
<summary>Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
176177
<remarks>To be added.</remarks>
177178
<inheritdoc />
178179
</Docs>
@@ -203,7 +204,7 @@
203204
<ReturnType>System.Int32</ReturnType>
204205
</ReturnValue>
205206
<Docs>
206-
<summary>To be added.</summary>
207+
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
207208
<value>To be added.</value>
208209
<remarks>To be added.</remarks>
209210
<inheritdoc />
@@ -236,8 +237,8 @@
236237
</ReturnValue>
237238
<Parameters />
238239
<Docs>
239-
<summary>To be added.</summary>
240-
<returns>To be added.</returns>
240+
<summary>Returns an enumerator that iterates through the collection.</summary>
241+
<returns>An enumerator that can be used to iterate through the collection.</returns>
241242
<remarks>To be added.</remarks>
242243
<inheritdoc />
243244
</Docs>
@@ -272,8 +273,8 @@
272273
</Parameters>
273274
<Docs>
274275
<param name="item">To be added.</param>
275-
<summary>To be added.</summary>
276-
<returns>To be added.</returns>
276+
<summary>Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1" />.</summary>
277+
<returns>The index of <paramref name="item" /> if found in the list; otherwise, -1.</returns>
277278
<remarks>To be added.</remarks>
278279
<inheritdoc />
279280
</Docs>
@@ -310,7 +311,7 @@
310311
<Docs>
311312
<param name="index">To be added.</param>
312313
<param name="item">To be added.</param>
313-
<summary>To be added.</summary>
314+
<summary>Inserts an item to the <see cref="T:System.Collections.Generic.IList`1" /> at the specified index.</summary>
314315
<remarks>To be added.</remarks>
315316
<inheritdoc />
316317
</Docs>
@@ -341,7 +342,7 @@
341342
<ReturnType>System.Boolean</ReturnType>
342343
</ReturnValue>
343344
<Docs>
344-
<summary>To be added.</summary>
345+
<summary>Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only.</summary>
345346
<value>To be added.</value>
346347
<remarks>To be added.</remarks>
347348
<inheritdoc />
@@ -377,7 +378,7 @@
377378
</Parameters>
378379
<Docs>
379380
<param name="index">To be added.</param>
380-
<summary>To be added.</summary>
381+
<summary>Gets or sets the element at the specified index.</summary>
381382
<value>To be added.</value>
382383
<remarks>To be added.</remarks>
383384
<inheritdoc />
@@ -413,8 +414,9 @@
413414
</Parameters>
414415
<Docs>
415416
<param name="item">To be added.</param>
416-
<summary>To be added.</summary>
417-
<returns>To be added.</returns>
417+
<summary>Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
418+
<returns>
419+
<see langword="true" /> if <paramref name="item" /> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="item" /> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1" />.</returns>
418420
<remarks>To be added.</remarks>
419421
<inheritdoc />
420422
</Docs>
@@ -449,7 +451,7 @@
449451
</Parameters>
450452
<Docs>
451453
<param name="index">To be added.</param>
452-
<summary>To be added.</summary>
454+
<summary>Removes the <see cref="T:System.Collections.Generic.IList`1" /> item at the specified index.</summary>
453455
<remarks>To be added.</remarks>
454456
<inheritdoc />
455457
</Docs>
@@ -483,8 +485,8 @@
483485
<Parameter Name="item" Type="Microsoft.Extensions.DependencyInjection.ServiceDescriptor" />
484486
</Parameters>
485487
<Docs>
486-
<param name="item">To be added.</param>
487-
<summary>To be added.</summary>
488+
<param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
489+
<summary>Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
488490
<remarks>To be added.</remarks>
489491
</Docs>
490492
</Member>
@@ -515,9 +517,17 @@
515517
</ReturnValue>
516518
<Parameters />
517519
<Docs>
518-
<summary>To be added.</summary>
519-
<returns>To be added.</returns>
520-
<remarks>To be added.</remarks>
520+
<summary>Returns an enumerator that iterates through a collection.</summary>
521+
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
522+
<remarks>
523+
<format type="text/markdown"><![CDATA[
524+
525+
## Remarks
526+
527+
This member is an explicit interface member implementation. It can be used only when the <xref:Microsoft.Extensions.DependencyInjection.ServiceCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
528+
529+
]]></format>
530+
</remarks>
521531
</Docs>
522532
</Member>
523533
</Members>

‎xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
</ReturnValue>
6565
<Parameters />
6666
<Docs>
67-
<summary>To be added.</summary>
67+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
6868
<remarks>To be added.</remarks>
6969
<inheritdoc />
7070
</Docs>
@@ -91,8 +91,8 @@
9191
</ReturnValue>
9292
<Parameters />
9393
<Docs>
94-
<summary>To be added.</summary>
95-
<returns>To be added.</returns>
94+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.</summary>
95+
<returns>A task that represents the asynchronous dispose operation.</returns>
9696
<remarks>To be added.</remarks>
9797
<inheritdoc />
9898
</Docs>

0 commit comments

Comments
 (0)