From 94d72a94a947aae9fa6f0f81b57ff968ccff8c2a Mon Sep 17 00:00:00 2001 From: Maryam Ariyan Date: Mon, 13 Apr 2020 17:22:56 -0700 Subject: [PATCH 1/2] More docs on: - Microsoft.Extensions.Caching.Memory - Microsoft.Extensions.Configuration - Microsoft.Extensions.DependencyInjection --- .../MemoryCache.xml | 15 +++--- .../MemoryCacheOptions.xml | 4 +- .../ChainedConfigurationProvider.xml | 4 +- .../ConfigurationRoot.xml | 4 +- .../FileConfigurationProvider.xml | 4 +- .../FakeService.xml | 4 +- .../DefaultServiceProviderFactory.xml | 10 ++-- .../ServiceCollection.xml | 52 +++++++++++-------- .../ServiceProvider.xml | 8 +-- 9 files changed, 58 insertions(+), 47 deletions(-) diff --git a/xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml b/xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml index e9d5552b2d1..a6f3e03abe8 100644 --- a/xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml +++ b/xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml @@ -1,4 +1,4 @@ - + @@ -169,8 +169,8 @@ To be added. - To be added. - To be added. + Create or overwrite an entry in the cache. + The newly created instance. To be added. @@ -201,7 +201,7 @@ - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. To be added. @@ -291,7 +291,7 @@ To be added. - To be added. + Removes the object associated with the given key. To be added. @@ -327,8 +327,9 @@ To be added. To be added. - To be added. - To be added. + Gets the item associated with this key if present. + + if the key was found. To be added. diff --git a/xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml b/xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml index ca59daf826f..b9f3c3f7283 100644 --- a/xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml +++ b/xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml @@ -1,4 +1,4 @@ - + @@ -185,7 +185,7 @@ Microsoft.Extensions.Caching.Memory.MemoryCacheOptions - To be added. + Gets the default configured instance. To be added. To be added. diff --git a/xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml b/xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml index 869a4ce63c4..9952abea65b 100644 --- a/xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml +++ b/xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml @@ -1,4 +1,4 @@ - + @@ -78,7 +78,7 @@ - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. To be added. diff --git a/xml/Microsoft.Extensions.Configuration/ConfigurationRoot.xml b/xml/Microsoft.Extensions.Configuration/ConfigurationRoot.xml index 766d62bb06c..12b166488a7 100644 --- a/xml/Microsoft.Extensions.Configuration/ConfigurationRoot.xml +++ b/xml/Microsoft.Extensions.Configuration/ConfigurationRoot.xml @@ -1,4 +1,4 @@ - + @@ -88,7 +88,7 @@ - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. To be added. diff --git a/xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml b/xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml index b4cab740324..9c49e8a4f17 100644 --- a/xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml +++ b/xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml @@ -1,4 +1,4 @@ - + @@ -81,7 +81,7 @@ - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. To be added. diff --git a/xml/Microsoft.Extensions.DependencyInjection.Specification.Fakes/FakeService.xml b/xml/Microsoft.Extensions.DependencyInjection.Specification.Fakes/FakeService.xml index 227ec468100..a28652cdac6 100644 --- a/xml/Microsoft.Extensions.DependencyInjection.Specification.Fakes/FakeService.xml +++ b/xml/Microsoft.Extensions.DependencyInjection.Specification.Fakes/FakeService.xml @@ -1,4 +1,4 @@ - + @@ -89,7 +89,7 @@ - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. To be added. diff --git a/xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml b/xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml index 3d34175a3ce..02cf4bf97be 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml @@ -1,4 +1,4 @@ - + @@ -105,8 +105,8 @@ To be added. - To be added. - To be added. + Creates a container builder from an . + A container builder that can be used to create an . To be added. @@ -139,8 +139,8 @@ To be added. - To be added. - To be added. + Creates an from the container builder. + An To be added. diff --git a/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml b/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml index ce094b90900..942ff9f52c6 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml @@ -1,4 +1,4 @@ - + @@ -96,7 +96,7 @@ - To be added. + Removes all items from the . To be added. @@ -130,8 +130,9 @@ To be added. - To be added. - To be added. + Determines whether the contains a specific value. + + if is found in the ; otherwise, . To be added. @@ -167,7 +168,7 @@ To be added. To be added. - To be added. + Copies the elements of the to an , starting at a particular index. To be added. @@ -197,7 +198,7 @@ System.Int32 - To be added. + Gets the number of elements contained in the . To be added. To be added. @@ -229,8 +230,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the collection. To be added. @@ -264,8 +265,8 @@ To be added. - To be added. - To be added. + Determines the index of a specific item in the . + The index of if found in the list; otherwise, -1. To be added. @@ -301,7 +302,7 @@ To be added. To be added. - To be added. + Inserts an item to the at the specified index. To be added. @@ -331,7 +332,7 @@ System.Boolean - To be added. + Gets a value indicating whether the is read-only. To be added. To be added. @@ -366,7 +367,7 @@ To be added. - To be added. + Gets or sets the element at the specified index. To be added. To be added. @@ -401,8 +402,9 @@ To be added. - To be added. - To be added. + Removes the first occurrence of a specific object from the . + + if was successfully removed from the ; otherwise, . This method also returns if is not found in the original . To be added. @@ -436,7 +438,7 @@ To be added. - To be added. + Removes the item at the specified index. To be added. @@ -469,8 +471,8 @@ - To be added. - To be added. + The object to add to the . + Adds an item to the . To be added. @@ -500,9 +502,17 @@ - To be added. - To be added. - To be added. + Returns an enumerator that iterates through a collection. + An object that can be used to iterate through the collection. + + instance is cast to an interface. + + ]]> + diff --git a/xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml b/xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml index 6b15ae98c95..c685aee5120 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml @@ -1,4 +1,4 @@ - + @@ -62,7 +62,7 @@ - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. To be added. @@ -88,8 +88,8 @@ - To be added. - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously. + A task that represents the asynchronous dispose operation. To be added. From 5aa4d00d4874a6ca52a12cf42812e263d50a221a Mon Sep 17 00:00:00 2001 From: Maryam Ariyan Date: Wed, 2 Sep 2020 14:54:12 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Applies PR feedback Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml | 2 +- .../DefaultServiceProviderFactory.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml b/xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml index 132b09dbb7e..332013f460c 100644 --- a/xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml +++ b/xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml @@ -175,7 +175,7 @@ To be added. - Create or overwrite an entry in the cache. + Creates or overwrites an entry in the cache. The newly created instance. To be added. diff --git a/xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml b/xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml index a095a53ae02..486bb6ee052 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml @@ -145,7 +145,7 @@ To be added. Creates an from the container builder. - An + An . To be added.