From ab6dfa84316d804750172dab21d9ae1cc3b49422 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 13 Sep 2024 13:09:37 -0700 Subject: [PATCH] Doc updates for source-of-truth assemblies (#107773) --- .../src/CacheEntryExtensions.cs | 12 ++++---- .../src/DistributedCacheEntryExtensions.cs | 2 +- .../src/DistributedCacheEntryOptions.cs | 2 +- .../src/DistributedCacheExtensions.cs | 12 ++++---- .../src/EvictionReason.cs | 2 +- .../src/Hybrid/HybridCache.cs | 4 +-- .../src/Hybrid/HybridCacheEntryOptions.cs | 4 +-- .../src/Hybrid/IHybridCacheSerializer.cs | 6 ++-- .../Hybrid/IHybridCacheSerializerFactory.cs | 4 +-- .../src/IBufferDistributedCache.cs | 12 ++++---- .../src/MemoryCacheEntryExtensions.cs | 6 ++-- .../src/MemoryCacheExtensions.cs | 16 +++++------ .../src/PostEvictionDelegate.cs | 2 +- .../src/MemoryCache.cs | 12 +++++--- .../src/MemoryCacheOptions.cs | 20 +++++++++---- .../MemoryCacheServiceCollectionExtensions.cs | 4 +-- .../src/MemoryDistributedCache.cs | 2 +- .../src/MemoryDistributedCacheOptions.cs | 2 +- .../src/ConfigurationDebugViewContext.cs | 2 +- .../src/ConfigurationExtensions.cs | 11 ++++---- .../src/ConfigurationKeyNameAttribute.cs | 2 +- .../src/ConfigurationPath.cs | 2 +- .../src/ConfigurationRootExtensions.cs | 14 +++++----- .../src/IConfigurationProvider.cs | 10 +++---- .../src/IConfigurationRoot.cs | 4 +-- .../src/BinderOptions.cs | 17 ++++++----- .../src/CommandLineConfigurationProvider.cs | 6 ++-- .../src/CommandLineConfigurationSource.cs | 6 ++-- ...vironmentVariablesConfigurationProvider.cs | 4 +-- ...EnvironmentVariablesConfigurationSource.cs | 2 +- .../src/EnvironmentVariablesExtensions.cs | 4 +-- .../src/FileConfigurationExtensions.cs | 2 +- .../src/FileConfigurationProvider.cs | 8 +++--- .../src/FileConfigurationSource.cs | 26 +++++++++-------- .../src/FileLoadExceptionContext.cs | 9 ++++-- .../src/IniConfigurationExtensions.cs | 16 +++++------ .../src/IniConfigurationProvider.cs | 2 +- .../src/IniStreamConfigurationProvider.cs | 8 +++--- .../src/IniStreamConfigurationSource.cs | 4 +-- .../src/JsonConfigurationProvider.cs | 2 +- .../src/JsonConfigurationSource.cs | 2 +- .../src/JsonStreamConfigurationProvider.cs | 8 +++--- .../src/UserSecretsConfigurationExtensions.cs | 14 +++++----- .../src/UserSecretsIdAttribute.cs | 2 +- .../src/XmlConfigurationExtensions.cs | 12 ++++---- .../src/XmlConfigurationProvider.cs | 2 +- .../src/XmlDocumentDecryptor.cs | 6 ++-- .../src/XmlStreamConfigurationProvider.cs | 8 +++--- .../src/XmlStreamConfigurationSource.cs | 4 +-- .../src/ChainedBuilderExtensions.cs | 2 +- .../src/ChainedConfigurationProvider.cs | 16 +++++------ .../src/ChainedConfigurationSource.cs | 8 +++--- .../src/ConfigurationBuilder.cs | 6 ++-- .../src/ConfigurationKeyComparer.cs | 4 +-- .../src/ConfigurationProvider.cs | 14 +++++----- .../src/ConfigurationReloadToken.cs | 10 +++---- .../src/ConfigurationRoot.cs | 12 ++++---- .../src/MemoryConfigurationProvider.cs | 4 +-- .../src/StreamConfigurationProvider.cs | 13 +++++---- .../src/StreamConfigurationSource.cs | 6 ++-- .../src/ActivatorUtilities.cs | 28 +++++++++---------- .../src/IKeyedServiceProvider.cs | 11 ++++---- .../src/IServiceProviderFactory.cs | 6 ++-- .../src/IServiceProviderIsKeyedService.cs | 2 +- .../src/IServiceProviderIsService.cs | 2 +- .../src/IServiceScope.cs | 7 +++-- .../src/IServiceScopeFactory.cs | 4 +-- .../src/ObjectFactoryT.cs | 6 ++-- .../src/ServiceKeyAttribute.cs | 3 +- .../src/ServiceProvider.cs | 4 +-- .../src/ServiceProviderOptions.cs | 8 ++++-- .../HttpClientBuilderExtensions.Logging.cs | 8 +++--- .../HttpClientBuilderExtensions.cs | 15 +++++----- .../ISocketsHttpHandlerBuilder.cs | 2 +- ...onfigurationServiceCollectionExtensions.cs | 10 +++---- .../src/OptionsBuilderExtensions.cs | 4 +-- .../src/OptionsServiceCollectionExtensions.cs | 4 +-- .../src/StringValues.cs | 12 ++++---- .../Formats/Cbor/Reader/CborReader.Integer.cs | 2 +- .../src/System/NIndex.cs | 2 +- .../src/System/NRange.cs | 4 +-- 81 files changed, 307 insertions(+), 275 deletions(-) diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/CacheEntryExtensions.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/CacheEntryExtensions.cs index f991a4adebdc08..93b88c4c90c2e7 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/CacheEntryExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/CacheEntryExtensions.cs @@ -8,7 +8,7 @@ namespace Microsoft.Extensions.Caching.Memory { /// - /// Provide extensions methods for operations. + /// Provides extensions methods for operations. /// public static class CacheEntryExtensions { @@ -27,7 +27,7 @@ public static ICacheEntry SetPriority( } /// - /// Expire the cache entry if the given expires. + /// Expires the cache entry if the given expires. /// /// The . /// The that causes the cache entry to expire. @@ -71,8 +71,8 @@ public static ICacheEntry SetAbsoluteExpiration( } /// - /// Sets how long the cache entry can be inactive (e.g. not accessed) before it will be removed. - /// This will not extend the entry lifetime beyond the absolute expiration (if set). + /// Sets how long the cache entry can be inactive (for example, not accessed) before it will be removed. + /// This method does not extend the entry lifetime beyond the absolute expiration (if set). /// /// The . /// A representing a sliding expiration. @@ -86,7 +86,7 @@ public static ICacheEntry SetSlidingExpiration( } /// - /// The given callback will be fired after the cache entry is evicted from the cache. + /// Fires the given callback after the cache entry is evicted from the cache. /// /// The . /// The callback to run after the entry is evicted. @@ -101,7 +101,7 @@ public static ICacheEntry RegisterPostEvictionCallback( } /// - /// The given callback will be fired after the cache entry is evicted from the cache. + /// Fires the given callback after the cache entry is evicted from the cache. /// /// The . /// The callback to run after the entry is evicted. diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheEntryExtensions.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheEntryExtensions.cs index a32449291d99fb..fa74dd0cec9951 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheEntryExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheEntryExtensions.cs @@ -6,7 +6,7 @@ namespace Microsoft.Extensions.Caching.Distributed { /// - /// Extension methods for operations. + /// Provides extension methods for operations. /// public static class DistributedCacheEntryExtensions { diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheEntryOptions.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheEntryOptions.cs index a1b5b9ae39a66e..10370e92acb635 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheEntryOptions.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheEntryOptions.cs @@ -53,7 +53,7 @@ public TimeSpan? AbsoluteExpirationRelativeToNow } /// - /// Gets or sets how long a cache entry can be inactive (e.g. not accessed) before it will be removed. + /// Gets or sets how long a cache entry can be inactive (for example, not accessed) before it will be removed. /// This will not extend the entry lifetime beyond the absolute expiration (if set). /// public TimeSpan? SlidingExpiration diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheExtensions.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheExtensions.cs index 4b9f396ff0b9c4..c6f8d23fc40bce 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/DistributedCacheExtensions.cs @@ -19,7 +19,7 @@ public static class DistributedCacheExtensions /// The cache in which to store the data. /// The key to store the data in. /// The data to store in the cache. - /// Thrown when or is null. + /// or is null. public static void Set(this IDistributedCache cache, string key, byte[] value) { ThrowHelper.ThrowIfNull(key); @@ -36,7 +36,7 @@ public static void Set(this IDistributedCache cache, string key, byte[] value) /// The data to store in the cache. /// Optional. A to cancel the operation. /// A task that represents the asynchronous set operation. - /// Thrown when or is null. + /// or is null. public static Task SetAsync(this IDistributedCache cache, string key, byte[] value, CancellationToken token = default(CancellationToken)) { ThrowHelper.ThrowIfNull(key); @@ -51,7 +51,7 @@ public static void Set(this IDistributedCache cache, string key, byte[] value) /// The cache in which to store the data. /// The key to store the data in. /// The data to store in the cache. - /// Thrown when or is null. + /// or is null. public static void SetString(this IDistributedCache cache, string key, string value) { cache.SetString(key, value, new DistributedCacheEntryOptions()); @@ -64,7 +64,7 @@ public static void SetString(this IDistributedCache cache, string key, string va /// The key to store the data in. /// The data to store in the cache. /// The cache options for the entry. - /// Thrown when or is null. + /// or is null. public static void SetString(this IDistributedCache cache, string key, string value, DistributedCacheEntryOptions options) { ThrowHelper.ThrowIfNull(key); @@ -81,7 +81,7 @@ public static void SetString(this IDistributedCache cache, string key, string va /// The data to store in the cache. /// Optional. A to cancel the operation. /// A task that represents the asynchronous set operation. - /// Thrown when or is null. + /// or is null. public static Task SetStringAsync(this IDistributedCache cache, string key, string value, CancellationToken token = default(CancellationToken)) { return cache.SetStringAsync(key, value, new DistributedCacheEntryOptions(), token); @@ -96,7 +96,7 @@ public static void SetString(this IDistributedCache cache, string key, string va /// The cache options for the entry. /// Optional. A to cancel the operation. /// A task that represents the asynchronous set operation. - /// Thrown when or is null. + /// or is null. public static Task SetStringAsync(this IDistributedCache cache, string key, string value, DistributedCacheEntryOptions options, CancellationToken token = default(CancellationToken)) { ThrowHelper.ThrowIfNull(key); diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/EvictionReason.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/EvictionReason.cs index cda96835792464..280882d5294283 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/EvictionReason.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/EvictionReason.cs @@ -4,7 +4,7 @@ namespace Microsoft.Extensions.Caching.Memory { /// - /// Specify the reasons why an entry was evicted from the cache. + /// Specifies the reasons why an entry was evicted from the cache. /// public enum EvictionReason { diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/HybridCache.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/HybridCache.cs index 479d0bbe69701d..d1867d1090c0e8 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/HybridCache.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/HybridCache.cs @@ -22,7 +22,7 @@ public abstract class HybridCache /// The type of additional state required by . /// The type of the data being considered. /// The key of the entry to look for or create. - /// Provides the underlying data service is the data is not available in the cache. + /// Provides the underlying data service if the data is not available in the cache. /// The state required for . /// Additional options for this cache entry. /// The tags to associate with this cache item. @@ -36,7 +36,7 @@ public abstract ValueTask GetOrCreateAsync(string key, TState stat /// /// The type of the data being considered. /// The key of the entry to look for or create. - /// Provides the underlying data service is the data is not available in the cache. + /// Provides the underlying data service if the data is not available in the cache. /// Additional options for this cache entry. /// The tags to associate with this cache item. /// The used to propagate notifications that the operation should be canceled. diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/HybridCacheEntryOptions.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/HybridCacheEntryOptions.cs index 8bc7343a52c97e..f9708fdd6bd8f1 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/HybridCacheEntryOptions.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/HybridCacheEntryOptions.cs @@ -7,10 +7,10 @@ namespace Microsoft.Extensions.Caching.Hybrid; /// -/// Additional options (expiration, etc.) that apply to a operation. When options +/// Specifies additional options (for example, expiration) that apply to a operation. When options /// can be specified at multiple levels (for example, globally and per-call), the values are composed; the /// most granular non-null value is used, with null values being inherited. If no value is specified at -/// any level, the implementation may choose a reasonable default. +/// any level, the implementation can choose a reasonable default. /// public sealed class HybridCacheEntryOptions { diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/IHybridCacheSerializer.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/IHybridCacheSerializer.cs index 5863a0721dff36..1f7197a4e5299d 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/IHybridCacheSerializer.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/IHybridCacheSerializer.cs @@ -6,18 +6,18 @@ namespace Microsoft.Extensions.Caching.Hybrid; /// -/// Per-type serialization/deserialization support for . +/// Provides per-type serialization and deserialization support for . /// /// The type being serialized/deserialized. public interface IHybridCacheSerializer { /// - /// Deserialize a value from the provided . + /// Deserializes a value from the provided . /// T Deserialize(ReadOnlySequence source); /// - /// Serialize to the provided . + /// Serializes to the provided . /// void Serialize(T value, IBufferWriter target); } diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/IHybridCacheSerializerFactory.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/IHybridCacheSerializerFactory.cs index d500ddfb2ba97e..a301b1fbbe23d5 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/IHybridCacheSerializerFactory.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/Hybrid/IHybridCacheSerializerFactory.cs @@ -11,9 +11,9 @@ namespace Microsoft.Extensions.Caching.Hybrid; public interface IHybridCacheSerializerFactory { /// - /// Request a serializer for the provided type, if possible. + /// Requests a serializer for the provided type, if possible. /// - /// The type being serialized/deserialized. + /// The type being serialized or deserialized. /// The serializer. /// true if the factory supports this type, false otherwise. bool TryCreateSerializer([NotNullWhen(true)] out IHybridCacheSerializer? serializer); diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/IBufferDistributedCache.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/IBufferDistributedCache.cs index 994d52766a9df0..ee3bd079ef22cd 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/IBufferDistributedCache.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/IBufferDistributedCache.cs @@ -13,22 +13,22 @@ public interface IBufferDistributedCache : IDistributedCache { /// - /// Attempt to retrieve an existing cache item. + /// Attempts to retrieve an existing cache item. /// /// The unique key for the cache item. /// The target to write the cache contents on success. /// true if the cache item is found, false otherwise. - /// This is functionally similar to , but avoids the array allocation. + /// This method is functionally similar to , but avoids the array allocation. bool TryGet(string key, IBufferWriter destination); /// - /// Asynchronously attempt to retrieve an existing cache entry. + /// Asynchronously attempts to retrieve an existing cache entry. /// /// The unique key for the cache entry. /// The target to write the cache contents on success. /// The used to propagate notifications that the operation should be canceled. /// true if the cache entry is found, false otherwise. - /// This is functionally similar to , but avoids the array allocation. + /// This method is functionally similar to , but avoids the array allocation. ValueTask TryGetAsync(string key, IBufferWriter destination, CancellationToken token = default); /// @@ -37,7 +37,7 @@ public interface IBufferDistributedCache : IDistributedCache /// The key of the entry to create. /// The value for this cache entry. /// The cache options for the entry. - /// This is functionally similar to , but avoids the array allocation. + /// This method is functionally similar to , but avoids the array allocation. void Set(string key, ReadOnlySequence value, DistributedCacheEntryOptions options); /// @@ -47,6 +47,6 @@ public interface IBufferDistributedCache : IDistributedCache /// The value for this cache entry. /// The cache options for the value. /// The used to propagate notifications that the operation should be canceled. - /// This is functionally similar to , but avoids the array allocation. + /// This method is functionally similar to , but avoids the array allocation. ValueTask SetAsync(string key, ReadOnlySequence value, DistributedCacheEntryOptions options, CancellationToken token = default); } diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/MemoryCacheEntryExtensions.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/MemoryCacheEntryExtensions.cs index 9a2a87918d4cb8..201993aeeb7a27 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/MemoryCacheEntryExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/MemoryCacheEntryExtensions.cs @@ -45,7 +45,7 @@ public static MemoryCacheEntryOptions SetSize( } /// - /// Expire the cache entry if the given expires. + /// Expires the cache entry if the given expires. /// /// The . /// The that causes the cache entry to expire. @@ -104,7 +104,7 @@ public static MemoryCacheEntryOptions SetSlidingExpiration( } /// - /// The given callback will be fired after the cache entry is evicted from the cache. + /// Fires the given callback after the cache entry is evicted from the cache. /// /// The . /// The callback to register for calling after an entry is evicted. @@ -119,7 +119,7 @@ public static MemoryCacheEntryOptions RegisterPostEvictionCallback( } /// - /// The given callback will be fired after the cache entry is evicted from the cache. + /// Fires the given callback after the cache entry is evicted from the cache. /// /// The . /// The callback to register for calling after an entry is evicted. diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/MemoryCacheExtensions.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/MemoryCacheExtensions.cs index 5ea58dc486dd06..c53cda1b0eaf61 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/MemoryCacheExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/MemoryCacheExtensions.cs @@ -8,7 +8,7 @@ namespace Microsoft.Extensions.Caching.Memory { /// - /// Provide extensions methods for operations. + /// Provides extensions methods for operations. /// public static class CacheExtensions { @@ -37,13 +37,13 @@ public static class CacheExtensions } /// - /// Try to get the value associated with the given key. + /// Tries to get the value associated with the given key. /// /// The type of the object to get. /// The instance this method extends. /// The key of the value to get. /// The value associated with the given key. - /// true if the key was found. false otherwise. + /// true if the key was found; false otherwise. public static bool TryGetValue(this IMemoryCache cache, object key, out TItem? value) { if (cache.TryGetValue(key, out object? result)) @@ -70,7 +70,7 @@ public static bool TryGetValue(this IMemoryCache cache, object key, out T /// /// The type of the object to set. /// The instance this method extends. - /// The key of the entry to add. + /// The key of the entry to set. /// The value to associate with the key. /// The value that was set. public static TItem Set(this IMemoryCache cache, object key, TItem value) @@ -86,7 +86,7 @@ public static TItem Set(this IMemoryCache cache, object key, TItem value) /// /// The type of the object to set. /// The instance this method extends. - /// The key of the entry to add. + /// The key of the entry to set. /// The value to associate with the key. /// The point in time at which the cache entry will expire. /// The value that was set. @@ -104,7 +104,7 @@ public static TItem Set(this IMemoryCache cache, object key, TItem value, /// /// The type of the object to set. /// The instance this method extends. - /// The key of the entry to add. + /// The key of the entry to set. /// The value to associate with the key. /// The duration from now after which the cache entry will expire. /// The value that was set. @@ -122,7 +122,7 @@ public static TItem Set(this IMemoryCache cache, object key, TItem value, /// /// The type of the object to set. /// The instance this method extends. - /// The key of the entry to add. + /// The key of the entry to set. /// The value to associate with the key. /// The that causes the cache entry to expire. /// The value that was set. @@ -140,7 +140,7 @@ public static TItem Set(this IMemoryCache cache, object key, TItem value, /// /// The type of the object to set. /// The instance this method extends. - /// The key of the entry to add. + /// The key of the entry to set. /// The value to associate with the key. /// The existing instance to apply to the new entry. /// The value that was set. diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PostEvictionDelegate.cs b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PostEvictionDelegate.cs index 6414f2154a9e4c..182bf90750b551 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PostEvictionDelegate.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PostEvictionDelegate.cs @@ -4,7 +4,7 @@ namespace Microsoft.Extensions.Caching.Memory { /// - /// Signature of the callback which gets called when a cache entry expires. + /// Represents the callback method that gets called when a cache entry expires. /// /// The key of the entry being evicted. /// The value of the entry being evicted. diff --git a/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCache.cs b/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCache.cs index 456064be264aca..0c95499694451a 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCache.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCache.cs @@ -434,9 +434,13 @@ private void ScanForExpiredItems() } /// - /// Returns true if increasing the cache size by the size of entry would - /// cause it to exceed any size limit on the cache, otherwise, returns false. + /// Determines if increasing the cache size by the size of the + /// entry would cause it to exceed any size limit on the cache. /// + /// + /// if increasing the cache size would + /// cause it to exceed the size limit; otherwise, . + /// private bool UpdateCacheSizeExceedsCapacity(CacheEntry entry, CacheEntry? priorEntry, CoherentState coherentState) { long sizeLimit = _options.SizeLimitValue; @@ -621,9 +625,9 @@ public void Dispose() } /// - /// Dispose the cache and clear all entries. + /// Disposes the cache and clears all entries. /// - /// Dispose the object resources if true; otherwise, take no action. + /// to dispose the object resources; to take no action. protected virtual void Dispose(bool disposing) { if (!_disposed) diff --git a/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCacheOptions.cs b/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCacheOptions.cs index a6117b07beaad0..8f15cd10e3afd4 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCacheOptions.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCacheOptions.cs @@ -9,7 +9,7 @@ namespace Microsoft.Extensions.Caching.Memory { /// - /// Options class for . + /// Specifies options for . /// public class MemoryCacheOptions : IOptions { @@ -56,14 +56,14 @@ public long? SizeLimit } /// - /// Enables ot disables the option to compact the cache when the maximum size is exceeded. + /// Gets or sets a value that indicates whether the cache is compacted when the maximum size is exceeded. /// [EditorBrowsableAttribute(EditorBrowsableState.Never)] [Obsolete("This property is retained only for compatibility. Remove use and instead call MemoryCache.Compact as needed.", error: true)] public bool CompactOnMemoryPressure { get; set; } /// - /// Gets or sets the amount to compact the cache by when the maximum size is exceeded. + /// Gets or sets the amount the cache is compacted by when the maximum size is exceeded. /// public double CompactionPercentage { @@ -80,14 +80,22 @@ public double CompactionPercentage } /// - /// Gets or sets whether to track linked entries. Disabled by default. + /// Gets or sets a value that indicates whether linked entries are tracked. /// - /// Prior to .NET 7 this feature was always enabled. + /// + /// if linked entries are tracked; otherwise, . + /// The default is . + /// + /// Prior to .NET 7, this feature was always enabled. public bool TrackLinkedCacheEntries { get; set; } /// - /// Gets or sets whether to track memory cache statistics. Disabled by default. + /// Gets or sets a value that indicates whether memory cache statistics are tracked. /// + /// + /// if memory cache statistics are tracked; otherwise, . + /// The default is . + /// public bool TrackStatistics { get; set; } MemoryCacheOptions IOptions.Value diff --git a/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCacheServiceCollectionExtensions.cs b/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCacheServiceCollectionExtensions.cs index b8d443cbac1989..f04a674209ba09 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCacheServiceCollectionExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCacheServiceCollectionExtensions.cs @@ -14,7 +14,7 @@ namespace Microsoft.Extensions.DependencyInjection public static class MemoryCacheServiceCollectionExtensions { /// - /// Adds a non distributed in memory implementation of to the + /// Adds a non distributed in-memory implementation of to the /// . /// /// The to add services to. @@ -30,7 +30,7 @@ public static IServiceCollection AddMemoryCache(this IServiceCollection services } /// - /// Adds a non distributed in memory implementation of to the + /// Adds a non distributed in-memory implementation of to the /// . /// /// The to add services to. diff --git a/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryDistributedCache.cs b/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryDistributedCache.cs index 7d6b45c2009762..a588e361abd12f 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryDistributedCache.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryDistributedCache.cs @@ -12,7 +12,7 @@ namespace Microsoft.Extensions.Caching.Distributed { /// - /// An implementation of using . + /// Implements using . /// public class MemoryDistributedCache : IDistributedCache { diff --git a/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryDistributedCacheOptions.cs b/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryDistributedCacheOptions.cs index 73afd8100e0a25..0e48a50e7be188 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryDistributedCacheOptions.cs +++ b/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryDistributedCacheOptions.cs @@ -4,7 +4,7 @@ namespace Microsoft.Extensions.Caching.Memory { /// - /// Options class for . + /// Specifies options for . /// public class MemoryDistributedCacheOptions : MemoryCacheOptions { diff --git a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationDebugViewContext.cs b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationDebugViewContext.cs index 4f7b3d6fa270ba..f0c70176f6c5c7 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationDebugViewContext.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationDebugViewContext.cs @@ -4,7 +4,7 @@ namespace Microsoft.Extensions.Configuration { /// - /// Provides the data about current item of the configuration. + /// Provides data about the current item of the configuration. /// public readonly struct ConfigurationDebugViewContext { diff --git a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationExtensions.cs b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationExtensions.cs index fa008b0959169f..408b8cb9034f7f 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationExtensions.cs @@ -9,7 +9,7 @@ namespace Microsoft.Extensions.Configuration { /// - /// Extension methods for configuration classes. + /// Provides extension methods for configuration classes. /// public static class ConfigurationExtensions { @@ -27,7 +27,8 @@ public static class ConfigurationExtensions } /// - /// Shorthand for GetSection("ConnectionStrings")[name]. + /// Gets the specified connection string from the specified configuration. + /// Shorthand for GetSection("ConnectionStrings")[name]. /// /// The configuration to enumerate. /// The connection string key. @@ -48,7 +49,7 @@ public static class ConfigurationExtensions /// Get the enumeration of key value pairs within the /// /// The configuration to enumerate. - /// If true, the child keys returned will have the current configuration's Path trimmed from the front. + /// to trim the current configuration's path from the front of the returned child keys. /// An enumeration of key value pairs. public static IEnumerable> AsEnumerable(this IConfiguration configuration, bool makePathsRelative) { @@ -71,7 +72,7 @@ public static class ConfigurationExtensions } /// - /// Determines whether the section has a or has children + /// Determines whether the section has a or has children. /// /// The section to enumerate. /// if the section has values or children; otherwise, . @@ -85,7 +86,7 @@ public static bool Exists([NotNullWhen(true)] this IConfigurationSection? sectio } /// - /// Gets a configuration sub-section with the specified key. + /// Gets a configuration subsection with the specified key. /// /// The configuration to enumerate. /// The key of the configuration section. diff --git a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationKeyNameAttribute.cs b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationKeyNameAttribute.cs index d9a4e52026778f..49e34e5893cf53 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationKeyNameAttribute.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationKeyNameAttribute.cs @@ -18,7 +18,7 @@ public sealed class ConfigurationKeyNameAttribute : Attribute public ConfigurationKeyNameAttribute(string name) => Name = name; /// - /// The key name for a configuration property. + /// Gets the key name for a configuration property. /// public string Name { get; } } diff --git a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationPath.cs b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationPath.cs index 14865e1b5f6e82..bd366e6b29564c 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationPath.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationPath.cs @@ -8,7 +8,7 @@ namespace Microsoft.Extensions.Configuration { /// - /// Utility methods and constants for manipulating Configuration paths + /// Provides utility methods and constants for manipulating Configuration paths. /// public static class ConfigurationPath { diff --git a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationRootExtensions.cs b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationRootExtensions.cs index 8a76e9486d9d07..fa323db0721c12 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationRootExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/ConfigurationRootExtensions.cs @@ -9,14 +9,14 @@ namespace Microsoft.Extensions.Configuration { /// - /// Extension methods for . + /// Provides extension methods for . /// public static class ConfigurationRootExtensions { /// /// Generates a human-readable view of the configuration showing where each value came from. /// - /// The debug view. + /// The debug view. public static string GetDebugView(this IConfigurationRoot root) { return GetDebugView(root, processValue: null); @@ -25,14 +25,14 @@ public static string GetDebugView(this IConfigurationRoot root) /// /// Generates a human-readable view of the configuration showing where each value came from. /// - /// Configuration root + /// The configuration root. /// - /// Function for processing the value e.g. hiding secrets + /// The function for processing the value, for example, hiding secrets. /// Parameters: - /// ConfigurationDebugViewContext: Context of the current configuration item - /// returns: A string value is used to assign as the Value of the configuration section + /// ConfigurationDebugViewContext: Context of the current configuration item. + /// returns: A string value is used to assign as the Value of the configuration section. /// - /// The debug view. + /// The debug view. public static string GetDebugView(this IConfigurationRoot root, Func? processValue) { void RecurseChildren( diff --git a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/IConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/IConfigurationProvider.cs index e957d91a0897df..c5684909eafd9b 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/IConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/IConfigurationProvider.cs @@ -15,8 +15,8 @@ public interface IConfigurationProvider /// Tries to get a configuration value for the specified key. /// /// The key. - /// The value. - /// True if a value for the specified key was found, otherwise false. + /// When this method returns, contains the value for the specified key. + /// if a value for the specified key was found, otherwise . bool TryGet(string key, out string? value); /// @@ -38,9 +38,9 @@ public interface IConfigurationProvider void Load(); /// - /// Returns the immediate descendant configuration keys for a given parent path based on this - /// s data and the set of keys returned by all the preceding - /// s. + /// Returns the immediate descendant configuration keys for a given parent path based on the data of this + /// and the set of keys returned by all the preceding + /// providers. /// /// The child keys returned by the preceding providers for the same parent path. /// The parent path. diff --git a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/IConfigurationRoot.cs b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/IConfigurationRoot.cs index dabdcc5da66b90..8c65634f7a8613 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/IConfigurationRoot.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/IConfigurationRoot.cs @@ -11,12 +11,12 @@ namespace Microsoft.Extensions.Configuration public interface IConfigurationRoot : IConfiguration { /// - /// Force the configuration values to be reloaded from the underlying s. + /// Forces the configuration values to be reloaded from the underlying providers. /// void Reload(); /// - /// The s for this configuration. + /// Gets the providers for this configuration. /// IEnumerable Providers { get; } } diff --git a/src/libraries/Microsoft.Extensions.Configuration.Binder/src/BinderOptions.cs b/src/libraries/Microsoft.Extensions.Configuration.Binder/src/BinderOptions.cs index b4664675b15dfb..9bdb48da5c1a5d 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Binder/src/BinderOptions.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Binder/src/BinderOptions.cs @@ -4,22 +4,25 @@ namespace Microsoft.Extensions.Configuration { /// - /// Options class used by the . + /// Specifies options used by the . /// public class BinderOptions { /// - /// When false (the default), the binder will only attempt to set public properties. - /// If true, the binder will attempt to set all non read-only properties. + /// Gets or sets a value that indicates whether the binder attempts to set all properties or only public properties. /// + /// + /// if the binder attempts to set all non-read-only properties; if only public properties are set. + /// public bool BindNonPublicProperties { get; set; } /// - /// When false (the default), no exceptions are thrown when trying to convert a value or when a configuration - /// key is found for which the provided model object does not have an appropriate property which matches the key's name. - /// When true, an is thrown with a description - /// of the error. + /// Gets or sets a value that indicates whether exceptions are thrown when converting a value or when a configuration + /// key is found for which the provided model object doesn't have an appropriate property that matches the key's name. /// + /// + /// if an is thrown with a description; if no exceptions are thrown. The default is . + /// public bool ErrorOnUnknownConfiguration { get; set; } } } diff --git a/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/CommandLineConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/CommandLineConfigurationProvider.cs index 8877a3086b2393..7afcfc40fa68fd 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/CommandLineConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/CommandLineConfigurationProvider.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.Configuration.CommandLine { /// - /// A command line based . + /// Provides configuration key-value pairs that are obtained from the command line. /// public class CommandLineConfigurationProvider : ConfigurationProvider { @@ -31,12 +31,12 @@ public CommandLineConfigurationProvider(IEnumerable args, IDictionary - /// The command line arguments. + /// Gets the command-line arguments. /// protected IEnumerable Args { get; } /// - /// Loads the configuration data from the command line args. + /// Loads the configuration data from the command-line arguments. /// public override void Load() { diff --git a/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/CommandLineConfigurationSource.cs b/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/CommandLineConfigurationSource.cs index 1dc7ad911811c0..f352ef944e1ad7 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/CommandLineConfigurationSource.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/CommandLineConfigurationSource.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.Configuration.CommandLine { /// - /// Represents command line arguments as an . + /// Represents command-line arguments as an . /// public class CommandLineConfigurationSource : IConfigurationSource { @@ -17,7 +17,7 @@ public class CommandLineConfigurationSource : IConfigurationSource public IDictionary? SwitchMappings { get; set; } /// - /// Gets or sets the command line args. + /// Gets or sets the command line arguments. /// public IEnumerable Args { get; set; } = Array.Empty(); @@ -25,7 +25,7 @@ public class CommandLineConfigurationSource : IConfigurationSource /// Builds the for this source. /// /// The . - /// A + /// A . public IConfigurationProvider Build(IConfigurationBuilder builder) { return new CommandLineConfigurationProvider(Args, SwitchMappings); diff --git a/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesConfigurationProvider.cs index 3888ac33a16b73..8025246ec88321 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesConfigurationProvider.cs @@ -8,7 +8,7 @@ namespace Microsoft.Extensions.Configuration.EnvironmentVariables { /// - /// An environment variable based . + /// Provides configuration key-value pairs that are obtained from environment variables. /// public class EnvironmentVariablesConfigurationProvider : ConfigurationProvider { @@ -48,7 +48,7 @@ public override void Load() => /// /// Generates a string representing this provider name and relevant details. /// - /// The configuration name. + /// The configuration name. public override string ToString() { string s = GetType().Name; diff --git a/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesConfigurationSource.cs b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesConfigurationSource.cs index 66e941af7f9bf1..079c8cf5eeaa1f 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesConfigurationSource.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesConfigurationSource.cs @@ -17,7 +17,7 @@ public class EnvironmentVariablesConfigurationSource : IConfigurationSource /// Builds the for this source. /// /// The . - /// A + /// A . public IConfigurationProvider Build(IConfigurationBuilder builder) { return new EnvironmentVariablesConfigurationProvider(Prefix); diff --git a/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesExtensions.cs b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesExtensions.cs index a5826a82a3a4cd..5f26561320463f 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/EnvironmentVariablesExtensions.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.Configuration { /// - /// Extension methods for registering with . + /// Provides extension methods for registering with . /// public static class EnvironmentVariablesExtensions { @@ -41,7 +41,7 @@ public static IConfigurationBuilder AddEnvironmentVariables( /// Adds an that reads configuration values from environment variables. /// /// The to add to. - /// Configures the source. + /// The action that configures the source. /// The . public static IConfigurationBuilder AddEnvironmentVariables(this IConfigurationBuilder builder, Action? configureSource) => builder.Add(configureSource); diff --git a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationExtensions.cs b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationExtensions.cs index f84c5c10eea771..669c9c3aee9bd1 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationExtensions.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.Configuration { /// - /// Extension methods for . + /// Provides extension methods for . /// public static class FileConfigurationExtensions { diff --git a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationProvider.cs index d226051b1ab838..d2cc8f5d85ac6f 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationProvider.cs @@ -13,7 +13,7 @@ namespace Microsoft.Extensions.Configuration { /// - /// Base class for file based . + /// Provides the base class for file-based providers. /// public abstract class FileConfigurationProvider : ConfigurationProvider, IDisposable { @@ -42,14 +42,14 @@ public FileConfigurationProvider(FileConfigurationSource source) } /// - /// The source settings for this provider. + /// Gets the source settings for this provider. /// public FileConfigurationSource Source { get; } /// /// Generates a string representing this provider name and relevant details. /// - /// The configuration name. + /// The configuration name. public override string ToString() => $"{GetType().Name} for '{Source.Path}' ({(Source.Optional ? "Optional" : "Required")})"; @@ -156,7 +156,7 @@ private void HandleException(ExceptionDispatchInfo info) public void Dispose() => Dispose(true); /// - /// Dispose the provider. + /// Disposes the provider. /// /// true if invoked from . protected virtual void Dispose(bool disposing) diff --git a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationSource.cs b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationSource.cs index d58c265f406a9a..ebbe0a6ffda0dc 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationSource.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationSource.cs @@ -9,39 +9,44 @@ namespace Microsoft.Extensions.Configuration { /// - /// Represents a base class for file based . + /// Provides the base class for file-based . /// public abstract class FileConfigurationSource : IConfigurationSource { /// - /// Used to access the contents of the file. + /// Gets or sets the provider used to access the contents of the file. /// public IFileProvider? FileProvider { get; set; } /// - /// The path to the file. + /// Gets or sets the path to the file. /// [DisallowNull] public string? Path { get; set; } /// - /// Determines if loading the file is optional. + /// Gets or sets a value that indicates whether loading the file is optional. /// public bool Optional { get; set; } /// - /// Determines whether the source will be loaded if the underlying file changes. + /// Gets or sets a value that indicates whether the source will be loaded if the underlying file changes. /// public bool ReloadOnChange { get; set; } /// - /// Number of milliseconds that reload will wait before calling Load. This helps - /// avoid triggering reload before a file is completely written. Default is 250. + /// Gets or sets the number of milliseconds that reload will wait before calling Load. /// + /// + /// The number of milliseconds that reload waits before calling Load. The default is 250. + /// + /// + /// This delay helps avoid triggering reload before a file is completely written. + /// public int ReloadDelay { get; set; } = 250; /// - /// Will be called if an uncaught exception occurs in FileConfigurationProvider.Load. + /// Gets or sets the action that's called if an uncaught exception occurs in FileConfigurationProvider.Load. /// public Action? OnLoadException { get; set; } @@ -49,7 +54,7 @@ public abstract class FileConfigurationSource : IConfigurationSource /// Builds the for this source. /// /// The . - /// A + /// To be added. public abstract IConfigurationProvider Build(IConfigurationBuilder builder); /// @@ -63,8 +68,7 @@ public void EnsureDefaults(IConfigurationBuilder builder) } /// - /// If no file provider has been set, for absolute Path, this will creates a physical file provider - /// for the nearest existing directory. + /// Creates a physical file provider for the nearest existing directory if no file provider has been set, for absolute Path. /// public void ResolveFileProvider() { diff --git a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileLoadExceptionContext.cs b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileLoadExceptionContext.cs index 1d619335d5e884..b8e393a397110d 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileLoadExceptionContext.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileLoadExceptionContext.cs @@ -11,18 +11,21 @@ namespace Microsoft.Extensions.Configuration public class FileLoadExceptionContext { /// - /// The that caused the exception. + /// Gets or sets the that caused the exception. /// public FileConfigurationProvider Provider { get; set; } = null!; /// - /// The exception that occurred in Load. + /// Gets or sets the exception that occurred in Load. /// public Exception Exception { get; set; } = null!; /// - /// If true, the exception will not be rethrown. + /// Gets or sets a value that indicates whether the exception is rethrown. /// + /// + /// if the exception isn't rethrown; otherwise, . + /// public bool Ignore { get; set; } } } diff --git a/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniConfigurationExtensions.cs b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniConfigurationExtensions.cs index 8331591b21562a..d77f18f3b8fd90 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniConfigurationExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniConfigurationExtensions.cs @@ -9,7 +9,7 @@ namespace Microsoft.Extensions.Configuration { /// - /// Extension methods for adding . + /// Provides extension methods for adding . /// public static class IniConfigurationExtensions { @@ -17,7 +17,7 @@ public static class IniConfigurationExtensions /// Adds the INI configuration provider at to . /// /// The to add to. - /// Path relative to the base path stored in + /// The path relative to the base path stored in /// of . /// The . public static IConfigurationBuilder AddIniFile(this IConfigurationBuilder builder, string path) @@ -29,7 +29,7 @@ public static IConfigurationBuilder AddIniFile(this IConfigurationBuilder builde /// Adds the INI configuration provider at to . /// /// The to add to. - /// Path relative to the base path stored in + /// The path relative to the base path stored in /// of . /// Whether the file is optional. /// The . @@ -44,8 +44,8 @@ public static IConfigurationBuilder AddIniFile(this IConfigurationBuilder builde /// The to add to. /// Path relative to the base path stored in /// of . - /// Whether the file is optional. - /// Whether the configuration should be reloaded if the file changes. + /// if the file is optional; otherwise, . + /// Whether the configuration should be reloaded if the file changes; otherwise, . /// The . public static IConfigurationBuilder AddIniFile(this IConfigurationBuilder builder, string path, bool optional, bool reloadOnChange) { @@ -59,8 +59,8 @@ public static IConfigurationBuilder AddIniFile(this IConfigurationBuilder builde /// The to use to access the file. /// Path relative to the base path stored in /// of . - /// Whether the file is optional. - /// Whether the configuration should be reloaded if the file changes. + /// if the file is optional; otherwise, . + /// if the configuration should be reloaded if the file changes; otherwise, . /// The . public static IConfigurationBuilder AddIniFile(this IConfigurationBuilder builder, IFileProvider? provider, string path, bool optional, bool reloadOnChange) { @@ -94,7 +94,7 @@ public static IConfigurationBuilder AddIniFile(this IConfigurationBuilder builde /// Adds a INI configuration source to . /// /// The to add to. - /// The to read the ini configuration data from. + /// The to read the INI configuration data from. /// The . public static IConfigurationBuilder AddIniStream(this IConfigurationBuilder builder, Stream stream) { diff --git a/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniConfigurationProvider.cs index 3d601510a7f44f..c63216856b22cf 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniConfigurationProvider.cs @@ -6,7 +6,7 @@ namespace Microsoft.Extensions.Configuration.Ini { /// - /// An INI file based . + /// Provides configuration key-value pairs that are obtained from an INI file. /// Files are simple line structures (INI Files on Wikipedia) /// /// diff --git a/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniStreamConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniStreamConfigurationProvider.cs index 9b010dc4762671..df6038b0290f4a 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniStreamConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniStreamConfigurationProvider.cs @@ -8,12 +8,12 @@ namespace Microsoft.Extensions.Configuration.Ini { /// - /// An INI file based . + /// Provides configuration key-value pairs that are obtained from an INI stream. /// public class IniStreamConfigurationProvider : StreamConfigurationProvider { /// - /// Constructor. + /// Initializes a new instance of . /// /// The . public IniStreamConfigurationProvider(IniStreamConfigurationSource source) : base(source) { } @@ -85,9 +85,9 @@ public IniStreamConfigurationProvider(IniStreamConfigurationSource source) : bas } /// - /// Loads INI configuration key/values from a stream into a provider. + /// Loads INI configuration key-value pairs from a stream into a provider. /// - /// The to load ini configuration data from. + /// The to load INI configuration data from. public override void Load(Stream stream) { Data = Read(stream); diff --git a/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniStreamConfigurationSource.cs b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniStreamConfigurationSource.cs index 01f594d91ce88d..dbce82e51ee5bf 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniStreamConfigurationSource.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/IniStreamConfigurationSource.cs @@ -4,7 +4,7 @@ namespace Microsoft.Extensions.Configuration.Ini { /// - /// Represents an INI file as an . + /// Represents an INI stream as an . /// Files are simple line structures (INI Files on Wikipedia) /// /// @@ -21,7 +21,7 @@ public class IniStreamConfigurationSource : StreamConfigurationSource /// Builds the for this source. /// /// The . - /// An + /// An . public override IConfigurationProvider Build(IConfigurationBuilder builder) => new IniStreamConfigurationProvider(this); } diff --git a/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonConfigurationProvider.cs index c2c1ef898a082c..3b127c74849221 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonConfigurationProvider.cs @@ -9,7 +9,7 @@ namespace Microsoft.Extensions.Configuration.Json { /// - /// A JSON file based . + /// Provides configuration key-value pairs that are obtained from a JSON file. /// public class JsonConfigurationProvider : FileConfigurationProvider { diff --git a/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonConfigurationSource.cs b/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonConfigurationSource.cs index da5eaf736b2285..28e239562b68ac 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonConfigurationSource.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonConfigurationSource.cs @@ -14,7 +14,7 @@ public class JsonConfigurationSource : FileConfigurationSource /// Builds the for this source. /// /// The . - /// A + /// A instance. public override IConfigurationProvider Build(IConfigurationBuilder builder) { EnsureDefaults(builder); diff --git a/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonStreamConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonStreamConfigurationProvider.cs index 2ed6ad11910291..86e1c0afd5dfe8 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonStreamConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonStreamConfigurationProvider.cs @@ -6,20 +6,20 @@ namespace Microsoft.Extensions.Configuration.Json { /// - /// Loads configuration key/values from a json stream into a provider. + /// Provides configuration key-value pairs that are obtained from a JSON stream. /// public class JsonStreamConfigurationProvider : StreamConfigurationProvider { /// - /// Constructor. + /// Initializes a new instance of the class. /// /// The . public JsonStreamConfigurationProvider(JsonStreamConfigurationSource source) : base(source) { } /// - /// Loads json configuration key/values from a stream into a provider. + /// Loads JSON configuration key-value pairs from a stream into a provider. /// - /// The json to load configuration data from. + /// The JSON to load configuration data from. public override void Load(Stream stream) { Data = JsonConfigurationFileParser.Parse(stream); diff --git a/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/UserSecretsConfigurationExtensions.cs b/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/UserSecretsConfigurationExtensions.cs index 61098fb255a17f..e82f5534aab449 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/UserSecretsConfigurationExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/UserSecretsConfigurationExtensions.cs @@ -10,7 +10,7 @@ namespace Microsoft.Extensions.Configuration { /// - /// Configuration extensions for adding user secrets configuration source. + /// Provides configuration extensions for adding user secrets configuration source. /// public static class UserSecretsConfigurationExtensions { @@ -25,7 +25,7 @@ public static class UserSecretsConfigurationExtensions /// /// The configuration builder. /// The type from the assembly to search for an instance of . - /// Thrown when the assembly containing does not have . + /// The assembly containing does not have . /// The configuration builder. public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder configuration) where T : class @@ -42,7 +42,7 @@ public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder /// /// The configuration builder. /// Whether loading secrets is optional. When false, this method may throw. - /// Thrown when is false and the assembly containing does not have a valid . + /// is false and the assembly containing does not have a valid . /// The type from the assembly to search for an instance of . /// The configuration builder. public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder configuration, bool optional) @@ -61,7 +61,7 @@ public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder /// The configuration builder. /// Whether loading secrets is optional. When false, this method may throw. /// Whether the configuration should be reloaded if the file changes. - /// Thrown when is false and the assembly containing does not have a valid . + /// is and the assembly containing does not have a valid . /// The type from the assembly to search for an instance of . /// The configuration builder. public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder configuration, bool optional, bool reloadOnChange) @@ -79,7 +79,7 @@ public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder /// /// The configuration builder. /// The assembly with the . - /// Thrown when does not have a valid + /// does not have a valid . /// The configuration builder. public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder configuration, Assembly assembly) => configuration.AddUserSecrets(assembly, optional: true, reloadOnChange: false); @@ -96,7 +96,7 @@ public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder co /// The configuration builder. /// The assembly with the . /// Whether loading secrets is optional. When false, this method may throw. - /// Thrown when is false and does not have a valid . + /// is false and does not have a valid . /// The configuration builder. public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder configuration, Assembly assembly, bool optional) => configuration.AddUserSecrets(assembly, optional, reloadOnChange: false); @@ -114,7 +114,7 @@ public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder co /// The assembly with the . /// Whether loading secrets is optional. When false, this method may throw. /// Whether the configuration should be reloaded if the file changes. - /// Thrown when is false and does not have a valid . + /// is false and does not have a valid . /// The configuration builder. public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder configuration, Assembly assembly, bool optional, bool reloadOnChange) { diff --git a/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/UserSecretsIdAttribute.cs b/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/UserSecretsIdAttribute.cs index 16459aef927735..cad8addf47f643 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/UserSecretsIdAttribute.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/UserSecretsIdAttribute.cs @@ -31,7 +31,7 @@ public UserSecretsIdAttribute(string userSecretId) } /// - /// The user secrets ID. + /// Gets the user secrets ID. /// public string UserSecretsId { get; } } diff --git a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlConfigurationExtensions.cs b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlConfigurationExtensions.cs index 716dc553848ac6..35eb1602a9e673 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlConfigurationExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlConfigurationExtensions.cs @@ -34,7 +34,7 @@ public static IConfigurationBuilder AddXmlFile(this IConfigurationBuilder builde /// The to add to. /// Path relative to the base path stored in /// of . - /// Whether the file is optional. + /// if the file is optional. /// The . [RequiresDynamicCode(XmlDocumentDecryptor.RequiresDynamicCodeMessage)] [RequiresUnreferencedCode(XmlDocumentDecryptor.RequiresUnreferencedCodeMessage)] @@ -49,7 +49,7 @@ public static IConfigurationBuilder AddXmlFile(this IConfigurationBuilder builde /// The to add to. /// Path relative to the base path stored in /// of . - /// Whether the file is optional. + /// if the file is optional. /// Whether the configuration should be reloaded if the file changes. /// The . [RequiresDynamicCode(XmlDocumentDecryptor.RequiresDynamicCodeMessage)] @@ -60,13 +60,13 @@ public static IConfigurationBuilder AddXmlFile(this IConfigurationBuilder builde } /// - /// Adds a XML configuration source to . + /// Adds an XML configuration source to . /// /// The to add to. /// The to use to access the file. /// Path relative to the base path stored in /// of . - /// Whether the file is optional. + /// if the file is optional. /// Whether the configuration should be reloaded if the file changes. /// The . [RequiresDynamicCode(XmlDocumentDecryptor.RequiresDynamicCodeMessage)] @@ -91,7 +91,7 @@ public static IConfigurationBuilder AddXmlFile(this IConfigurationBuilder builde } /// - /// Adds a XML configuration source to . + /// Adds an XML configuration source to . /// /// The to add to. /// Configures the source. @@ -102,7 +102,7 @@ public static IConfigurationBuilder AddXmlFile(this IConfigurationBuilder builde => builder.Add(configureSource); /// - /// Adds a XML configuration source to . + /// Adds an XML configuration source to . /// /// The to add to. /// The to read the XML configuration data from. diff --git a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlConfigurationProvider.cs index 029a24c2a46d2b..0753f30080e7b1 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlConfigurationProvider.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.Configuration.Xml { /// - /// Represents an XML file as an . + /// Provides configuration key-value pairs that are obtained from an XML file. /// [RequiresDynamicCode(XmlDocumentDecryptor.RequiresDynamicCodeMessage)] [RequiresUnreferencedCode(XmlDocumentDecryptor.RequiresUnreferencedCodeMessage)] diff --git a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlDocumentDecryptor.cs b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlDocumentDecryptor.cs index 46b17fe1c9c9e8..24f88d5166de9a 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlDocumentDecryptor.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlDocumentDecryptor.cs @@ -11,7 +11,7 @@ namespace Microsoft.Extensions.Configuration.Xml { /// - /// Class responsible for encrypting and decrypting XML. + /// Encrypts and decrypts XML. /// public class XmlDocumentDecryptor { @@ -26,7 +26,7 @@ public class XmlDocumentDecryptor private readonly Func? _encryptedXmlFactory; /// - /// Initializes a XmlDocumentDecryptor. + /// Initializes a new instance of the XmlDocumentDecryptor class. /// // don't create an instance of this directly protected XmlDocumentDecryptor() @@ -96,7 +96,7 @@ public XmlReader CreateDecryptingXmlReader(Stream input, XmlReaderSettings? sett /// Creates a reader that can decrypt an encrypted XML document. /// /// The document. - /// An XmlReader which can read the document. + /// An XmlReader that can read the document. [UnsupportedOSPlatform("browser")] [RequiresDynamicCode(RequiresDynamicCodeMessage)] [RequiresUnreferencedCode(RequiresUnreferencedCodeMessage)] diff --git a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlStreamConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlStreamConfigurationProvider.cs index b2db3ebc0e3286..0dc0eeb48f873c 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlStreamConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlStreamConfigurationProvider.cs @@ -12,7 +12,7 @@ namespace Microsoft.Extensions.Configuration.Xml { /// - /// An XML file based . + /// Provides configuration key-value pairs that are obtained from an XML stream. /// [RequiresDynamicCode(XmlDocumentDecryptor.RequiresDynamicCodeMessage)] [RequiresUnreferencedCode(XmlDocumentDecryptor.RequiresUnreferencedCodeMessage)] @@ -25,17 +25,17 @@ internal static class Consts } /// - /// Constructor. + /// Initializes a new instance of the class. /// /// The . public XmlStreamConfigurationProvider(XmlStreamConfigurationSource source) : base(source) { } /// - /// Read a stream of XML values into a key/value dictionary. + /// Reads a stream of XML values into a key/value dictionary. /// /// The stream of XML data. /// The to use to decrypt. - /// The which was read from the stream. + /// The that was read from the stream. public static IDictionary Read(Stream stream, XmlDocumentDecryptor decryptor) { var readerSettings = new XmlReaderSettings() diff --git a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlStreamConfigurationSource.cs b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlStreamConfigurationSource.cs index 8bcaee5554573e..6d0bafcb56f0fc 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlStreamConfigurationSource.cs +++ b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/XmlStreamConfigurationSource.cs @@ -6,7 +6,7 @@ namespace Microsoft.Extensions.Configuration.Xml { /// - /// Represents a XML file as an . + /// Represents an XML file as an . /// [RequiresDynamicCode(XmlDocumentDecryptor.RequiresDynamicCodeMessage)] [RequiresUnreferencedCode(XmlDocumentDecryptor.RequiresUnreferencedCodeMessage)] @@ -16,7 +16,7 @@ public class XmlStreamConfigurationSource : StreamConfigurationSource /// Builds the for this source. /// /// The . - /// An + /// An . public override IConfigurationProvider Build(IConfigurationBuilder builder) => new XmlStreamConfigurationProvider(this); } diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/ChainedBuilderExtensions.cs b/src/libraries/Microsoft.Extensions.Configuration/src/ChainedBuilderExtensions.cs index f6e013fa1c356a..53552dd9bb78bf 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/ChainedBuilderExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Configuration/src/ChainedBuilderExtensions.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.Configuration { /// - /// Extension methods for adding to an . + /// Provides extension methods for adding to an . /// public static class ChainedBuilderExtensions { diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/ChainedConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration/src/ChainedConfigurationProvider.cs index 4cfe5db2dd1402..71a324b6bb8df0 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/ChainedConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration/src/ChainedConfigurationProvider.cs @@ -8,7 +8,7 @@ namespace Microsoft.Extensions.Configuration { /// - /// Chained implementation of + /// Provides a chained implementation of . /// public class ChainedConfigurationProvider : IConfigurationProvider, IDisposable { @@ -16,7 +16,7 @@ public class ChainedConfigurationProvider : IConfigurationProvider, IDisposable private readonly bool _shouldDisposeConfig; /// - /// Initialize a new instance from the source configuration. + /// Initializes a new instance from the source configuration. /// /// The source configuration. public ChainedConfigurationProvider(ChainedConfigurationSource source) @@ -36,8 +36,8 @@ public ChainedConfigurationProvider(ChainedConfigurationSource source) /// Tries to get a configuration value for the specified key. /// /// The key. - /// The value. - /// True if a value for the specified key was found, otherwise false. + /// When this method returns, contains the value. + /// if a value for the specified key was found, otherwise . public bool TryGet(string key, out string? value) { value = _config[key]; @@ -52,7 +52,7 @@ public bool TryGet(string key, out string? value) public void Set(string key, string? value) => _config[key] = value; /// - /// Returns a change token if this provider supports change tracking, null otherwise. + /// Returns a change token if this provider supports change tracking; otherwise returns . /// /// The change token. public IChangeToken GetReloadToken() => _config.GetReloadToken(); @@ -63,9 +63,9 @@ public bool TryGet(string key, out string? value) public void Load() { } /// - /// Returns the immediate descendant configuration keys for a given parent path based on this - /// s data and the set of keys returned by all the preceding - /// s. + /// Returns the immediate descendant configuration keys for a given parent path based on the data of this + /// and the set of keys returned by all the preceding + /// objects. /// /// The child keys returned by the preceding providers for the same parent path. /// The parent path. diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/ChainedConfigurationSource.cs b/src/libraries/Microsoft.Extensions.Configuration/src/ChainedConfigurationSource.cs index b5a9c68c522db4..a1500f2e0943aa 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/ChainedConfigurationSource.cs +++ b/src/libraries/Microsoft.Extensions.Configuration/src/ChainedConfigurationSource.cs @@ -11,14 +11,14 @@ namespace Microsoft.Extensions.Configuration public class ChainedConfigurationSource : IConfigurationSource { /// - /// The chained configuration. + /// Gets or sets the chained configuration. /// [DisallowNull] public IConfiguration? Configuration { get; set; } /// - /// Whether the chained configuration should be disposed when the - /// configuration provider gets disposed. + /// Gets or sets a value that indicates whether the chained configuration + /// is disposed when the configuration provider is disposed. /// public bool ShouldDisposeConfiguration { get; set; } @@ -26,7 +26,7 @@ public class ChainedConfigurationSource : IConfigurationSource /// Builds the for this source. /// /// The . - /// A + /// A instance. public IConfigurationProvider Build(IConfigurationBuilder builder) => new ChainedConfigurationProvider(this); } diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationBuilder.cs b/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationBuilder.cs index dc7f3c536ac1a6..ca558cc1eb7034 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationBuilder.cs +++ b/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationBuilder.cs @@ -7,20 +7,20 @@ namespace Microsoft.Extensions.Configuration { /// - /// Used to build key/value based configuration settings for use in an application. + /// Builds key/value-based configuration settings for use in an application. /// public class ConfigurationBuilder : IConfigurationBuilder { private readonly List _sources = new(); /// - /// Returns the sources used to obtain configuration values. + /// Gets the sources used to obtain configuration values. /// public IList Sources => _sources; /// /// Gets a key/value collection that can be used to share data between the - /// and the registered s. + /// and the registered providers. /// public IDictionary Properties { get; } = new Dictionary(); diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationKeyComparer.cs b/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationKeyComparer.cs index 274f4696dd94af..d7ece22ed0e7b9 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationKeyComparer.cs +++ b/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationKeyComparer.cs @@ -7,14 +7,14 @@ namespace Microsoft.Extensions.Configuration { /// - /// IComparer implementation used to order configuration keys. + /// Implements IComparer to order configuration keys. /// public class ConfigurationKeyComparer : IComparer { private const char KeyDelimiter = ':'; /// - /// The default instance. + /// Gets the default instance. /// public static ConfigurationKeyComparer Instance { get; } = new ConfigurationKeyComparer(); diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationProvider.cs index ea73d6041f4b7a..3f39758d25b797 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationProvider.cs @@ -10,14 +10,14 @@ namespace Microsoft.Extensions.Configuration { /// - /// Base helper class for implementing an + /// Defines the core behavior of configuration providers and provides a base for derived classes. /// public abstract class ConfigurationProvider : IConfigurationProvider { private ConfigurationReloadToken _reloadToken = new ConfigurationReloadToken(); /// - /// Initializes a new + /// Initializes a new . /// protected ConfigurationProvider() { @@ -25,16 +25,16 @@ protected ConfigurationProvider() } /// - /// The configuration key value pairs for this provider. + /// Gets or sets the configuration key-value pairs for this provider. /// protected IDictionary Data { get; set; } /// - /// Attempts to find a value with the given key, returns true if one is found, false otherwise. + /// Attempts to find a value with the given key. /// /// The key to lookup. - /// The value found at key if one is found. - /// True if key has a value, false otherwise. + /// When this method returns, contains the value if one is found. + /// if has a value; otherwise . public virtual bool TryGet(string key, out string? value) => Data.TryGetValue(key, out value); @@ -121,7 +121,7 @@ protected void OnReload() /// /// Generates a string representing this provider name and relevant details. /// - /// The configuration name. + /// The configuration name. public override string ToString() => GetType().Name; } } diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationReloadToken.cs b/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationReloadToken.cs index 8168a93dcafe68..c6ff23dd9388e9 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationReloadToken.cs +++ b/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationReloadToken.cs @@ -9,22 +9,22 @@ namespace Microsoft.Extensions.Configuration { /// - /// Implements + /// Propagates notifications that a configuration change has occurred. /// public class ConfigurationReloadToken : IChangeToken { private readonly CancellationTokenSource _cts = new CancellationTokenSource(); /// - /// Indicates if this token will proactively raise callbacks. Callbacks are still guaranteed to be invoked, eventually. + /// Gets a value that indicates whether this token proactively raises callbacks. Callbacks are still guaranteed to be invoked, eventually. /// - /// True if the token will proactively raise callbacks. + /// if the token proactively raises callbacks. public bool ActiveChangeCallbacks { get; private set; } = true; /// /// Gets a value that indicates if a change has occurred. /// - /// True if a change has occurred. + /// if a change has occurred. public bool HasChanged => _cts.IsCancellationRequested; /// @@ -45,7 +45,7 @@ public IDisposable RegisterChangeCallback(Action callback, object? stat } /// - /// Used to trigger the change token when a reload occurs. + /// Triggers the change token when a reload occurs. /// public void OnReload() => _cts.Cancel(); } diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationRoot.cs b/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationRoot.cs index d3eefe19f7710b..50449bb6a2197e 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationRoot.cs +++ b/src/libraries/Microsoft.Extensions.Configuration/src/ConfigurationRoot.cs @@ -10,7 +10,7 @@ namespace Microsoft.Extensions.Configuration { /// - /// The root node for a configuration. + /// Represents the root node for a configuration. /// [DebuggerDisplay("{DebuggerToString(),nq}")] [DebuggerTypeProxy(typeof(ConfigurationRootDebugView))] @@ -54,7 +54,7 @@ public string? this[string key] } /// - /// Gets the immediate children sub-sections. + /// Gets the immediate children subsections. /// /// The children. public IEnumerable GetChildren() => this.GetChildrenImplementation(null); @@ -66,19 +66,19 @@ public string? this[string key] public IChangeToken GetReloadToken() => _changeToken; /// - /// Gets a configuration sub-section with the specified key. + /// Gets a configuration subsection with the specified key. /// /// The key of the configuration section. /// The . /// - /// This method will never return null. If no matching sub-section is found with the specified key, - /// an empty will be returned. + /// This method will never return null. If no matching subsection is found with the specified key, + /// an empty is returned. /// public IConfigurationSection GetSection(string key) => new ConfigurationSection(this, key); /// - /// Force the configuration values to be reloaded from the underlying sources. + /// Forces the configuration values to be reloaded from the underlying sources. /// public void Reload() { diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/MemoryConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration/src/MemoryConfigurationProvider.cs index 4e0774702b11c0..8eea6ba8da34e4 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/MemoryConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration/src/MemoryConfigurationProvider.cs @@ -8,7 +8,7 @@ namespace Microsoft.Extensions.Configuration.Memory { /// - /// In-memory implementation of + /// Provides configuration key-value pairs that are obtained from memory. /// public class MemoryConfigurationProvider : ConfigurationProvider, IEnumerable> { @@ -34,7 +34,7 @@ public MemoryConfigurationProvider(MemoryConfigurationSource source) } /// - /// Add a new key and value pair. + /// Adds a new key-value pair. /// /// The configuration key. /// The configuration value. diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/StreamConfigurationProvider.cs b/src/libraries/Microsoft.Extensions.Configuration/src/StreamConfigurationProvider.cs index 58bf27d0482c3a..be9f40a65a3b08 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/StreamConfigurationProvider.cs +++ b/src/libraries/Microsoft.Extensions.Configuration/src/StreamConfigurationProvider.cs @@ -7,19 +7,19 @@ namespace Microsoft.Extensions.Configuration { /// - /// Stream based configuration provider + /// Defines the core behavior of stream-based configuration providers and provides a base for derived classes. /// public abstract class StreamConfigurationProvider : ConfigurationProvider { /// - /// The source settings for this provider. + /// Gets the source settings for this provider. /// public StreamConfigurationSource Source { get; } private bool _loaded; /// - /// Constructor. + /// Initializes a new instance of the class. /// /// The source. public StreamConfigurationProvider(StreamConfigurationSource source) @@ -30,14 +30,17 @@ public StreamConfigurationProvider(StreamConfigurationSource source) } /// - /// Load the configuration data from the stream. + /// Loads the configuration data from the stream. /// /// The data stream. public abstract void Load(Stream stream); /// - /// Load the configuration data from the stream. Will throw after the first call. + /// Loads the configuration data from the stream. /// + /// + /// This method throws an exception on subsequent calls. + /// public override void Load() { if (_loaded) diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/StreamConfigurationSource.cs b/src/libraries/Microsoft.Extensions.Configuration/src/StreamConfigurationSource.cs index f857b9b313d00f..64f6502aebf048 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/StreamConfigurationSource.cs +++ b/src/libraries/Microsoft.Extensions.Configuration/src/StreamConfigurationSource.cs @@ -7,12 +7,12 @@ namespace Microsoft.Extensions.Configuration { /// - /// Stream based . + /// Defines the core behavior of stream-based configuration sources and provides a base for derived classes. /// public abstract class StreamConfigurationSource : IConfigurationSource { /// - /// The stream containing the configuration data. + /// Gets or sets the stream containing the configuration data. /// [DisallowNull] public Stream? Stream { get; set; } @@ -21,7 +21,7 @@ public abstract class StreamConfigurationSource : IConfigurationSource /// Builds the for this source. /// /// The . - /// An + /// An instance. public abstract IConfigurationProvider Build(IConfigurationBuilder builder); } } diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ActivatorUtilities.cs b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ActivatorUtilities.cs index dbbd70a9886299..e61a1c904039ec 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ActivatorUtilities.cs +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ActivatorUtilities.cs @@ -38,12 +38,12 @@ public static class ActivatorUtilities new Func(GetService).Method; /// - /// Instantiate a type with constructor arguments provided directly and/or from an . + /// Instantiates a type with constructor arguments provided directly and/or from an . /// - /// The service provider used to resolve dependencies - /// The type to activate + /// The service provider used to resolve dependencies. + /// The type to activate. /// Constructor arguments not provided by the . - /// An activated object of type instanceType + /// An activated object of type instanceType. public static object CreateInstance( IServiceProvider provider, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] Type instanceType, @@ -262,16 +262,16 @@ private static ConstructorInfoEx[] CreateConstructorInfoExs( } /// - /// Create a delegate that will instantiate a type with constructor arguments provided directly + /// Creates a delegate that will instantiate a type with constructor arguments provided directly /// and/or from an . /// - /// The type to activate + /// The type to activate. /// - /// The types of objects, in order, that will be passed to the returned function as its second parameter + /// The types of objects, in order, that will be passed to the returned function as its second parameter. /// /// /// A factory that will instantiate instanceType using an - /// and an argument array containing objects matching the types defined in argumentTypes + /// and an argument array containing objects matching the types defined in argumentTypes. /// public static ObjectFactory CreateFactory( [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] Type instanceType, @@ -355,9 +355,9 @@ private static void CreateFactoryInternal([DynamicallyAccessedMembers(Dynamicall /// /// Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly. /// - /// The type of the service - /// The service provider used to resolve dependencies - /// The resolved service or created instance + /// The type of the service. + /// The service provider used to resolve dependencies. + /// The resolved service or created instance. public static T GetServiceOrCreateInstance<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] T>(IServiceProvider provider) { return (T)GetServiceOrCreateInstance(provider, typeof(T)); @@ -366,9 +366,9 @@ private static void CreateFactoryInternal([DynamicallyAccessedMembers(Dynamicall /// /// Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly. /// - /// The service provider - /// The type of the service - /// The resolved service or created instance + /// The service provider. + /// The type of the service. + /// The resolved service or created instance. public static object GetServiceOrCreateInstance( IServiceProvider provider, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] Type type) diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IKeyedServiceProvider.cs b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IKeyedServiceProvider.cs index af025a5bf6a8b7..3527adac4310e8 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IKeyedServiceProvider.cs +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IKeyedServiceProvider.cs @@ -6,8 +6,7 @@ namespace Microsoft.Extensions.DependencyInjection { /// - /// IKeyedServiceProvider is a service provider that can be used to retrieve services using a key in addition - /// to a type. + /// Retrieves services using a key and a type. /// public interface IKeyedServiceProvider : IServiceProvider { @@ -16,7 +15,9 @@ public interface IKeyedServiceProvider : IServiceProvider /// /// An object that specifies the type of service object to get. /// An object that specifies the key of service object to get. - /// A service object of type serviceType. -or- null if there is no service object of type serviceType. + /// A service object of type . + /// -or- + /// if there is no service object of type . object? GetKeyedService(Type serviceType, object? serviceKey); /// @@ -31,12 +32,12 @@ public interface IKeyedServiceProvider : IServiceProvider } /// - /// Statics for use with . + /// Provides static APIs for use with . /// public static class KeyedService { /// - /// Represents a key that matches any key. + /// Gets a key that matches any key. /// public static object AnyKey { get; } = new AnyKeyObj(); diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderFactory.cs b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderFactory.cs index 35854cc836bf78..8ea9bc282c8525 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderFactory.cs +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderFactory.cs @@ -13,15 +13,15 @@ public interface IServiceProviderFactory where TContainerBuil /// /// Creates a container builder from an . /// - /// The collection of services + /// The collection of services. /// A container builder that can be used to create an . TContainerBuilder CreateBuilder(IServiceCollection services); /// /// Creates an from the container builder. /// - /// The container builder - /// An + /// The container builder. + /// An instance. IServiceProvider CreateServiceProvider(TContainerBuilder containerBuilder); } } diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderIsKeyedService.cs b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderIsKeyedService.cs index 1517011a67b993..d0d852900aac65 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderIsKeyedService.cs +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderIsKeyedService.cs @@ -6,7 +6,7 @@ namespace Microsoft.Extensions.DependencyInjection { /// - /// Optional service used to determine if the specified type with the specified service key is available + /// Provides methods to determine if the specified type with the specified service key is available /// from the . /// public interface IServiceProviderIsKeyedService : IServiceProviderIsService diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderIsService.cs b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderIsService.cs index b24ab154d16e93..1fb7236ad48441 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderIsService.cs +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceProviderIsService.cs @@ -6,7 +6,7 @@ namespace Microsoft.Extensions.DependencyInjection { /// - /// Optional service used to determine if the specified type is available from the . + /// Provides methods to determine if the specified type is available from the . /// public interface IServiceProviderIsService { diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceScope.cs b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceScope.cs index e83a33dde92375..803e96d9fd0687 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceScope.cs +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceScope.cs @@ -6,15 +6,18 @@ namespace Microsoft.Extensions.DependencyInjection { /// + /// Defines a disposable service scope. + /// + /// /// The method ends the scope lifetime. Once Dispose /// is called, any scoped services that have been resolved from /// will be /// disposed. - /// + /// public interface IServiceScope : IDisposable { /// - /// The used to resolve dependencies from the scope. + /// Gets the used to resolve dependencies from the scope. /// IServiceProvider ServiceProvider { get; } } diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceScopeFactory.cs b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceScopeFactory.cs index 9d9aede9003e39..7b3b97ec722d5d 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceScopeFactory.cs +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/IServiceScopeFactory.cs @@ -4,13 +4,13 @@ namespace Microsoft.Extensions.DependencyInjection { /// - /// A factory for creating instances of , which is used to create + /// Creates instances of , which is used to create /// services within a scope. /// public interface IServiceScopeFactory { /// - /// Create an which + /// Create an that /// contains an used to resolve dependencies from a /// newly created scope. /// diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ObjectFactoryT.cs b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ObjectFactoryT.cs index 52ec33f8dc7cf6..b5a1e25980aad9 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ObjectFactoryT.cs +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ObjectFactoryT.cs @@ -6,11 +6,11 @@ namespace Microsoft.Extensions.DependencyInjection { /// - /// The result of . A delegate to specify a factory method to call to instantiate an instance of type `T` + /// Returns the result of , which is a delegate that specifies a factory method to call to instantiate an instance of type . /// - /// The type of the instance being returned + /// The type of the instance that's returned. /// The to get service arguments from. /// Additional constructor arguments. - /// An instance of T + /// An instance of type . public delegate T ObjectFactory(IServiceProvider serviceProvider, object?[]? arguments); } diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ServiceKeyAttribute.cs b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ServiceKeyAttribute.cs index eccdd34b48b8f3..b60e0de42a6b41 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ServiceKeyAttribute.cs +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ServiceKeyAttribute.cs @@ -6,8 +6,7 @@ namespace Microsoft.Extensions.DependencyInjection { /// - /// ServiceKeyAttribute can be specified on a parameter to inject the key that was used for - /// registration/resolution. + /// Specifies the parameter to inject the key that was used for registration or resolution. /// [AttributeUsage(AttributeTargets.Parameter)] public class ServiceKeyAttribute : Attribute diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection/src/ServiceProvider.cs b/src/libraries/Microsoft.Extensions.DependencyInjection/src/ServiceProvider.cs index 9c2dfdbb0dffb9..d3177c229e31ec 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection/src/ServiceProvider.cs +++ b/src/libraries/Microsoft.Extensions.DependencyInjection/src/ServiceProvider.cs @@ -115,12 +115,12 @@ internal ServiceProvider(ICollection serviceDescriptors, Serv => GetService(new ServiceIdentifier(serviceKey, serviceType), serviceProviderEngineScope); /// - /// Gets the service object of the specified type. Will throw if the service not found. + /// Gets the service object of the specified type. /// /// The type of the service to get. /// The key of the service to get. /// The keyed service. - /// + /// The service wasn't found. public object GetRequiredKeyedService(Type serviceType, object? serviceKey) => GetRequiredKeyedService(serviceType, serviceKey, Root); diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection/src/ServiceProviderOptions.cs b/src/libraries/Microsoft.Extensions.DependencyInjection/src/ServiceProviderOptions.cs index 4cb165bf9c418f..09c75aaeee2f28 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection/src/ServiceProviderOptions.cs +++ b/src/libraries/Microsoft.Extensions.DependencyInjection/src/ServiceProviderOptions.cs @@ -14,14 +14,16 @@ public class ServiceProviderOptions internal static readonly ServiceProviderOptions Default = new ServiceProviderOptions(); /// - /// true to perform check verifying that scoped services never gets resolved from root provider; otherwise false. Defaults to false. + /// Gets or sets a value that indicates whether validation is performed to ensure that scoped services are never resolved from the root provider. /// public bool ValidateScopes { get; set; } /// - /// true to perform check verifying that all services can be created during BuildServiceProvider call; otherwise false. Defaults to false. - /// NOTE: this check doesn't verify open generics services. + /// Gets or sets a value that indicates whether validation is performed to ensure all services can be created when is called. /// + /// + /// Open generics services aren't validated. + /// public bool ValidateOnBuild { get; set; } } } diff --git a/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/HttpClientBuilderExtensions.Logging.cs b/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/HttpClientBuilderExtensions.Logging.cs index f87aff245cd6f1..bf1b3c6d4ae90a 100644 --- a/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/HttpClientBuilderExtensions.Logging.cs +++ b/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/HttpClientBuilderExtensions.Logging.cs @@ -21,14 +21,14 @@ public static partial class HttpClientBuilderExtensions /// An that can be used to configure the client. /// /// - /// If the is `true`, and + /// If the is `true`, and /// would be executed before all /// other additional handlers in the chain. and /// would be executed after all /// other additional handlers, essentially wrapping the whole pipeline. /// /// - /// If the is `false`, and + /// If the is `false`, and /// would be executed after all /// other additional handlers in the chain, right before the primary handler. and /// would be executed before all @@ -83,14 +83,14 @@ public static IHttpClientBuilder AddLogger(this IHttpClientBuilder builder, Func /// /// /// - /// If the is `true`, and + /// If the is `true`, and /// would be executed before all /// other additional handlers in the chain. and /// would be executed after all /// other additional handlers, essentially wrapping the whole pipeline. /// /// - /// If the is `false`, and + /// If the is `false`, and /// would be executed after all /// other additional handlers in the chain, right before the primary handler. and /// would be executed before all diff --git a/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/HttpClientBuilderExtensions.cs b/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/HttpClientBuilderExtensions.cs index fcd10d2aa0cb36..d6e92e47a753cf 100644 --- a/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/HttpClientBuilderExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/HttpClientBuilderExtensions.cs @@ -15,7 +15,7 @@ namespace Microsoft.Extensions.DependencyInjection { /// - /// Extension methods for configuring an + /// Extension methods for configuring an . /// public static partial class HttpClientBuilderExtensions { @@ -68,7 +68,7 @@ public static IHttpClientBuilder ConfigureHttpClient(this IHttpClientBuilder bui /// A delegate that is used to create a . /// An that can be used to configure the client. /// - /// The delegate should return a new instance of the message handler each time it + /// The delegate should return a new instance of the message handler each time it /// is invoked. /// public static IHttpClientBuilder AddHttpMessageHandler(this IHttpClientBuilder builder, Func configureHandler) @@ -88,10 +88,11 @@ public static IHttpClientBuilder AddHttpMessageHandler(this IHttpClientBuilder b /// Adds a delegate that will be used to create an additional message handler for a named . /// /// The . - /// A delegate that is used to create a . /// An that can be used to configure the client. + /// A delegate that is used to create a . + /// An that can be used to configure the client. /// /// - /// The delegate should return a new instance of the message handler each time it + /// The delegate should return a new instance of the message handler each time it /// is invoked. /// /// @@ -147,7 +148,7 @@ public static IHttpClientBuilder AddHttpMessageHandler(this IHttpClien /// A delegate that is used to create an . /// An that can be used to configure the client. /// - /// The delegate should return a new instance of the message handler each time it + /// The delegate should return a new instance of the message handler each time it /// is invoked. /// public static IHttpClientBuilder ConfigurePrimaryHttpMessageHandler(this IHttpClientBuilder builder, Func configureHandler) @@ -172,7 +173,7 @@ public static IHttpClientBuilder ConfigurePrimaryHttpMessageHandler(this IHttpCl /// An that can be used to configure the client. /// /// - /// The delegate should return a new instance of the message handler each time it + /// The delegate should return a new instance of the message handler each time it /// is invoked. /// /// @@ -195,7 +196,7 @@ public static IHttpClientBuilder ConfigurePrimaryHttpMessageHandler(this IHttpCl /// /// Configures the primary from the dependency injection container - /// for a named . + /// for a named . /// /// The . /// An that can be used to configure the client. diff --git a/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/ISocketsHttpHandlerBuilder.cs b/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/ISocketsHttpHandlerBuilder.cs index 75333f8d747c71..c942b42c58093b 100644 --- a/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/ISocketsHttpHandlerBuilder.cs +++ b/src/libraries/Microsoft.Extensions.Http/src/DependencyInjection/ISocketsHttpHandlerBuilder.cs @@ -5,7 +5,7 @@ namespace Microsoft.Extensions.DependencyInjection { /// - /// A builder for configuring for a named + /// Configures for a named /// instances returned by . /// public interface ISocketsHttpHandlerBuilder diff --git a/src/libraries/Microsoft.Extensions.Options.ConfigurationExtensions/src/OptionsConfigurationServiceCollectionExtensions.cs b/src/libraries/Microsoft.Extensions.Options.ConfigurationExtensions/src/OptionsConfigurationServiceCollectionExtensions.cs index 89c15c052eea3c..aae277058fe3c4 100644 --- a/src/libraries/Microsoft.Extensions.Options.ConfigurationExtensions/src/OptionsConfigurationServiceCollectionExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Options.ConfigurationExtensions/src/OptionsConfigurationServiceCollectionExtensions.cs @@ -9,12 +9,12 @@ namespace Microsoft.Extensions.DependencyInjection { /// - /// Extension methods for adding configuration related options services to the DI container. + /// Extension methods for adding configuration-related options services to the DI container. /// public static class OptionsConfigurationServiceCollectionExtensions { /// - /// Registers a configuration instance which TOptions will bind against. + /// Registers a configuration instance that will bind against. /// /// The type of options being configured. /// The to add the services to. @@ -26,7 +26,7 @@ public static class OptionsConfigurationServiceCollectionExtensions => services.Configure(Options.Options.DefaultName, config); /// - /// Registers a configuration instance which TOptions will bind against. + /// Registers a configuration instance that will bind against. /// /// The type of options being configured. /// The to add the services to. @@ -39,7 +39,7 @@ public static class OptionsConfigurationServiceCollectionExtensions => services.Configure(name, config, _ => { }); /// - /// Registers a configuration instance which TOptions will bind against. + /// Registers a configuration instance that will bind against. /// /// The type of options being configured. /// The to add the services to. @@ -53,7 +53,7 @@ public static class OptionsConfigurationServiceCollectionExtensions => services.Configure(Options.Options.DefaultName, config, configureBinder); /// - /// Registers a configuration instance which TOptions will bind against. + /// Registers a configuration instance that will bind against. /// /// The type of options being configured. /// The to add the services to. diff --git a/src/libraries/Microsoft.Extensions.Options/src/OptionsBuilderExtensions.cs b/src/libraries/Microsoft.Extensions.Options/src/OptionsBuilderExtensions.cs index 2eacc9038e309a..92eb966ca30ddd 100644 --- a/src/libraries/Microsoft.Extensions.Options/src/OptionsBuilderExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Options/src/OptionsBuilderExtensions.cs @@ -9,14 +9,14 @@ namespace Microsoft.Extensions.DependencyInjection { /// - /// Extension methods for adding configuration related options services to the DI container via . + /// Extension methods for adding configuration-related options services to the DI container via . /// [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2091:UnrecognizedReflectionPattern", Justification = "Workaround for https://github.com/mono/linker/issues/1416. Outer method has been annotated with DynamicallyAccessedMembers.")] public static class OptionsBuilderExtensions { /// - /// Enforces options validation check on start rather than in runtime. + /// Enforces options validation check on start rather than at run time. /// /// The type of options. /// The to configure options instance. diff --git a/src/libraries/Microsoft.Extensions.Options/src/OptionsServiceCollectionExtensions.cs b/src/libraries/Microsoft.Extensions.Options/src/OptionsServiceCollectionExtensions.cs index 6f212cc3b35df3..131f5d66e9220c 100644 --- a/src/libraries/Microsoft.Extensions.Options/src/OptionsServiceCollectionExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Options/src/OptionsServiceCollectionExtensions.cs @@ -32,7 +32,7 @@ public static IServiceCollection AddOptions(this IServiceCollection services) } /// - /// Adds services required for using options and enforces options validation check on start rather than in runtime. + /// Adds services required for using options and enforces options validation check on start rather than at run time. /// /// /// The extension is called by this method. @@ -51,7 +51,7 @@ public static OptionsBuilder AddOptionsWithValidateOnStart< } /// - /// Adds services required for using options and enforces options validation check on start rather than in runtime. + /// Adds services required for using options and enforces options validation check on start rather than at run time. /// /// /// The extension is called by this method. diff --git a/src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs b/src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs index 591830f3bec384..67d9261276d7d6 100644 --- a/src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs +++ b/src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs @@ -302,7 +302,7 @@ static string GetJoinedStringValueFromArray(string?[] values) /// Returns the zero-based index of the first occurrence of an item in the . /// /// The string to locate in the . - /// the zero-based index of the first occurrence of within the , if found; otherwise, -1. + /// The zero-based index of the first occurrence of within the , if found; otherwise, -1. int IList.IndexOf(string? item) { return IndexOf(item); @@ -335,7 +335,7 @@ private int IndexOf(string? item) /// Determines whether a string is in the . /// The to locate in the . - /// true if item is found in the ; otherwise, false. + /// if is found in the ; otherwise, . bool ICollection.Contains(string? item) { return IndexOf(item) >= 0; @@ -346,9 +346,9 @@ private int IndexOf(string? item) /// /// The one-dimensional that is the destination of the elements copied from. The must have zero-based indexing. /// The zero-based index in the destination array at which copying begins. - /// array is null. - /// arrayIndex is less than 0. - /// The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array. + /// is null. + /// is less than 0. + /// The number of elements in the source is greater than the available space from to the end of the destination . void ICollection.CopyTo(string?[] array, int arrayIndex) { CopyTo(array, arrayIndex); @@ -418,7 +418,7 @@ IEnumerator IEnumerable.GetEnumerator() /// Indicates whether the specified contains no string values. /// /// The to test. - /// true if value contains a single null or empty string or an empty array; otherwise, false. + /// true if contains a single null or empty string or an empty array; otherwise, false. public static bool IsNullOrEmpty(StringValues value) { object? data = value._values; diff --git a/src/libraries/System.Formats.Cbor/src/System/Formats/Cbor/Reader/CborReader.Integer.cs b/src/libraries/System.Formats.Cbor/src/System/Formats/Cbor/Reader/CborReader.Integer.cs index 6ad6760f56e8eb..6c663974a81e04 100644 --- a/src/libraries/System.Formats.Cbor/src/System/Formats/Cbor/Reader/CborReader.Integer.cs +++ b/src/libraries/System.Formats.Cbor/src/System/Formats/Cbor/Reader/CborReader.Integer.cs @@ -82,7 +82,7 @@ public ulong ReadUInt64() /// Reads the next data item as a CBOR negative integer representation (major type 1). /// An unsigned integer denoting -1 minus the integer. /// The next data item does not have the correct major type. - /// The encoded integer is out of range for + /// The encoded integer is out of range for . /// The next value has an invalid CBOR encoding. /// -or- /// There was an unexpected end of CBOR encoding data. diff --git a/src/libraries/System.Numerics.Tensors/src/System/NIndex.cs b/src/libraries/System.Numerics.Tensors/src/System/NIndex.cs index f3d068ef119ce0..e2d2cfef635187 100644 --- a/src/libraries/System.Numerics.Tensors/src/System/NIndex.cs +++ b/src/libraries/System.Numerics.Tensors/src/System/NIndex.cs @@ -115,7 +115,7 @@ public nint Value } } - /// Indicates whether the is from the start or the end. + /// Gets a value that indicates whether the is from the start or the end. public bool IsFromEnd => _value < 0; /// Calculates the offset from the start using the given collection length. diff --git a/src/libraries/System.Numerics.Tensors/src/System/NRange.cs b/src/libraries/System.Numerics.Tensors/src/System/NRange.cs index 9321c53f9ad964..43e0ff9c565017 100644 --- a/src/libraries/System.Numerics.Tensors/src/System/NRange.cs +++ b/src/libraries/System.Numerics.Tensors/src/System/NRange.cs @@ -18,10 +18,10 @@ namespace System.Buffers [Experimental(Experimentals.TensorTDiagId, UrlFormat = Experimentals.SharedUrlFormat)] public readonly struct NRange : IEquatable { - /// Represents the inclusive start NIndex of the NRange. + /// Gets the inclusive start NIndex of the NRange. public NIndex Start { get; } - /// Represents the exclusive end NIndex of the NRange. + /// Gets the exclusive end NIndex of the NRange. public NIndex End { get; } /// Constructs an object using the start and end .