Skip to content

Extensions: DI, Configuration, Caching.Memory docs #4107

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
Sep 2, 2020
Merged

Extensions: DI, Configuration, Caching.Memory docs #4107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
94d72a9
More docs on:
maryamariyan Apr 14, 2020
ed12eba
Merge branch 'master' of https://github.com/dotnet/dotnet-api-docs in…
maryamariyan Sep 2, 2020
5aa4d00
Apply suggestions from code review
maryamariyan Sep 2, 2020
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
15 changes: 8 additions & 7 deletions xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="MemoryCache" FullName="Microsoft.Extensions.Caching.Memory.MemoryCache">
<Type Name="MemoryCache" FullName="Microsoft.Extensions.Caching.Memory.MemoryCache">
<TypeSignature Language="C#" Value="public class MemoryCache : IDisposable, Microsoft.Extensions.Caching.Memory.IMemoryCache" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MemoryCache extends System.Object implements class Microsoft.Extensions.Caching.Memory.IMemoryCache, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Caching.Memory.MemoryCache" />
Expand Down Expand Up @@ -175,8 +175,8 @@
</Parameters>
<Docs>
<param name="key">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Creates or overwrites an entry in the cache.</summary>
<returns>The newly created <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry" /> instance.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -208,7 +208,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -301,7 +301,7 @@
</Parameters>
<Docs>
<param name="key">To be added.</param>
<summary>To be added.</summary>
<summary>Removes the object associated with the given key.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -338,8 +338,9 @@
<Docs>
<param name="key">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Gets the item associated with this key if present.</summary>
<returns>
<see langword="true" /> if the key was found.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="MemoryCacheOptions" FullName="Microsoft.Extensions.Caching.Memory.MemoryCacheOptions">
<Type Name="MemoryCacheOptions" FullName="Microsoft.Extensions.Caching.Memory.MemoryCacheOptions">
<TypeSignature Language="C#" Value="public class MemoryCacheOptions : Microsoft.Extensions.Options.IOptions&lt;Microsoft.Extensions.Caching.Memory.MemoryCacheOptions&gt;" />
<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;" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions" />
Expand Down Expand Up @@ -192,7 +192,7 @@
<ReturnType>Microsoft.Extensions.Caching.Memory.MemoryCacheOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the default configured <typeparamref name="TOptions" /> instance.</summary>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure whether TOptions is meaningful here? Here's the preview: https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.caching.memory.memorydistributedcacheoptions?branch=pr-en-us-4107&view=dotnet-plat-ext-3.1#explicit-interface-implementations

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the description for CompactOnMemoryPressure on line 131 doesn't seem correct.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the description for CompactOnMemoryPressure on line 131 doesn't seem correct.

@gewarren which part do you think is off for CompactOnMemoryPressure?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@maryamariyan It duplicates the description for ExpirationScanFrequency and doesn't seem to match the property name.

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like CompactOnMemoryPressure is already obsolete

<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="ChainedConfigurationProvider" FullName="Microsoft.Extensions.Configuration.ChainedConfigurationProvider">
<Type Name="ChainedConfigurationProvider" FullName="Microsoft.Extensions.Configuration.ChainedConfigurationProvider">
<TypeSignature Language="C#" Value="public class ChainedConfigurationProvider : Microsoft.Extensions.Configuration.IConfigurationProvider" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2" />
<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" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Configuration.ChainedConfigurationProvider" />
Expand Down Expand Up @@ -81,7 +81,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Configuration/ConfigurationRoot.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="ConfigurationRoot" FullName="Microsoft.Extensions.Configuration.ConfigurationRoot">
<Type Name="ConfigurationRoot" FullName="Microsoft.Extensions.Configuration.ConfigurationRoot">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Configuration.ConfigurationRoot" />
Expand Down Expand Up @@ -91,7 +91,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="FileConfigurationProvider" FullName="Microsoft.Extensions.Configuration.FileConfigurationProvider">
<Type Name="FileConfigurationProvider" FullName="Microsoft.Extensions.Configuration.FileConfigurationProvider">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Configuration.FileConfigurationProvider" />
Expand Down Expand Up @@ -84,7 +84,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
10 changes: 5 additions & 5 deletions xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="DefaultServiceProviderFactory" FullName="Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory">
<Type Name="DefaultServiceProviderFactory" FullName="Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory">
<TypeSignature Language="C#" Value="public class DefaultServiceProviderFactory : Microsoft.Extensions.DependencyInjection.IServiceProviderFactory&lt;Microsoft.Extensions.DependencyInjection.IServiceCollection&gt;" />
<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;" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory" />
Expand Down Expand Up @@ -109,8 +109,8 @@
</Parameters>
<Docs>
<param name="services">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Creates a container builder from an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.</summary>
<returns>A container builder that can be used to create an <see cref="T:System.IServiceProvider" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -144,8 +144,8 @@
</Parameters>
<Docs>
<param name="containerBuilder">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Creates an <see cref="T:System.IServiceProvider" /> from the container builder.</summary>
<returns>An <see cref="T:System.IServiceProvider" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
52 changes: 31 additions & 21 deletions xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="ServiceCollection" FullName="Microsoft.Extensions.DependencyInjection.ServiceCollection">
<Type Name="ServiceCollection" FullName="Microsoft.Extensions.DependencyInjection.ServiceCollection">
<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;" />
<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" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.DependencyInjection.ServiceCollection" />
Expand Down Expand Up @@ -99,7 +99,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -134,8 +134,9 @@
</Parameters>
<Docs>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Determines whether the <see cref="T:System.Collections.Generic.ICollection`1" /> contains a specific value.</summary>
<returns>
<see langword="true" /> if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -172,7 +173,7 @@
<Docs>
<param name="array">To be added.</param>
<param name="arrayIndex">To be added.</param>
<summary>To be added.</summary>
<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>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -203,7 +204,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down Expand Up @@ -236,8 +237,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through the collection.</summary>
<returns>An enumerator that can be used to iterate through the collection.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -272,8 +273,8 @@
</Parameters>
<Docs>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1" />.</summary>
<returns>The index of <paramref name="item" /> if found in the list; otherwise, -1.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -310,7 +311,7 @@
<Docs>
<param name="index">To be added.</param>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<summary>Inserts an item to the <see cref="T:System.Collections.Generic.IList`1" /> at the specified index.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -341,7 +342,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down Expand Up @@ -377,7 +378,7 @@
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<summary>Gets or sets the element at the specified index.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down Expand Up @@ -413,8 +414,9 @@
</Parameters>
<Docs>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
<returns>
<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>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -449,7 +451,7 @@
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<summary>Removes the <see cref="T:System.Collections.Generic.IList`1" /> item at the specified index.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -483,8 +485,8 @@
<Parameter Name="item" Type="Microsoft.Extensions.DependencyInjection.ServiceDescriptor" />
</Parameters>
<Docs>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
<summary>Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -515,9 +517,17 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
6 changes: 3 additions & 3 deletions xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand All @@ -91,8 +91,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.</summary>
<returns>A task that represents the asynchronous dispose operation.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down