diff --git a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IMetricsBuilder.cs b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IMetricsBuilder.cs index 76e0d8dd451b2..8dd59becef271 100644 --- a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IMetricsBuilder.cs +++ b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IMetricsBuilder.cs @@ -6,13 +6,13 @@ namespace Microsoft.Extensions.Diagnostics.Metrics { /// - /// Represents a type used to configure the metrics system by registering IMetricsListeners and using rules + /// Configures the metrics system by registering IMetricsListeners and using rules /// to determine which metrics are enabled. /// public interface IMetricsBuilder { /// - /// The application . This is used by extension methods to register services. + /// Gets the application service collection that's used by extension methods to register services. /// IServiceCollection Services { get; } } diff --git a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IMetricsListener.cs b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IMetricsListener.cs index e4c7fa173576e..1be3350b8f099 100644 --- a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IMetricsListener.cs +++ b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IMetricsListener.cs @@ -6,12 +6,12 @@ namespace Microsoft.Extensions.Diagnostics.Metrics { /// - /// Represents a type used to listen to metrics emitted from the system. + /// Listens to metrics emitted from the system. /// public interface IMetricsListener { /// - /// The name of the listener. This is used to identify the listener in the rules configuration. + /// Gets the name of the listener. This is used to identify the listener in the rules configuration. /// public string Name { get; } @@ -27,7 +27,7 @@ public interface IMetricsListener /// The new . /// Listener state associated with this instrument. This will be returned to /// and . - /// Returns true if the listener wants to subscribe to this instrument, otherwise false. + /// if the listener wants to subscribe to this instrument, otherwise . public bool InstrumentPublished(Instrument instrument, out object? userState); /// diff --git a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IObservableInstrumentsSource.cs b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IObservableInstrumentsSource.cs index 29657c5b06933..31a6c31aaa144 100644 --- a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IObservableInstrumentsSource.cs +++ b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/IObservableInstrumentsSource.cs @@ -6,13 +6,15 @@ namespace Microsoft.Extensions.Diagnostics.Metrics { /// - /// An interface registered with each IMetricsListener using . The listener - /// can call to receive the current set of measurements for enabled observable instruments. + /// An interface registered with each IMetricsListener using . /// + /// + /// The listener can call to receive the current set of measurements for enabled observable instruments. + /// public interface IObservableInstrumentsSource { /// - /// Requests that the current set of metrics for enabled instruments be sent to the listener's 's. + /// Requests that the current set of metrics for enabled instruments be sent to the listener's objects. /// public void RecordObservableInstruments(); } diff --git a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/InstrumentRule.cs b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/InstrumentRule.cs index b4346af9076e5..d5ba7ad62ecc0 100644 --- a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/InstrumentRule.cs +++ b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/InstrumentRule.cs @@ -20,32 +20,41 @@ namespace Microsoft.Extensions.Diagnostics.Metrics /// The Meter.Name or prefix. /// The Instrument.Name. /// The IMetricsListener.Name. - /// The 's to consider. - /// Enables or disabled the matched instrument for this listener. + /// A bitwise combination of the enumeration values that specifies the scopes to consider. + /// to enable the matched instrument for this listener; otherwise, . public class InstrumentRule(string? meterName, string? instrumentName, string? listenerName, MeterScope scopes, bool enable) { /// /// Gets the Meter.Name, either an exact match or the longest prefix match. Only full segment matches are considered. - /// All meters are matched if this is . /// + /// + /// The meter name. If , all meters are matched. + /// public string? MeterName { get; } = meterName; /// /// Gets the Instrument.Name, an exact match. - /// All instruments for the given meter are matched if this is . /// + /// + /// The instrument name. If , all instruments for the meter are matched. + /// public string? InstrumentName { get; } = instrumentName; /// /// Gets the IMetricsListener.Name, an exact match. - /// All listeners are matched if this is . /// + /// + /// The listener name. If , all listeners are matched. + /// public string? ListenerName { get; } = listenerName; /// - /// Gets the . This is used to distinguish between meters created via constructors () - /// and those created via Dependency Injection with ()."/>. + /// Gets the . /// + /// + /// This property is used to distinguish between meters created via constructors () + /// and those created via Dependency Injection with (). + /// public MeterScope Scopes { get; } = scopes == MeterScope.None ? throw new ArgumentOutOfRangeException(nameof(scopes), scopes, "The MeterScope must be Global, Local, or both.") : scopes; diff --git a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MeasurementHandlers.cs b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MeasurementHandlers.cs index 027c8e1e639de..5287a3588b536 100644 --- a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MeasurementHandlers.cs +++ b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MeasurementHandlers.cs @@ -6,42 +6,42 @@ namespace Microsoft.Extensions.Diagnostics.Metrics { /// - /// A set of supported measurement types. If a listener does not support a given type, the measurement will be skipped. + /// Represents a set of supported measurement types. If a listener does not support a given type, the measurement is skipped. /// public class MeasurementHandlers { /// - /// A for . If null, byte measurements will be skipped. + /// Gets or sets a for . If , byte measurements are skipped. /// public MeasurementCallback? ByteHandler { get; set; } /// - /// A for . If null, short measurements will be skipped. + /// Gets or sets a for . If , short measurements are skipped. /// public MeasurementCallback? ShortHandler { get; set; } /// - /// A for . If null, int measurements will be skipped. + /// Gets or sets a for . If , int measurements are skipped. /// public MeasurementCallback? IntHandler { get; set; } /// - /// A for . If null, long measurements will be skipped. + /// Gets or sets a for . If , long measurements are skipped. /// public MeasurementCallback? LongHandler { get; set; } /// - /// A for . If null, float measurements will be skipped. + /// Gets or sets a for . If , float measurements are skipped. /// public MeasurementCallback? FloatHandler { get; set; } /// - /// A for . If null, double measurements will be skipped. + /// Gets or sets a for . If , double measurements are skipped. /// public MeasurementCallback? DoubleHandler { get; set; } /// - /// A for . If null, decimal measurements will be skipped. + /// Gets or sets a for . If , decimal measurements are skipped. /// public MeasurementCallback? DecimalHandler { get; set; } } diff --git a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MeterScope.cs b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MeterScope.cs index a117c7b4371f9..3c87bbc78cb7d 100644 --- a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MeterScope.cs +++ b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MeterScope.cs @@ -7,14 +7,14 @@ namespace Microsoft.Extensions.Diagnostics.Metrics { /// - /// This is used by to distinguish between meters created via constructors () - /// and those created via Dependency Injection with ()."/>. + /// Represents scopes used by to distinguish between meters created via constructors () + /// and those created via Dependency Injection with (). /// [Flags] public enum MeterScope { /// - /// No scope is specified. This should not be used. + /// No scope is specified. This field should not be used. /// None = 0, diff --git a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MetricsBuilderExtensions.Rules.cs b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MetricsBuilderExtensions.Rules.cs index 5951340633707..2bfc6c4301f87 100644 --- a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MetricsBuilderExtensions.Rules.cs +++ b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MetricsBuilderExtensions.Rules.cs @@ -13,7 +13,7 @@ namespace Microsoft.Extensions.Diagnostics.Metrics public static partial class MetricsBuilderExtensions { /// - /// Enables all 's for the given meter, for all registered 's. + /// Enables all instruments for the given meter, for all registered listeners. /// /// The . /// The or prefix. A null value matches all meters. @@ -28,14 +28,14 @@ public static IMetricsBuilder EnableMetrics(this IMetricsBuilder builder, string /// The or prefix. A null value matches all meters. /// The . A null value matches all instruments. /// The .Name. A null value matches all listeners. - /// Indicates which 's to consider. Default to all scopes. + /// Indicates which meter scopes to consider. Defaults to all scopes. /// The original for chaining. public static IMetricsBuilder EnableMetrics(this IMetricsBuilder builder, string? meterName, string? instrumentName = null, string? listenerName = null, MeterScope scopes = MeterScope.Global | MeterScope.Local) => builder.ConfigureRule(options => options.EnableMetrics(meterName, instrumentName, listenerName, scopes)); /// - /// Enables all 's for the given meter, for all registered 's. + /// Enables all instruments for the given meter, for all registered listeners. /// /// The . /// The or prefix. A null value matches all meters. @@ -50,14 +50,14 @@ public static MetricsOptions EnableMetrics(this MetricsOptions options, string? /// The or prefix. A null value matches all meters. /// The . A null value matches all instruments. /// The .Name. A null value matches all listeners. - /// Indicates which 's to consider. Default to all scopes. + /// Indicates which meter scopes to consider. Default to all scopes. /// The original for chaining. public static MetricsOptions EnableMetrics(this MetricsOptions options, string? meterName, string? instrumentName = null, string? listenerName = null, MeterScope scopes = MeterScope.Global | MeterScope.Local) => options.AddRule(meterName, instrumentName, listenerName, scopes, enable: true); /// - /// Disables all 's for the given meter, for all registered 's. + /// Disables all instruments for the given meter, for all registered listeners. /// /// The . /// The or prefix. A null value matches all meters. @@ -72,14 +72,14 @@ public static IMetricsBuilder DisableMetrics(this IMetricsBuilder builder, strin /// The or prefix. A null value matches all meters. /// The . A null value matches all instruments. /// The .Name. A null value matches all listeners. - /// Indicates which 's to consider. Default to all scopes. + /// Indicates which meter scopes to consider. Defaults to all scopes. /// The original for chaining. public static IMetricsBuilder DisableMetrics(this IMetricsBuilder builder, string? meterName, string? instrumentName = null, string? listenerName = null, MeterScope scopes = MeterScope.Global | MeterScope.Local) => builder.ConfigureRule(options => options.DisableMetrics(meterName, instrumentName, listenerName, scopes)); /// - /// Disables all 's for the given meter, for all registered 's. + /// Disables all instruments for the given meter, for all registered listeners. /// /// The . /// The or prefix. A null value matches all meters. @@ -94,7 +94,7 @@ public static MetricsOptions DisableMetrics(this MetricsOptions options, string? /// The or prefix. A null value matches all meters. /// The . A null value matches all instruments. /// The .Name. A null value matches all listeners. - /// Indicates which 's to consider. Default to all scopes. + /// Indicates which meter scopes to consider. Defaults to all scopes. /// The original for chaining. public static MetricsOptions DisableMetrics(this MetricsOptions options, string? meterName, string? instrumentName = null, string? listenerName = null, MeterScope scopes = MeterScope.Global | MeterScope.Local) diff --git a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MetricsOptions.cs b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MetricsOptions.cs index 1dfbe1f57f148..3408f61a1b442 100644 --- a/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MetricsOptions.cs +++ b/src/libraries/Microsoft.Extensions.Diagnostics.Abstractions/src/Metrics/MetricsOptions.cs @@ -6,12 +6,12 @@ namespace Microsoft.Extensions.Diagnostics.Metrics { /// - /// Options for configuring the metrics system. + /// Represents options for configuring the metrics system. /// public class MetricsOptions { /// - /// A list of 's that identify which metrics, instruments, and listeners are enabled. + /// Gets a list of instrument rules that identifies which metrics, instruments, and listeners are enabled. /// public IList Rules { get; } = new List(); } diff --git a/src/libraries/Microsoft.Extensions.Diagnostics/src/Metrics/Configuration/MetricsBuilderConfigurationExtensions.cs b/src/libraries/Microsoft.Extensions.Diagnostics/src/Metrics/Configuration/MetricsBuilderConfigurationExtensions.cs index 9061c2461fb81..d70a0f9c03a9e 100644 --- a/src/libraries/Microsoft.Extensions.Diagnostics/src/Metrics/Configuration/MetricsBuilderConfigurationExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Diagnostics/src/Metrics/Configuration/MetricsBuilderConfigurationExtensions.cs @@ -17,7 +17,7 @@ public static class MetricsBuilderConfigurationExtensions { /// /// Reads metrics configuration from the provided section and configures - /// which 's, 's, and 's are enabled. + /// which Meters, Instruments, and IMetricsListeners are enabled. /// /// The . /// The section to load. diff --git a/src/libraries/Microsoft.Extensions.Diagnostics/src/Metrics/ConsoleMetrics.cs b/src/libraries/Microsoft.Extensions.Diagnostics/src/Metrics/ConsoleMetrics.cs index 4a2136677b21b..3336f31414d33 100644 --- a/src/libraries/Microsoft.Extensions.Diagnostics/src/Metrics/ConsoleMetrics.cs +++ b/src/libraries/Microsoft.Extensions.Diagnostics/src/Metrics/ConsoleMetrics.cs @@ -4,12 +4,12 @@ namespace Microsoft.Extensions.Diagnostics.Metrics { /// - /// Constants for the Console metrics listener. + /// Provides constants for the Console metrics listener. /// public static class ConsoleMetrics { /// - /// The name of the listener used in configuration and enabling instruments. + /// Gets the name of the listener used in configuration and enabling instruments. /// public static string DebugListenerName => "DebugConsole"; } diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/IFileInfo.cs b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/IFileInfo.cs index 08b364ca2d8a4..04fd3d075056c 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/IFileInfo.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/IFileInfo.cs @@ -12,39 +12,40 @@ namespace Microsoft.Extensions.FileProviders public interface IFileInfo { /// - /// True if resource exists in the underlying storage system. + /// Gets a value that indicates if the resource exists in the underlying storage system. /// bool Exists { get; } /// - /// The length of the file in bytes, or -1 for a directory or non-existing files. + /// Gets the length of the file in bytes, or -1 for a directory or nonexistent file. /// long Length { get; } /// - /// The path to the file, including the file name. Return null if the file is not directly accessible. + /// Gets the path to the file, including the file name. Returns if the file is not directly accessible. /// string? PhysicalPath { get; } /// - /// The name of the file or directory, not including any path. + /// Gets the name of the file or directory, not including any path. /// string Name { get; } /// - /// When the file was last modified + /// Gets the time when the file was last modified. /// DateTimeOffset LastModified { get; } /// - /// True for the case TryGetDirectoryContents has enumerated a sub-directory + /// Gets a value that indicates whether TryGetDirectoryContents has enumerated a subdirectory. /// bool IsDirectory { get; } /// - /// Return file contents as readonly stream. Caller should dispose stream when complete. + /// Returns file contents as a read-only stream. /// - /// The file stream + /// The file stream. + /// The caller should dispose the stream when complete. Stream CreateReadStream(); } } diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/IFileProvider.cs b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/IFileProvider.cs index bce6d2d81f65e..6f426b93412be 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/IFileProvider.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/IFileProvider.cs @@ -20,8 +20,8 @@ public interface IFileProvider /// /// Enumerate a directory at the given path, if any. /// - /// Relative path that identifies the directory. - /// Returns the contents of the directory. + /// The relative path that identifies the directory. + /// The contents of the directory. IDirectoryContents GetDirectoryContents(string subpath); /// diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundDirectoryContents.cs b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundDirectoryContents.cs index d9240fa8c740b..8b3110dd401dd 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundDirectoryContents.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundDirectoryContents.cs @@ -8,17 +8,17 @@ namespace Microsoft.Extensions.FileProviders { /// - /// Represents a non-existing directory + /// Represents a nonexistent directory. /// public class NotFoundDirectoryContents : IDirectoryContents { /// - /// A shared instance of + /// Gets a shared instance of . /// public static NotFoundDirectoryContents Singleton { get; } = new(); /// - /// Always false. + /// Gets a value that's always . /// public bool Exists => false; diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundFileInfo.cs b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundFileInfo.cs index 13707bae3339c..74cff98b1b14e 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundFileInfo.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundFileInfo.cs @@ -8,36 +8,36 @@ namespace Microsoft.Extensions.FileProviders { /// - /// Represents a non-existing file. + /// Represents a nonexistent file. /// public class NotFoundFileInfo : IFileInfo { /// /// Initializes an instance of . /// - /// The name of the file that could not be found + /// The name of the file that could not be found. public NotFoundFileInfo(string name) { Name = name; } /// - /// Always false. + /// Gets a value that's always . /// public bool Exists => false; /// - /// Always false. + /// Gets a value that's always . /// public bool IsDirectory => false; /// - /// Returns . + /// Gets . /// public DateTimeOffset LastModified => DateTimeOffset.MinValue; /// - /// Always equals -1. + /// Gets a value that's always -1. /// public long Length => -1; @@ -45,15 +45,15 @@ public NotFoundFileInfo(string name) public string Name { get; } /// - /// Always null. + /// Gets a value that's always . /// public string? PhysicalPath => null; /// - /// Always throws. A stream cannot be created for non-existing file. + /// Always throws. A stream cannot be created for a nonexistent file. /// - /// Always thrown. - /// Does not return + /// In all cases. + /// Does not return. [DoesNotReturn] public Stream CreateReadStream() { diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullChangeToken.cs b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullChangeToken.cs index b35546f207486..17812a299490e 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullChangeToken.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullChangeToken.cs @@ -12,7 +12,7 @@ namespace Microsoft.Extensions.FileProviders public class NullChangeToken : IChangeToken { /// - /// A singleton instance of + /// Gets a singleton instance of . /// public static NullChangeToken Singleton { get; } = new NullChangeToken(); @@ -21,21 +21,21 @@ private NullChangeToken() } /// - /// Always false. + /// Gets a value that's always . /// public bool HasChanged => false; /// - /// Always false. + /// Gets a value that's always . /// public bool ActiveChangeCallbacks => false; /// /// Always returns an empty disposable object. Callbacks will never be called. /// - /// This parameter is ignored - /// This parameter is ignored - /// A disposable object that noops on dispose. + /// This parameter is ignored. + /// This parameter is ignored. + /// A disposable object that no-ops on dispose. public IDisposable RegisterChangeCallback(Action callback, object? state) { return EmptyDisposable.Instance; diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullFileProvider.cs b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullFileProvider.cs index 17c87efff85ea..210ba67a140aa 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullFileProvider.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullFileProvider.cs @@ -11,17 +11,17 @@ namespace Microsoft.Extensions.FileProviders public class NullFileProvider : IFileProvider { /// - /// Enumerate a non-existent directory. + /// Enumerates a nonexistent directory. /// /// A path under the root directory. This parameter is ignored. /// A that does not exist and does not contain any contents. public IDirectoryContents GetDirectoryContents(string subpath) => NotFoundDirectoryContents.Singleton; /// - /// Locate a non-existent file. + /// Locates a nonexistent file. /// /// A path under the root directory. - /// A representing a non-existent file at the given path. + /// A representing a nonexistent file at the given path. public IFileInfo GetFileInfo(string subpath) => new NotFoundFileInfo(subpath); /// diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeDirectoryContents.cs b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeDirectoryContents.cs index 5fb6d9c25527f..27be2c7c94e1c 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeDirectoryContents.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeDirectoryContents.cs @@ -79,7 +79,7 @@ private void EnsureFilesAreInitialized() /// Creates an enumerator for all files in all providers given. /// Ensures each item in the collection is distinct. /// - /// An enumerator over all files in all given providers + /// An enumerator over all files in all given providers. public IEnumerator GetEnumerator() { EnsureFilesAreInitialized(); @@ -93,7 +93,7 @@ IEnumerator IEnumerable.GetEnumerator() } /// - /// True if any given providers exists + /// Gets a value that indicates if any given providers exist. /// public bool Exists { diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeFileProvider.cs b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeFileProvider.cs index 1343ab4bbe45f..f564d583ca6b3 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeFileProvider.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeFileProvider.cs @@ -39,8 +39,8 @@ public CompositeFileProvider(IEnumerable fileProviders) /// /// Locates a file at the given path. /// - /// The path that identifies the file. - /// The file information. Caller must check Exists property. This will be the first existing returned by the provided or a not found if no existing files is found. + /// The path that identifies the file. + /// The file information. The caller must check the property. This is the first existing returned by the provided or a not found if no existing files are found. public IFileInfo GetFileInfo(string subpath) { foreach (IFileProvider fileProvider in _fileProviders) diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/Internal/PhysicalDirectoryContents.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/Internal/PhysicalDirectoryContents.cs index 309002378237b..32c2540e1378c 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/Internal/PhysicalDirectoryContents.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/Internal/PhysicalDirectoryContents.cs @@ -10,24 +10,24 @@ namespace Microsoft.Extensions.FileProviders.Internal { /// - /// Represents the contents of a physical file directory + /// Represents the contents of a physical file directory. /// public class PhysicalDirectoryContents : IDirectoryContents { private readonly PhysicalDirectoryInfo _info; /// - /// Initializes an instance of + /// Initializes an instance of . /// - /// The directory + /// The directory to represent. public PhysicalDirectoryContents(string directory) : this(directory, ExclusionFilters.Sensitive) { } /// - /// Initializes an instance of + /// Initializes an instance of . /// - /// The directory + /// The directory to represent. /// Specifies which files or directories are excluded from enumeration. public PhysicalDirectoryContents(string directory, ExclusionFilters filters) { diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalDirectoryInfo.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalDirectoryInfo.cs index d1b9e1c08e2fe..ec1404564527f 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalDirectoryInfo.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalDirectoryInfo.cs @@ -11,7 +11,7 @@ namespace Microsoft.Extensions.FileProviders.Physical { /// - /// Represents a directory on a physical filesystem + /// Represents a directory on a physical file system. /// public class PhysicalDirectoryInfo : IFileInfo, IDirectoryContents { @@ -20,9 +20,9 @@ public class PhysicalDirectoryInfo : IFileInfo, IDirectoryContents private readonly ExclusionFilters _filters; /// - /// Initializes an instance of that wraps an instance of + /// Initializes an instance of that wraps an instance of . /// - /// The directory + /// The directory to represent. public PhysicalDirectoryInfo(DirectoryInfo info) { _info = info; @@ -38,7 +38,7 @@ internal PhysicalDirectoryInfo(DirectoryInfo info, ExclusionFilters filters) public bool Exists => _info.Exists; /// - /// Always equals -1. + /// Gets a value that's always -1. /// public long Length => -1; @@ -49,20 +49,20 @@ internal PhysicalDirectoryInfo(DirectoryInfo info, ExclusionFilters filters) public string Name => _info.Name; /// - /// The time when the directory was last written to. + /// Gets the time when the directory was last written to. /// public DateTimeOffset LastModified => _info.LastWriteTimeUtc; /// - /// Always true. + /// Gets a value that's always . /// public bool IsDirectory => true; /// /// Always throws an exception because read streams are not support on directories. /// - /// Always thrown - /// Never returns + /// In all cases. + /// Never returns. public Stream CreateReadStream() { throw new InvalidOperationException(SR.CannotCreateStream); diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileInfo.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileInfo.cs index 26ff178dc5338..ea70848d06fb3 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileInfo.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileInfo.cs @@ -7,16 +7,16 @@ namespace Microsoft.Extensions.FileProviders.Physical { /// - /// Represents a file on a physical filesystem + /// Represents a file on a physical file system. /// public class PhysicalFileInfo : IFileInfo { private readonly FileInfo _info; /// - /// Initializes an instance of that wraps an instance of + /// Initializes an instance of that wraps an instance of . /// - /// The + /// The . public PhysicalFileInfo(FileInfo info) { _info = info; @@ -38,7 +38,7 @@ public PhysicalFileInfo(FileInfo info) public DateTimeOffset LastModified => _info.LastWriteTimeUtc; /// - /// Always false. + /// Gets a value that's always . /// public bool IsDirectory => false; diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs index 925df9892752b..0357715d31d23 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs @@ -14,7 +14,7 @@ namespace Microsoft.Extensions.FileProviders { /// - /// Looks up files using the on-disk file system + /// Looks up files using the on-disk file system. /// /// /// When the environment variable "DOTNET_USE_POLLING_FILE_WATCHER" is set to "1" or "true", calls to @@ -73,17 +73,17 @@ public PhysicalFileProvider(string root, ExclusionFilters filters) /// /// Gets or sets a value that determines if this instance of /// uses polling to determine file changes. - /// - /// By default, uses to listen to file change events - /// for . is ineffective in some scenarios such as mounted drives. - /// Polling is required to effectively watch for file changes. - /// - /// . /// /// /// The default value of this property is determined by the value of environment variable named DOTNET_USE_POLLING_FILE_WATCHER. - /// When true or 1, this property defaults to true; otherwise false. + /// When or 1, this property defaults to ; otherwise . /// + /// + /// By default, uses to listen to file change events + /// for . is ineffective in some scenarios such as mounted drives. + /// Polling is required to effectively watch for file changes. + /// + /// public bool UsePollingFileWatcher { get @@ -111,18 +111,18 @@ public bool UsePollingFileWatcher /// /// Gets or sets a value that determines if this instance of /// actively polls for file changes. - /// - /// When , returned by will actively poll for file changes - /// ( will be ) instead of being passive. - /// - /// - /// This property is only effective when is set. - /// /// /// + /// if the returned by actively polls for file changes + /// ( will be ) instead of being passive. /// The default value of this property is determined by the value of environment variable named DOTNET_USE_POLLING_FILE_WATCHER. - /// When true or 1, this property defaults to true; otherwise false. + /// When or 1, this property defaults to ; otherwise . /// + /// + /// + /// This property is only effective when is set. + /// + /// public bool UseActivePolling { get @@ -221,7 +221,7 @@ protected virtual void Dispose(bool disposing) } /// - /// The root directory for this instance. + /// Gets the root directory for this instance. /// public string Root { get; } @@ -256,10 +256,10 @@ private bool IsUnderneathRoot(string fullPath) } /// - /// Locate a file at the given path by directly mapping path segments to physical directories. + /// Locates a file at the given path by directly mapping path segments to physical directories. /// - /// A path under the root directory - /// The file information. Caller must check property. + /// A path under the root directory. + /// The file information. Caller must check the property. public IFileInfo GetFileInfo(string subpath) { if (string.IsNullOrEmpty(subpath) || PathUtils.HasInvalidPathChars(subpath)) @@ -292,14 +292,17 @@ public IFileInfo GetFileInfo(string subpath) } /// - /// Enumerate a directory at the given path, if any. + /// Enumerates a directory at the given path, if any. /// /// A path under the root directory. Leading slashes are ignored. /// - /// Contents of the directory. Caller must check property. if - /// is absolute, if the directory does not exist, or has invalid - /// characters. + /// The contents of the directory. /// + /// + /// The caller must check the property. + /// Returns if is absolute, + /// if the directory does not exist, or has invalid characters. + /// public IDirectoryContents GetDirectoryContents(string subpath) { try @@ -345,7 +348,7 @@ public IDirectoryContents GetDirectoryContents(string subpath) /// /// /// An that is notified when a file matching is added, - /// modified or deleted. Returns a if has invalid filter + /// modified, or deleted. Returns a if has invalid filter /// characters or if is an absolute path or outside the root directory specified in the /// constructor . /// diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs index 712a83a3ef2c6..e63610497abb1 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs @@ -17,12 +17,8 @@ namespace Microsoft.Extensions.FileProviders.Physical { /// - /// - /// A file watcher that watches a physical filesystem for changes. - /// - /// - /// Triggers events on when files are created, change, renamed, or deleted. - /// + /// Watches a physical file system for changes and triggers events on + /// when files are created, change, renamed, or deleted. /// public class PhysicalFilesWatcher : IDisposable { @@ -46,13 +42,13 @@ public class PhysicalFilesWatcher : IDisposable /// /// Initializes an instance of that watches files in . - /// Wraps an instance of + /// Wraps an instance of . /// - /// Root directory for the watcher - /// The wrapped watcher that is watching + /// Root directory for the watcher. + /// The wrapped watcher that's watching . /// - /// True when the watcher should use polling to trigger instances of - /// created by + /// for the poller to use polling to trigger instances of + /// created by . /// public PhysicalFilesWatcher( string root, @@ -64,13 +60,13 @@ public PhysicalFilesWatcher( /// /// Initializes an instance of that watches files in . - /// Wraps an instance of + /// Wraps an instance of . /// - /// Root directory for the watcher - /// The wrapped watcher that is watching + /// Root directory for the watcher. + /// The wrapped watcher that is watching . /// - /// True when the watcher should use polling to trigger instances of - /// created by + /// for the poller to use polling to trigger instances of + /// created by . /// /// Specifies which files or directories are excluded. Notifications of changes to are not raised to these. public PhysicalFilesWatcher( @@ -118,19 +114,17 @@ public PhysicalFilesWatcher( internal ConcurrentDictionary PollingChangeTokens { get; } /// - /// - /// Creates an instance of for all files and directories that match the - /// - /// - /// - /// Globbing patterns are relative to the root directory given in the constructor - /// . Globbing patterns - /// are interpreted by . - /// + /// Creates an instance of for all files and directories that match the + /// . /// - /// A globbing pattern for files and directories to watch - /// A change token for all files that match the filter - /// When is null + /// A globbing pattern for files and directories to watch. + /// A change token for all files that match the filter. + /// + /// Globbing patterns are relative to the root directory given in the constructor + /// . Globbing patterns + /// are interpreted by . + /// + /// is . public IChangeToken CreateFileChangeToken(string filter) { ThrowHelper.ThrowIfNull(filter); diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.cs index eb5484dde258b..0d6d020f4952f 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.cs @@ -11,17 +11,12 @@ namespace Microsoft.Extensions.FileProviders.Physical { /// - /// - /// A change token that polls for file system changes. - /// - /// - /// This change token does not raise any change callbacks. Callers should watch for to turn - /// from false to true - /// and dispose the token after this happens. - /// + /// A change token that polls for file system changes. /// /// - /// Polling occurs every 4 seconds. + /// Polling occurs every 4 seconds. + /// This change token does not raise any change callbacks. Callers should watch for to turn + /// from to and dispose the token after this happens. /// public class PollingFileChangeToken : IPollingChangeToken { @@ -36,7 +31,7 @@ public class PollingFileChangeToken : IPollingChangeToken /// Initializes a new instance of that polls the specified file for changes as /// determined by . /// - /// The to poll + /// The to poll. public PollingFileChangeToken(FileInfo fileInfo) { _fileInfo = fileInfo; @@ -59,7 +54,7 @@ private DateTime GetLastWriteTimeUtc() } /// - /// Always false. + /// Gets a value that's always . /// public bool ActiveChangeCallbacks { get; internal set; } @@ -79,10 +74,10 @@ internal CancellationTokenSource? CancellationTokenSource CancellationTokenSource? IPollingChangeToken.CancellationTokenSource => CancellationTokenSource; /// - /// True when the file has changed since the change token was created. Once the file changes, this value is always true + /// Gets a value that indicates whether the file has changed since the change token was created. /// /// - /// Once true, the value will always be true. Change tokens should not re-used once expired. The caller should discard this + /// Once the file changes, this value is always . Change tokens should not reused once expired. The caller should discard this /// instance once it sees is true. /// public bool HasChanged @@ -115,9 +110,9 @@ public bool HasChanged /// /// Does not actually register callbacks. /// - /// This parameter is ignored - /// This parameter is ignored - /// A disposable object that noops when disposed + /// This parameter is ignored. + /// This parameter is ignored. + /// A disposable object that no-ops when disposed. public IDisposable RegisterChangeCallback(Action callback, object? state) { if (!ActiveChangeCallbacks) diff --git a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostEnvironmentEnvExtensions.cs b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostEnvironmentEnvExtensions.cs index 34c66f90937c8..c891d8e64ca51 100644 --- a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostEnvironmentEnvExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostEnvironmentEnvExtensions.cs @@ -14,7 +14,7 @@ public static class HostEnvironmentEnvExtensions /// Checks if the current host environment name is . /// /// An instance of . - /// True if the environment name is , otherwise false. + /// if the environment name is , otherwise . public static bool IsDevelopment(this IHostEnvironment hostEnvironment) { ThrowHelper.ThrowIfNull(hostEnvironment); @@ -26,7 +26,7 @@ public static bool IsDevelopment(this IHostEnvironment hostEnvironment) /// Checks if the current host environment name is . /// /// An instance of . - /// True if the environment name is , otherwise false. + /// if the environment name is , otherwise . public static bool IsStaging(this IHostEnvironment hostEnvironment) { ThrowHelper.ThrowIfNull(hostEnvironment); @@ -38,7 +38,7 @@ public static bool IsStaging(this IHostEnvironment hostEnvironment) /// Checks if the current host environment name is . /// /// An instance of . - /// True if the environment name is , otherwise false. + /// if the environment name is , otherwise . public static bool IsProduction(this IHostEnvironment hostEnvironment) { ThrowHelper.ThrowIfNull(hostEnvironment); @@ -51,7 +51,7 @@ public static bool IsProduction(this IHostEnvironment hostEnvironment) /// /// An instance of . /// Environment name to validate against. - /// True if the specified name is the same as the current environment, otherwise false. + /// if the specified name is the same as the current environment, otherwise . public static bool IsEnvironment( this IHostEnvironment hostEnvironment, string environmentName) diff --git a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostingAbstractionsHostExtensions.cs b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostingAbstractionsHostExtensions.cs index 7e2ed626aed19..f5ee438a2a74c 100644 --- a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostingAbstractionsHostExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostingAbstractionsHostExtensions.cs @@ -36,7 +36,7 @@ public static async Task StopAsync(this IHost host, TimeSpan timeout) } /// - /// Block the calling thread until shutdown is triggered via Ctrl+C or SIGTERM. + /// Blocks the calling thread until shutdown is triggered via Ctrl+C or SIGTERM. /// /// The running . public static void WaitForShutdown(this IHost host) @@ -45,7 +45,7 @@ public static void WaitForShutdown(this IHost host) } /// - /// Runs an application and block the calling thread until host shutdown. + /// Runs an application and blocks the calling thread until host shutdown is triggered and all instances are stopped. /// /// The to run. public static void Run(this IHost host) diff --git a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostingEnvironmentExtensions.cs b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostingEnvironmentExtensions.cs index 3f91b8faa960f..5e2a6cccef94d 100644 --- a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostingEnvironmentExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostingEnvironmentExtensions.cs @@ -15,7 +15,7 @@ public static class HostingEnvironmentExtensions /// Checks if the current hosting environment name is . /// /// An instance of . - /// True if the environment name is , otherwise false. + /// if the environment name is , otherwise . public static bool IsDevelopment(this IHostingEnvironment hostingEnvironment) { ThrowHelper.ThrowIfNull(hostingEnvironment); @@ -27,7 +27,7 @@ public static bool IsDevelopment(this IHostingEnvironment hostingEnvironment) /// Checks if the current hosting environment name is . /// /// An instance of . - /// True if the environment name is , otherwise false. + /// if the environment name is , otherwise . public static bool IsStaging(this IHostingEnvironment hostingEnvironment) { ThrowHelper.ThrowIfNull(hostingEnvironment); @@ -39,7 +39,7 @@ public static bool IsStaging(this IHostingEnvironment hostingEnvironment) /// Checks if the current hosting environment name is . /// /// An instance of . - /// True if the environment name is , otherwise false. + /// if the environment name is , otherwise . public static bool IsProduction(this IHostingEnvironment hostingEnvironment) { ThrowHelper.ThrowIfNull(hostingEnvironment); @@ -52,7 +52,7 @@ public static bool IsProduction(this IHostingEnvironment hostingEnvironment) /// /// An instance of . /// Environment name to validate against. - /// True if the specified name is the same as the current environment, otherwise false. + /// if the specified name is the same as the current environment, otherwise . public static bool IsEnvironment( this IHostingEnvironment hostingEnvironment, string environmentName) diff --git a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IApplicationLifetime.cs b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IApplicationLifetime.cs index 326feb0458bc0..cb3d037d39518 100644 --- a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IApplicationLifetime.cs +++ b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IApplicationLifetime.cs @@ -17,19 +17,19 @@ namespace Microsoft.Extensions.Hosting public interface IApplicationLifetime { /// - /// Triggered when the application host has fully started and is about to wait + /// Gets a cancellation token. Triggered when the application host has fully started and is about to wait /// for a graceful shutdown. /// CancellationToken ApplicationStarted { get; } /// - /// Triggered when the application host is performing a graceful shutdown. + /// Gets a cancellation token. Triggered when the application host is performing a graceful shutdown. /// Requests may still be in flight. Shutdown will block until this event completes. /// CancellationToken ApplicationStopping { get; } /// - /// Triggered when the application host is performing a graceful shutdown. + /// Gets a cancellation token. Triggered when the application host is performing a graceful shutdown. /// All requests should be complete at this point. Shutdown will block /// until this event completes. /// diff --git a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostApplicationBuilder.cs b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostApplicationBuilder.cs index df04bfec50b66..40214c3a64345 100644 --- a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostApplicationBuilder.cs +++ b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostApplicationBuilder.cs @@ -39,7 +39,7 @@ public interface IHostApplicationBuilder ILoggingBuilder Logging { get; } /// - /// Allows enabling metrics and directing their output. + /// Gets a builder that allows enabling metrics and directing their output. /// IMetricsBuilder Metrics { get; } diff --git a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostApplicationLifetime.cs b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostApplicationLifetime.cs index 0df79989ca49e..64951ac7a1ae3 100644 --- a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostApplicationLifetime.cs +++ b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostApplicationLifetime.cs @@ -11,18 +11,18 @@ namespace Microsoft.Extensions.Hosting public interface IHostApplicationLifetime { /// - /// Triggered when the application host has fully started. + /// Gets a cancellation token. Triggered when the application host has fully started. /// CancellationToken ApplicationStarted { get; } /// - /// Triggered when the application host is starting a graceful shutdown. + /// Gets a cancellation token. Triggered when the application host is starting a graceful shutdown. /// Shutdown will block until all callbacks registered on this token have completed. /// CancellationToken ApplicationStopping { get; } /// - /// Triggered when the application host has completed a graceful shutdown. + /// Gets a cancellation token. Triggered when the application host has completed a graceful shutdown. /// The application will not exit until all callbacks registered on this token have completed. /// CancellationToken ApplicationStopped { get; } diff --git a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostBuilder.cs b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostBuilder.cs index faf77e945ce39..4d3cd6016bcd8 100644 --- a/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostBuilder.cs +++ b/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostBuilder.cs @@ -14,12 +14,12 @@ namespace Microsoft.Extensions.Hosting public interface IHostBuilder { /// - /// A central location for sharing state between components during the host building process. + /// Gets a central location for sharing state between components during the host building process. /// IDictionary Properties { get; } /// - /// Set up the configuration for the builder itself. This will be used to initialize the + /// Sets up the configuration for the builder itself. This will be used to initialize the /// for use later in the build process. This can be called multiple times and the results will be additive. /// /// The delegate for configuring the that will be used @@ -71,7 +71,7 @@ public interface IHostBuilder IHostBuilder ConfigureContainer(Action configureDelegate); /// - /// Run the given actions to initialize the host. This can only be called once. + /// Runs the given actions to initialize the host. This can only be called once. /// /// An initialized . IHost Build(); diff --git a/src/libraries/Microsoft.Extensions.Hosting/src/ConsoleLifetimeOptions.cs b/src/libraries/Microsoft.Extensions.Hosting/src/ConsoleLifetimeOptions.cs index 90366bd82f199..db969a3057e03 100644 --- a/src/libraries/Microsoft.Extensions.Hosting/src/ConsoleLifetimeOptions.cs +++ b/src/libraries/Microsoft.Extensions.Hosting/src/ConsoleLifetimeOptions.cs @@ -9,9 +9,12 @@ namespace Microsoft.Extensions.Hosting public class ConsoleLifetimeOptions { /// - /// Indicates if host lifetime status messages should be suppressed such as on startup. - /// The default is false. + /// Gets or sets a value that indicates if host lifetime status messages should be suppressed, such as on startup. /// + /// + /// if host lifetime status messages should be suppressed. + /// The default is . + /// public bool SuppressStatusMessages { get; set; } } } diff --git a/src/libraries/Microsoft.Extensions.Hosting/src/HostApplicationBuilder.cs b/src/libraries/Microsoft.Extensions.Hosting/src/HostApplicationBuilder.cs index 95947c2d4b08d..a4bd55d4efb3a 100644 --- a/src/libraries/Microsoft.Extensions.Hosting/src/HostApplicationBuilder.cs +++ b/src/libraries/Microsoft.Extensions.Hosting/src/HostApplicationBuilder.cs @@ -15,7 +15,7 @@ namespace Microsoft.Extensions.Hosting { /// - /// Represents a hosted applications and services builder which helps manage configuration, logging, lifetime, and more. + /// Represents a hosted applications and services builder that helps manage configuration, logging, lifetime, and more. /// public sealed class HostApplicationBuilder : IHostApplicationBuilder { @@ -226,7 +226,7 @@ public void ConfigureContainer(IServiceProviderFactory - /// Build the host. This can only be called once. + /// Builds the host. This method can only be called once. /// /// An initialized . public IHost Build() diff --git a/src/libraries/Microsoft.Extensions.Hosting/src/HostApplicationBuilderSettings.cs b/src/libraries/Microsoft.Extensions.Hosting/src/HostApplicationBuilderSettings.cs index 77048a86b09ef..f093ed25ce5fa 100644 --- a/src/libraries/Microsoft.Extensions.Hosting/src/HostApplicationBuilderSettings.cs +++ b/src/libraries/Microsoft.Extensions.Hosting/src/HostApplicationBuilderSettings.cs @@ -20,9 +20,12 @@ public HostApplicationBuilderSettings() } /// - /// If , configures the instance with pre-configured defaults. - /// This has a similar effect to calling . + /// Gets or sets a value that indicates whether the instance is configured with pre-configured defaults. /// + /// + /// if the instance is configured with pre-configured defaults. + /// This has a similar effect to calling . + /// /// /// The following defaults are applied to the : /// * set the to the result of @@ -37,29 +40,29 @@ public HostApplicationBuilderSettings() public bool DisableDefaults { get; set; } /// - /// The command line arguments to add to the . + /// Gets or sets the command-line arguments to add to the . /// public string[]? Args { get; set; } /// - /// Initial configuration sources to be added to the . These sources can influence + /// Gets or sets the initial configuration sources to be added to the . These sources can influence /// the through the use of keys. Disposing the built /// disposes the . /// public ConfigurationManager? Configuration { get; set; } /// - /// The environment name. + /// Gets or sets the environment name. /// public string? EnvironmentName { get; set; } /// - /// The application name. + /// Gets or sets the application name. /// public string? ApplicationName { get; set; } /// - /// The content root path. + /// Gets or sets the content root path. /// public string? ContentRootPath { get; set; } } diff --git a/src/libraries/Microsoft.Extensions.Hosting/src/HostBuilder.cs b/src/libraries/Microsoft.Extensions.Hosting/src/HostBuilder.cs index e16461fffbf39..9fb7219ad4996 100644 --- a/src/libraries/Microsoft.Extensions.Hosting/src/HostBuilder.cs +++ b/src/libraries/Microsoft.Extensions.Hosting/src/HostBuilder.cs @@ -49,7 +49,7 @@ public HostBuilder() } /// - /// A central location for sharing state between components during the host building process. + /// Gets a central location for sharing state between components during the host building process. /// public IDictionary Properties { get; } = new Dictionary(); @@ -147,7 +147,7 @@ public IHostBuilder ConfigureContainer(Action /// Run the given actions to initialize the host. This can only be called once. /// - /// An initialized + /// An initialized . /// Adds basic services to the host such as application lifetime, host environment, and logging. public IHost Build() { diff --git a/src/libraries/Microsoft.Extensions.Hosting/src/HostOptions.cs b/src/libraries/Microsoft.Extensions.Hosting/src/HostOptions.cs index 92d27878a9415..eabdf6340dcc5 100644 --- a/src/libraries/Microsoft.Extensions.Hosting/src/HostOptions.cs +++ b/src/libraries/Microsoft.Extensions.Hosting/src/HostOptions.cs @@ -9,12 +9,12 @@ namespace Microsoft.Extensions.Hosting { /// - /// Options for + /// Options for . /// public class HostOptions { /// - /// The default timeout for . + /// Gets or sets the default timeout for . /// /// /// This timeout also encompasses all host services implementing @@ -24,7 +24,7 @@ public class HostOptions public TimeSpan ShutdownTimeout { get; set; } = TimeSpan.FromSeconds(30); /// - /// The default timeout for . + /// Gets or sets the default timeout for . /// /// /// This timeout also encompasses all host services implementing @@ -34,17 +34,23 @@ public class HostOptions public TimeSpan StartupTimeout { get; set; } = Timeout.InfiniteTimeSpan; /// - /// Determines if the will start registered instances of concurrently or sequentially. Defaults to false. + /// Gets or sets a value that indicates if the will start registered instances of concurrently or sequentially. /// + /// + /// if the will start registered instances of concurrently; if the will start registered instances sequentially. The default is . + /// public bool ServicesStartConcurrently { get; set; } /// - /// Determines if the will stop registered instances of concurrently or sequentially. Defaults to false. + /// Gets or sets a value that indicates if the will stop registered instances of concurrently or sequentially. /// + /// + /// if the will stop registered instances of concurrently; if the will stop registered instances sequentially. The default is . + /// public bool ServicesStopConcurrently { get; set; } /// - /// The behavior the will follow when any of + /// Gets or sets the behavior the will follow when any of /// its instances throw an unhandled exception. /// /// diff --git a/src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs b/src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs index 09274bad3a3cb..7948d41fd171b 100644 --- a/src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs @@ -25,7 +25,7 @@ namespace Microsoft.Extensions.Hosting public static class HostingHostBuilderExtensions { /// - /// Specify the environment to be used by the host. To avoid the environment being overwritten by a default + /// Specifies the environment to be used by the host. To avoid the environment being overwritten by a default /// value, ensure this is called after defaults are configured. /// /// The to configure. @@ -45,7 +45,7 @@ public static IHostBuilder UseEnvironment(this IHostBuilder hostBuilder, string } /// - /// Specify the content root directory to be used by the host. To avoid the content root directory being + /// Specifies the content root directory to be used by the host. To avoid the content root directory being /// overwritten by a default value, ensure this is called after defaults are configured. /// /// The to configure. @@ -65,7 +65,7 @@ public static IHostBuilder UseContentRoot(this IHostBuilder hostBuilder, string } /// - /// Specify the to be the default one. + /// Specifies the to be the default one. /// /// The to configure. /// The delegate that configures the . @@ -74,7 +74,7 @@ public static IHostBuilder UseDefaultServiceProvider(this IHostBuilder hostBuild => hostBuilder.UseDefaultServiceProvider((context, options) => configure(options)); /// - /// Specify the to be the default one. + /// Specifies the to be the default one. /// /// The to configure. /// The delegate that configures the . @@ -90,7 +90,7 @@ public static IHostBuilder UseDefaultServiceProvider(this IHostBuilder hostBuild } /// - /// Adds a delegate for configuring the provided . This may be called multiple times. + /// Adds a delegate for configuring the provided . This can be called multiple times. /// /// The to configure. /// The delegate that configures the . @@ -101,7 +101,7 @@ public static IHostBuilder ConfigureLogging(this IHostBuilder hostBuilder, Actio } /// - /// Adds a delegate for configuring the provided . This may be called multiple times. + /// Adds a delegate for configuring the provided . This can be called multiple times. /// /// The to configure. /// The delegate that configures the . @@ -399,7 +399,7 @@ public static Task RunConsoleAsync(this IHostBuilder hostBuilder, Action - /// Adds a delegate for configuring the provided . This may be called multiple times. + /// Adds a delegate for configuring the provided . This can be called multiple times. /// /// The to configure. /// The delegate that configures the . @@ -410,7 +410,7 @@ public static IHostBuilder ConfigureMetrics(this IHostBuilder hostBuilder, Actio } /// - /// Adds a delegate for configuring the provided . This may be called multiple times. + /// Adds a delegate for configuring the provided . This can be called multiple times. /// /// The to configure. /// The delegate that configures the . diff --git a/src/libraries/Microsoft.Extensions.Hosting/src/Internal/ApplicationLifetime.cs b/src/libraries/Microsoft.Extensions.Hosting/src/Internal/ApplicationLifetime.cs index 7d6fa3d95df15..023fa14c5fe58 100644 --- a/src/libraries/Microsoft.Extensions.Hosting/src/Internal/ApplicationLifetime.cs +++ b/src/libraries/Microsoft.Extensions.Hosting/src/Internal/ApplicationLifetime.cs @@ -33,19 +33,19 @@ public ApplicationLifetime(ILogger logger) } /// - /// Triggered when the application host has fully started and is about to wait + /// Gets a cancellation token. Triggered when the application host has fully started and is about to wait /// for a graceful shutdown. /// public CancellationToken ApplicationStarted => _startedSource.Token; /// - /// Triggered when the application host is performing a graceful shutdown. - /// Request may still be in flight. Shutdown will block until this event completes. + /// Gets a cancellation token. Triggered when the application host is performing a graceful shutdown. + /// Request might still be in flight. Shutdown will block until this event completes. /// public CancellationToken ApplicationStopping => _stoppingSource.Token; /// - /// Triggered when the application host is performing a graceful shutdown. + /// Gets a cancellation token. Triggered when the application host is performing a graceful shutdown. /// All requests should be complete at this point. Shutdown will block /// until this event completes. /// diff --git a/src/libraries/Microsoft.Extensions.Http/src/HttpClientFactoryOptions.cs b/src/libraries/Microsoft.Extensions.Http/src/HttpClientFactoryOptions.cs index c3254d9a64fe7..220ed0cf794e1 100644 --- a/src/libraries/Microsoft.Extensions.Http/src/HttpClientFactoryOptions.cs +++ b/src/libraries/Microsoft.Extensions.Http/src/HttpClientFactoryOptions.cs @@ -11,7 +11,7 @@ namespace Microsoft.Extensions.Http { /// - /// An options class for configuring the default . + /// Provides options for configuring the default . /// public class HttpClientFactoryOptions { @@ -71,7 +71,7 @@ public TimeSpan HandlerLifetime } /// - /// The which determines whether to redact the HTTP header value before logging. + /// Gets or sets the that determines whether to redact the HTTP header value before logging. /// public Func ShouldRedactHeaderValue { get; set; } = LogHelper.ShouldRedactHeaderValue; diff --git a/src/libraries/Microsoft.Extensions.Http/src/IHttpMessageHandlerBuilderFilter.cs b/src/libraries/Microsoft.Extensions.Http/src/IHttpMessageHandlerBuilderFilter.cs index f74be3712780b..bd699827cb5a5 100644 --- a/src/libraries/Microsoft.Extensions.Http/src/IHttpMessageHandlerBuilderFilter.cs +++ b/src/libraries/Microsoft.Extensions.Http/src/IHttpMessageHandlerBuilderFilter.cs @@ -15,7 +15,7 @@ public interface IHttpMessageHandlerBuilderFilter /// /// Applies additional initialization to the /// - /// A delegate which will run the next . + /// A delegate that will run the next . /// The configured . Action Configure(Action next); } diff --git a/src/libraries/Microsoft.Extensions.Http/src/Logging/IHttpClientAsyncLogger.cs b/src/libraries/Microsoft.Extensions.Http/src/Logging/IHttpClientAsyncLogger.cs index 2fef7b48d5769..307078a00754a 100644 --- a/src/libraries/Microsoft.Extensions.Http/src/Logging/IHttpClientAsyncLogger.cs +++ b/src/libraries/Microsoft.Extensions.Http/src/Logging/IHttpClientAsyncLogger.cs @@ -35,7 +35,7 @@ public interface IHttpClientAsyncLogger : IHttpClientLogger /// The HTTP request message that will be sent. /// The cancellation token to cancel operation. /// The task object representing the asynchronous operation. The result of the operation is a context object that will - /// be passed to a corresponding or . Can be `null` + /// be passed to a corresponding or . Can be /// if no context object is needed by the implementation. ValueTask LogRequestStartAsync(HttpRequestMessage request, CancellationToken cancellationToken = default); @@ -55,7 +55,7 @@ public interface IHttpClientAsyncLogger : IHttpClientLogger /// /// The context object that was previously returned by . /// The HTTP request message that was sent. - /// If available, the HTTP response message that was received, and `null` otherwise. + /// If available, the HTTP response message that was received, and otherwise. /// Exception that happened during processing the HTTP request. /// Time elapsed since calling . /// The cancellation token to cancel operation. diff --git a/src/libraries/Microsoft.Extensions.Http/src/Logging/IHttpClientLogger.cs b/src/libraries/Microsoft.Extensions.Http/src/Logging/IHttpClientLogger.cs index c26b88736aa03..e9c61ae312959 100644 --- a/src/libraries/Microsoft.Extensions.Http/src/Logging/IHttpClientLogger.cs +++ b/src/libraries/Microsoft.Extensions.Http/src/Logging/IHttpClientLogger.cs @@ -25,7 +25,7 @@ public interface IHttpClientLogger /// Logs before sending an HTTP request. /// /// The HTTP request message that will be sent. - /// A context object that will be passed to a corresponding or . Can be `null` + /// A context object that will be passed to a corresponding or . Can be /// if no context object is needed by the implementation. object? LogRequestStart(HttpRequestMessage request); @@ -43,7 +43,7 @@ public interface IHttpClientLogger /// /// The context object that was previously returned by . /// The HTTP request message that was sent. - /// If available, the HTTP response message that was received, and `null` otherwise. + /// If available, the HTTP response message that was received, and otherwise. /// Exception that happened during processing the HTTP request. /// Time elapsed since calling . void LogRequestFailed(object? context, HttpRequestMessage request, HttpResponseMessage? response, Exception exception, TimeSpan elapsed); diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/BufferedLogRecord.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/BufferedLogRecord.cs index 8f35ff97b35a6..e1396b6f6f069 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/BufferedLogRecord.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/BufferedLogRecord.cs @@ -11,7 +11,7 @@ namespace Microsoft.Extensions.Logging.Abstractions /// Represents a buffered log record to be written in batch to an . /// /// - /// Instances of this type may be pooled and reused. Implementations of must + /// Instances of this type can be pooled and reused. Implementations of must /// not hold onto instance of passed to its method /// beyond the invocation of that method. /// @@ -28,7 +28,7 @@ public abstract class BufferedLogRecord public abstract LogLevel LogLevel { get; } /// - /// Gets the record's event id. + /// Gets the record's event ID. /// public abstract EventId EventId { get; } diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/IExternalScopeProvider.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/IExternalScopeProvider.cs index 20855aa043c0a..f879b5dc07594 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/IExternalScopeProvider.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/IExternalScopeProvider.cs @@ -14,15 +14,15 @@ public interface IExternalScopeProvider /// Executes callback for each currently active scope objects in order of creation. /// All callbacks are guaranteed to be called inline from this method. /// - /// The callback to be executed for every scope object - /// The state object to be passed into the callback + /// The callback to be executed for every scope object. + /// The state object to be passed into the callback. /// The type of state to accept. void ForEachScope(Action callback, TState state); /// - /// Adds scope object to the list + /// Adds scope object to the list. /// - /// The scope object + /// The scope object. /// The token that removes scope on dispose. IDisposable Push(object? state); } diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/ILogger.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/ILogger.cs index 9c8370c834d3d..18012d3a60d60 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/ILogger.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/ILogger.cs @@ -26,7 +26,7 @@ public interface ILogger /// Checks if the given is enabled. /// /// Level to be checked. - /// true if enabled. + /// if enabled. bool IsEnabled(LogLevel logLevel); /// diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LogDefineOptions.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LogDefineOptions.cs index 48016fcd2b781..4208e1b70a9bf 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LogDefineOptions.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LogDefineOptions.cs @@ -6,7 +6,7 @@ namespace Microsoft.Extensions.Logging { /// - /// Options for and its overloads + /// Options for and its overloads. /// public class LogDefineOptions { diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LogEntry.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LogEntry.cs index 17f070cf02391..5ff8b6e12b8ee 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LogEntry.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LogEntry.cs @@ -30,32 +30,32 @@ public LogEntry(LogLevel logLevel, string category, EventId eventId, TState stat } /// - /// Gets the LogLevel + /// Gets the log level. /// public LogLevel LogLevel { get; } /// - /// Gets the log category + /// Gets the log category. /// public string Category { get; } /// - /// Gets the log EventId + /// Gets the log event ID. /// public EventId EventId { get; } /// - /// Gets the TState + /// Gets the state. /// public TState State { get; } /// - /// Gets the log exception + /// Gets the log exception. /// public Exception? Exception { get; } /// - /// Gets the formatter + /// Gets the formatter. /// public Func Formatter { get; } } diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerExtensions.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerExtensions.cs index 80e9bb35b778f..75a9b85536990 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerExtensions.cs @@ -20,9 +20,13 @@ public static class LoggerExtensions /// The to write to. /// The event id associated with the log. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogDebug(0, exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogDebug(0, exception, "Error while processing request from {Address}", address) + /// + /// public static void LogDebug(this ILogger logger, EventId eventId, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Debug, eventId, exception, message, args); @@ -33,9 +37,13 @@ public static void LogDebug(this ILogger logger, EventId eventId, Exception? exc /// /// The to write to. /// The event id associated with the log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogDebug(0, "Processing request from {Address}", address) + /// + /// + /// logger.LogDebug(0, "Processing request from {Address}", address) + /// + /// public static void LogDebug(this ILogger logger, EventId eventId, string? message, params object?[] args) { logger.Log(LogLevel.Debug, eventId, message, args); @@ -46,9 +54,13 @@ public static void LogDebug(this ILogger logger, EventId eventId, string? messag /// /// The to write to. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogDebug(exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogDebug(exception, "Error while processing request from {Address}", address) + /// + /// public static void LogDebug(this ILogger logger, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Debug, exception, message, args); @@ -58,9 +70,13 @@ public static void LogDebug(this ILogger logger, Exception? exception, string? m /// Formats and writes a debug log message. /// /// The to write to. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogDebug("Processing request from {Address}", address) + /// + /// + /// logger.LogDebug("Processing request from {Address}", address) + /// + /// public static void LogDebug(this ILogger logger, string? message, params object?[] args) { logger.Log(LogLevel.Debug, message, args); @@ -74,9 +90,13 @@ public static void LogDebug(this ILogger logger, string? message, params object? /// The to write to. /// The event id associated with the log. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogTrace(0, exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogTrace(0, exception, "Error while processing request from {Address}", address) + /// + /// public static void LogTrace(this ILogger logger, EventId eventId, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Trace, eventId, exception, message, args); @@ -87,9 +107,13 @@ public static void LogTrace(this ILogger logger, EventId eventId, Exception? exc /// /// The to write to. /// The event id associated with the log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogTrace(0, "Processing request from {Address}", address) + /// + /// + /// logger.LogTrace(0, "Processing request from {Address}", address) + /// + /// public static void LogTrace(this ILogger logger, EventId eventId, string? message, params object?[] args) { logger.Log(LogLevel.Trace, eventId, message, args); @@ -100,9 +124,13 @@ public static void LogTrace(this ILogger logger, EventId eventId, string? messag /// /// The to write to. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogTrace(exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogTrace(exception, "Error while processing request from {Address}", address) + /// + /// public static void LogTrace(this ILogger logger, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Trace, exception, message, args); @@ -112,9 +140,13 @@ public static void LogTrace(this ILogger logger, Exception? exception, string? m /// Formats and writes a trace log message. /// /// The to write to. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogTrace("Processing request from {Address}", address) + /// + /// + /// logger.LogTrace("Processing request from {Address}", address) + /// + /// public static void LogTrace(this ILogger logger, string? message, params object?[] args) { logger.Log(LogLevel.Trace, message, args); @@ -128,9 +160,13 @@ public static void LogTrace(this ILogger logger, string? message, params object? /// The to write to. /// The event id associated with the log. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogInformation(0, exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogInformation(0, exception, "Error while processing request from {Address}", address) + /// + /// public static void LogInformation(this ILogger logger, EventId eventId, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Information, eventId, exception, message, args); @@ -141,9 +177,13 @@ public static void LogInformation(this ILogger logger, EventId eventId, Exceptio /// /// The to write to. /// The event id associated with the log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogInformation(0, "Processing request from {Address}", address) + /// + /// + /// logger.LogInformation(0, "Processing request from {Address}", address) + /// + /// public static void LogInformation(this ILogger logger, EventId eventId, string? message, params object?[] args) { logger.Log(LogLevel.Information, eventId, message, args); @@ -154,9 +194,13 @@ public static void LogInformation(this ILogger logger, EventId eventId, string? /// /// The to write to. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogInformation(exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogInformation(exception, "Error while processing request from {Address}", address) + /// + /// public static void LogInformation(this ILogger logger, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Information, exception, message, args); @@ -166,9 +210,13 @@ public static void LogInformation(this ILogger logger, Exception? exception, str /// Formats and writes an informational log message. /// /// The to write to. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogInformation("Processing request from {Address}", address) + /// + /// + /// logger.LogInformation("Processing request from {Address}", address) + /// + /// public static void LogInformation(this ILogger logger, string? message, params object?[] args) { logger.Log(LogLevel.Information, message, args); @@ -182,9 +230,13 @@ public static void LogInformation(this ILogger logger, string? message, params o /// The to write to. /// The event id associated with the log. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogWarning(0, exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogWarning(0, exception, "Error while processing request from {Address}", address) + /// + /// public static void LogWarning(this ILogger logger, EventId eventId, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Warning, eventId, exception, message, args); @@ -195,9 +247,13 @@ public static void LogWarning(this ILogger logger, EventId eventId, Exception? e /// /// The to write to. /// The event id associated with the log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogWarning(0, "Processing request from {Address}", address) + /// + /// + /// logger.LogWarning(0, "Processing request from {Address}", address) + /// + /// public static void LogWarning(this ILogger logger, EventId eventId, string? message, params object?[] args) { logger.Log(LogLevel.Warning, eventId, message, args); @@ -208,9 +264,13 @@ public static void LogWarning(this ILogger logger, EventId eventId, string? mess /// /// The to write to. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogWarning(exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogWarning(exception, "Error while processing request from {Address}", address) + /// + /// public static void LogWarning(this ILogger logger, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Warning, exception, message, args); @@ -220,9 +280,13 @@ public static void LogWarning(this ILogger logger, Exception? exception, string? /// Formats and writes a warning log message. /// /// The to write to. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogWarning("Processing request from {Address}", address) + /// + /// + /// logger.LogWarning("Processing request from {Address}", address) + /// + /// public static void LogWarning(this ILogger logger, string? message, params object?[] args) { logger.Log(LogLevel.Warning, message, args); @@ -236,9 +300,13 @@ public static void LogWarning(this ILogger logger, string? message, params objec /// The to write to. /// The event id associated with the log. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogError(0, exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogError(0, exception, "Error while processing request from {Address}", address) + /// + /// public static void LogError(this ILogger logger, EventId eventId, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Error, eventId, exception, message, args); @@ -249,9 +317,13 @@ public static void LogError(this ILogger logger, EventId eventId, Exception? exc /// /// The to write to. /// The event id associated with the log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogError(0, "Processing request from {Address}", address) + /// + /// + /// logger.LogError(0, "Processing request from {Address}", address) + /// + /// public static void LogError(this ILogger logger, EventId eventId, string? message, params object?[] args) { logger.Log(LogLevel.Error, eventId, message, args); @@ -262,9 +334,13 @@ public static void LogError(this ILogger logger, EventId eventId, string? messag /// /// The to write to. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogError(exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogError(exception, "Error while processing request from {Address}", address) + /// + /// public static void LogError(this ILogger logger, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Error, exception, message, args); @@ -274,9 +350,13 @@ public static void LogError(this ILogger logger, Exception? exception, string? m /// Formats and writes an error log message. /// /// The to write to. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogError("Processing request from {Address}", address) + /// + /// + /// logger.LogError("Processing request from {Address}", address) + /// + /// public static void LogError(this ILogger logger, string? message, params object?[] args) { logger.Log(LogLevel.Error, message, args); @@ -290,9 +370,13 @@ public static void LogError(this ILogger logger, string? message, params object? /// The to write to. /// The event id associated with the log. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogCritical(0, exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogCritical(0, exception, "Error while processing request from {Address}", address) + /// + /// public static void LogCritical(this ILogger logger, EventId eventId, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Critical, eventId, exception, message, args); @@ -303,9 +387,13 @@ public static void LogCritical(this ILogger logger, EventId eventId, Exception? /// /// The to write to. /// The event id associated with the log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogCritical(0, "Processing request from {Address}", address) + /// + /// + /// logger.LogCritical(0, "Processing request from {Address}", address) + /// + /// public static void LogCritical(this ILogger logger, EventId eventId, string? message, params object?[] args) { logger.Log(LogLevel.Critical, eventId, message, args); @@ -316,9 +404,13 @@ public static void LogCritical(this ILogger logger, EventId eventId, string? mes /// /// The to write to. /// The exception to log. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogCritical(exception, "Error while processing request from {Address}", address) + /// + /// + /// logger.LogCritical(exception, "Error while processing request from {Address}", address) + /// + /// public static void LogCritical(this ILogger logger, Exception? exception, string? message, params object?[] args) { logger.Log(LogLevel.Critical, exception, message, args); @@ -328,9 +420,13 @@ public static void LogCritical(this ILogger logger, Exception? exception, string /// Formats and writes a critical log message. /// /// The to write to. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. - /// logger.LogCritical("Processing request from {Address}", address) + /// + /// + /// logger.LogCritical("Processing request from {Address}", address) + /// + /// public static void LogCritical(this ILogger logger, string? message, params object?[] args) { logger.Log(LogLevel.Critical, message, args); @@ -396,13 +492,13 @@ public static void Log(this ILogger logger, LogLevel logLevel, EventId eventId, /// Formats the message and creates a scope. /// /// The to create the scope in. - /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}" + /// Format string of the log message in message template format. Example: "User {User} logged in from {Address}". /// An object array that contains zero or more objects to format. /// A disposable scope object. Can be null. /// - /// using(logger.BeginScope("Processing request from {Address}", address)) - /// { - /// } + /// + /// using(logger.BeginScope("Processing request from {Address}", address)) { } + /// /// public static IDisposable? BeginScope( this ILogger logger, diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerExternalScopeProvider.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerExternalScopeProvider.cs index 53744eb2e76ec..7f498c9c0c3c6 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerExternalScopeProvider.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerExternalScopeProvider.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.Logging { /// - /// Default implementation of + /// Default implementation of . /// public class LoggerExternalScopeProvider : IExternalScopeProvider { diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerMessage.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerMessage.cs index 1f010e6647032..b719d95573059 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerMessage.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerMessage.cs @@ -9,15 +9,15 @@ namespace Microsoft.Extensions.Logging { /// - /// Creates delegates which can be later cached to log messages in a performant way. + /// Creates delegates that can be later cached to log messages in a performant way. /// public static class LoggerMessage { /// - /// Creates a delegate which can be invoked to create a log scope. + /// Creates a delegate that can be invoked to create a log scope. /// - /// The named format string - /// A delegate which when invoked creates a log scope. + /// The named format string. + /// A delegate that, when invoked, creates a log scope. public static Func DefineScope(string formatString) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 0); @@ -28,11 +28,11 @@ public static class LoggerMessage } /// - /// Creates a delegate which can be invoked to create a log scope. + /// Creates a delegate that can be invoked to create a log scope. /// /// The type of the first parameter passed to the named format string. - /// The named format string - /// A delegate which when invoked creates a log scope. + /// The named format string. + /// A delegate that, when invoked, creates a log scope. public static Func DefineScope(string formatString) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 1); @@ -41,12 +41,12 @@ public static class LoggerMessage } /// - /// Creates a delegate which can be invoked to create a log scope. + /// Creates a delegate that can be invoked to create a log scope. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. - /// The named format string - /// A delegate which when invoked creates a log scope. + /// The named format string. + /// A delegate that, when invoked, creates a log scope. public static Func DefineScope(string formatString) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 2); @@ -55,13 +55,13 @@ public static class LoggerMessage } /// - /// Creates a delegate which can be invoked to create a log scope. + /// Creates a delegate that can be invoked to create a log scope. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. /// The type of the third parameter passed to the named format string. - /// The named format string - /// A delegate which when invoked creates a log scope. + /// The named format string. + /// A delegate that, when invoked, creates a log scope. public static Func DefineScope(string formatString) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 3); @@ -70,14 +70,14 @@ public static class LoggerMessage } /// - /// Creates a delegate which can be invoked to create a log scope. + /// Creates a delegate that can be invoked to create a log scope. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. /// The type of the third parameter passed to the named format string. /// The type of the fourth parameter passed to the named format string. - /// The named format string - /// A delegate which when invoked creates a log scope. + /// The named format string. + /// A delegate that, when invoked, creates a log scope. public static Func DefineScope(string formatString) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 4); @@ -86,15 +86,15 @@ public static class LoggerMessage } /// - /// Creates a delegate which can be invoked to create a log scope. + /// Creates a delegate that can be invoked to create a log scope. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. /// The type of the third parameter passed to the named format string. /// The type of the fourth parameter passed to the named format string. /// The type of the fifth parameter passed to the named format string. - /// The named format string - /// A delegate which when invoked creates a log scope. + /// The named format string. + /// A delegate that, when invoked, creates a log scope. public static Func DefineScope(string formatString) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 5); @@ -103,7 +103,7 @@ public static class LoggerMessage } /// - /// Creates a delegate which can be invoked to create a log scope. + /// Creates a delegate that can be invoked to create a log scope. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. @@ -111,8 +111,8 @@ public static class LoggerMessage /// The type of the fourth parameter passed to the named format string. /// The type of the fifth parameter passed to the named format string. /// The type of the sixth parameter passed to the named format string. - /// The named format string - /// A delegate which when invoked creates a log scope. + /// The named format string. + /// A delegate that, when invoked, creates a log scope. public static Func DefineScope(string formatString) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 6); @@ -121,23 +121,23 @@ public static class LoggerMessage } /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// - /// The - /// The event id - /// The named format string - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString) => Define(logLevel, eventId, formatString, options: null); /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// - /// The - /// The event id - /// The named format string - /// The - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// The . + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString, LogDefineOptions? options) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 0); @@ -162,25 +162,25 @@ void Log(ILogger logger, Exception? exception) } /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString) => Define(logLevel, eventId, formatString, options: null); /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// The - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// The . + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString, LogDefineOptions? options) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 1); @@ -205,27 +205,27 @@ void Log(ILogger logger, T1 arg1, Exception? exception) } /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString) => Define(logLevel, eventId, formatString, options: null); /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// The - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// The . + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString, LogDefineOptions? options) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 2); @@ -250,29 +250,29 @@ void Log(ILogger logger, T1 arg1, T2 arg2, Exception? exception) } /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. /// The type of the third parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString) => Define(logLevel, eventId, formatString, options: null); /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. /// The type of the third parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// The - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// The . + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString, LogDefineOptions? options) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 3); @@ -297,31 +297,31 @@ void Log(ILogger logger, T1 arg1, T2 arg2, T3 arg3, Exception? exception) } /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. /// The type of the third parameter passed to the named format string. /// The type of the fourth parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString) => Define(logLevel, eventId, formatString, options: null); /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. /// The type of the third parameter passed to the named format string. /// The type of the fourth parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// The - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// The . + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString, LogDefineOptions? options) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 4); @@ -346,33 +346,33 @@ void Log(ILogger logger, T1 arg1, T2 arg2, T3 arg3, T4 arg4, Exception? exceptio } /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. /// The type of the third parameter passed to the named format string. /// The type of the fourth parameter passed to the named format string. /// The type of the fifth parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString) => Define(logLevel, eventId, formatString, options: null); /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. /// The type of the third parameter passed to the named format string. /// The type of the fourth parameter passed to the named format string. /// The type of the fifth parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// The - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// The . + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString, LogDefineOptions? options) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 5); @@ -397,7 +397,7 @@ void Log(ILogger logger, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, Exception? } /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. @@ -405,15 +405,15 @@ void Log(ILogger logger, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, Exception? /// The type of the fourth parameter passed to the named format string. /// The type of the fifth parameter passed to the named format string. /// The type of the sixth parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString) => Define(logLevel, eventId, formatString, options: null); /// - /// Creates a delegate which can be invoked for logging a message. + /// Creates a delegate that can be invoked for logging a message. /// /// The type of the first parameter passed to the named format string. /// The type of the second parameter passed to the named format string. @@ -421,11 +421,11 @@ void Log(ILogger logger, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, Exception? /// The type of the fourth parameter passed to the named format string. /// The type of the fifth parameter passed to the named format string. /// The type of the sixth parameter passed to the named format string. - /// The - /// The event id - /// The named format string - /// The - /// A delegate which when invoked creates a log message. + /// The . + /// The event ID. + /// The named format string. + /// The . + /// A delegate that, when invoked, creates a log message. public static Action Define(LogLevel logLevel, EventId eventId, string formatString, LogDefineOptions? options) { LogValuesFormatter formatter = CreateLogValuesFormatter(formatString, expectedNamedParameterCount: 6); diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerMessageAttribute.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerMessageAttribute.cs index 08ba6320ce845..e6f5592d7c59b 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerMessageAttribute.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/LoggerMessageAttribute.cs @@ -6,7 +6,7 @@ namespace Microsoft.Extensions.Logging { /// - /// Provides information to guide the production of a strongly-typed logging method. + /// Provides information to guide the production of a strongly typed logging method. /// /// /// The method this attribute is applied to: @@ -33,15 +33,15 @@ public sealed class LoggerMessageAttribute : Attribute { /// /// Initializes a new instance of the class - /// which is used to guide the production of a strongly-typed logging method. + /// that's used to guide the production of a strongly typed logging method. /// public LoggerMessageAttribute() { } /// /// Initializes a new instance of the class - /// which is used to guide the production of a strongly-typed logging method. + /// that's used to guide the production of a strongly typed logging method. /// - /// The log event Id. + /// The log event ID. /// The log level. /// Format string of the log message. public LoggerMessageAttribute(int eventId, LogLevel level, string message) @@ -53,7 +53,7 @@ public LoggerMessageAttribute(int eventId, LogLevel level, string message) /// /// Initializes a new instance of the class - /// which is used to guide the production of a strongly-typed logging method. + /// that's used to guide the production of a strongly typed logging method. /// /// The log level. /// Format string of the log message. @@ -65,7 +65,7 @@ public LoggerMessageAttribute(LogLevel level, string message) /// /// Initializes a new instance of the class - /// which is used to guide the production of a strongly-typed logging method. + /// that's used to guide the production of a strongly typed logging method. /// /// The log level. public LoggerMessageAttribute(LogLevel level) @@ -75,7 +75,7 @@ public LoggerMessageAttribute(LogLevel level) /// /// Initializes a new instance of the class - /// which is used to guide the production of a strongly-typed logging method. + /// that's used to guide the production of a strongly typed logging method. /// /// Format string of the log message. public LoggerMessageAttribute(string message) @@ -84,7 +84,7 @@ public LoggerMessageAttribute(string message) } /// - /// Gets the logging event id for the logging method. + /// Gets or sets the logging event ID for the logging method. /// public int EventId { get; set; } = -1; @@ -97,17 +97,17 @@ public LoggerMessageAttribute(string message) public string? EventName { get; set; } /// - /// Gets the logging level for the logging method. + /// Gets or sets the logging level for the logging method. /// public LogLevel Level { get; set; } = LogLevel.None; /// - /// Gets the message text for the logging method. + /// Gets or sets the message text for the logging method. /// public string Message { get; set; } = ""; /// - /// Gets the flag to skip IsEnabled check for the logging method. + /// Gets or sets the flag to skip IsEnabled check for the logging method. /// public bool SkipEnabledCheck { get; set; } } diff --git a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/NullLoggerFactory.cs b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/NullLoggerFactory.cs index 2f76fd94d65e1..753e37fee4706 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/NullLoggerFactory.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Abstractions/src/NullLoggerFactory.cs @@ -4,7 +4,7 @@ namespace Microsoft.Extensions.Logging.Abstractions { /// - /// An used to create instance of + /// An used to create an instance of /// that logs nothing. /// public class NullLoggerFactory : ILoggerFactory @@ -21,7 +21,7 @@ public NullLoggerFactory() { } /// /// - /// This returns a instance which logs nothing. + /// This returns a instance that logs nothing. /// public ILogger CreateLogger(string name) { diff --git a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/ILoggerProviderConfiguration.cs b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/ILoggerProviderConfiguration.cs index c9dbe5005f5af..857d0f66858ac 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/ILoggerProviderConfiguration.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/ILoggerProviderConfiguration.cs @@ -6,13 +6,13 @@ namespace Microsoft.Extensions.Logging.Configuration { /// - /// Allows access to configuration section associated with logger provider + /// Allows access to configuration section associated with logger provider. /// - /// Type of logger provider to get configuration for + /// The type of logger provider to get configuration for. public interface ILoggerProviderConfiguration { /// - /// Configuration section for requested logger provider + /// Gets the configuration section for the requested logger provider. /// IConfiguration Configuration { get; } } diff --git a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/ILoggerProviderConfigurationFactory.cs b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/ILoggerProviderConfigurationFactory.cs index b74d208b09b9d..4d396dfe24dd6 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/ILoggerProviderConfigurationFactory.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/ILoggerProviderConfigurationFactory.cs @@ -12,9 +12,9 @@ namespace Microsoft.Extensions.Logging.Configuration public interface ILoggerProviderConfigurationFactory { /// - /// Return configuration section associated with logger provider + /// Returns the configuration section associated with the logger provider. /// - /// The logger provider type + /// The logger provider type. /// The for the given . IConfiguration GetConfiguration(Type providerType); } diff --git a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/LoggerProviderConfigurationExtensions.cs b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/LoggerProviderConfigurationExtensions.cs index 231e3dd2b2cdd..1a283baf00623 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/LoggerProviderConfigurationExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/LoggerProviderConfigurationExtensions.cs @@ -20,8 +20,8 @@ public static class LoggerProviderOptions /// Indicates that settings for should be loaded into type. /// /// The to register on. - /// The options class - /// The provider class + /// The options class. + /// The provider class. [RequiresDynamicCode(RequiresDynamicCodeMessage)] [RequiresUnreferencedCode(TrimmingRequiresUnreferencedCodeMessage)] public static void RegisterProviderOptions<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] TOptions, TProvider>(IServiceCollection services) where TOptions : class diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConfigurationConsoleLoggerSettings.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConfigurationConsoleLoggerSettings.cs index 9bf4c7e08350c..ac43a7eeef59f 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConfigurationConsoleLoggerSettings.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConfigurationConsoleLoggerSettings.cs @@ -20,7 +20,7 @@ public class ConfigurationConsoleLoggerSettings : IConsoleLoggerSettings /// /// Creates a new instance of . /// - /// provides access to configuration values. + /// The configuration values. public ConfigurationConsoleLoggerSettings(IConfiguration configuration) { _configuration = configuration; @@ -28,7 +28,7 @@ public ConfigurationConsoleLoggerSettings(IConfiguration configuration) } /// - /// Gets the propagates notifications that a change has occurred. + /// Gets the that propagates notifications that a change has occurred. /// public IChangeToken? ChangeToken { get; private set; } @@ -70,9 +70,9 @@ public IConsoleLoggerSettings Reload() /// /// Gets the log level for the specified switch. /// - /// The name of the switch to look up - /// An out parameter that will be set to the value of the switch if it is found. If the switch is not found, the method returns false and sets the value of level to LogLevel.None - /// True if the switch was found, otherwise false. + /// The name of the switch to look up. + /// When this method returns, contains the value of the switch if it is found. If the switch is not found, the method returns false and sets the value of level to LogLevel.None + /// if the switch was found, otherwise . /// public bool TryGetSwitch(string name, out LogLevel level) { diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatter.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatter.cs index c44aead487ab3..bcd0bcbdf25ec 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatter.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatter.cs @@ -8,7 +8,7 @@ namespace Microsoft.Extensions.Logging.Console { /// - /// Allows custom log messages formatting + /// Allows custom log messages formatting. /// public abstract class ConsoleFormatter { diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterNames.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterNames.cs index f2c71c197177b..619c5eae95506 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterNames.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterNames.cs @@ -9,17 +9,17 @@ namespace Microsoft.Extensions.Logging.Console public static class ConsoleFormatterNames { /// - /// Reserved name for simple console formatter + /// Reserved name for simple console formatter. /// public const string Simple = "simple"; /// - /// Reserved name for json console formatter + /// Reserved name for json console formatter. /// public const string Json = "json"; /// - /// Reserved name for systemd console formatter + /// Reserved name for systemd console formatter. /// public const string Systemd = "systemd"; } diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterOptions.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterOptions.cs index 2b3d0128b72cd..e97c3cbe0c88f 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterOptions.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatterOptions.cs @@ -17,19 +17,28 @@ public class ConsoleFormatterOptions public ConsoleFormatterOptions() { } /// - /// Includes scopes when . + /// Gets or sets a value that indicates whether scopes are included. /// + /// + /// if scopes are included. + /// public bool IncludeScopes { get; set; } /// - /// Gets or sets format string used to format timestamp in logging messages. Defaults to null. + /// Gets or sets the format string used to format timestamp in logging messages. /// + /// + /// The default is . + /// [StringSyntax(StringSyntaxAttribute.DateTimeFormat)] public string? TimestampFormat { get; set; } /// - /// Gets or sets indication whether or not UTC timezone should be used to format timestamps in logging messages. Defaults to false. + /// Gets or sets a value that indicates whether or not UTC timezone should be used to format timestamps in logging messages. /// + /// + /// The default is . + /// public bool UseUtcTimestamp { get; set; } internal virtual void Configure(IConfiguration configuration) => configuration.Bind(this); diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerFormat.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerFormat.cs index e8cdef7028ede..9068f7959a2be 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerFormat.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerFormat.cs @@ -4,17 +4,17 @@ namespace Microsoft.Extensions.Logging.Console { /// - /// Format of messages. + /// Describes the format of messages. /// [System.ObsoleteAttribute("ConsoleLoggerFormat has been deprecated.")] public enum ConsoleLoggerFormat { /// - /// Produces messages in the default console format. + /// Produce messages in the default console format. /// Default, /// - /// Produces messages in a format suitable for console output to the systemd journal. + /// Produce messages in a format suitable for console output to the systemd journal. /// Systemd, } diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerOptions.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerOptions.cs index 69704e4095a8e..2c55850ec27be 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerOptions.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerOptions.cs @@ -11,16 +11,22 @@ namespace Microsoft.Extensions.Logging.Console public class ConsoleLoggerOptions { /// - /// Disables colors when . + /// Gets or sets a value that indicates whether colors are disabled. /// + /// + /// if colors are disabled. + /// [System.ObsoleteAttribute("ConsoleLoggerOptions.DisableColors has been deprecated. Use SimpleConsoleFormatterOptions.ColorBehavior instead.")] public bool DisableColors { get; set; } #pragma warning disable CS0618 private ConsoleLoggerFormat _format = ConsoleLoggerFormat.Default; /// - /// Gets or sets log message format. Defaults to . + /// Gets or sets the log message format. /// + /// + /// The default value is . + /// [System.ObsoleteAttribute("ConsoleLoggerOptions.Format has been deprecated. Use ConsoleLoggerOptions.FormatterName instead.")] public ConsoleLoggerFormat Format { @@ -37,37 +43,52 @@ public ConsoleLoggerFormat Format } /// - /// Name of the log message formatter to use. Defaults to simple. + /// Gets or sets the name of the log message formatter to use. /// + /// + /// The default value is . + /// public string? FormatterName { get; set; } /// - /// Includes scopes when . + /// Gets or sets a value that indicates whether scopes are included. /// + /// + /// if scopes are included. + /// [System.ObsoleteAttribute("ConsoleLoggerOptions.IncludeScopes has been deprecated. Use ConsoleFormatterOptions.IncludeScopes instead.")] public bool IncludeScopes { get; set; } /// - /// Gets or sets value indicating the minimum level of messages that would get written to Console.Error. + /// Gets or sets value indicating the minimum level of messages that get written to Console.Error. /// public LogLevel LogToStandardErrorThreshold { get; set; } = LogLevel.None; /// - /// Gets or sets format string used to format timestamp in logging messages. Defaults to null. + /// Gets or sets the format string used to format timestamp in logging messages. /// + /// + /// The default value is . + /// [System.ObsoleteAttribute("ConsoleLoggerOptions.TimestampFormat has been deprecated. Use ConsoleFormatterOptions.TimestampFormat instead.")] public string? TimestampFormat { get; set; } /// - /// Gets or sets indication whether or not UTC timezone should be used to format timestamps in logging messages. Defaults to false. + /// Gets or sets a value that indicates whether UTC timezone should be used to format timestamps in logging messages. /// + /// + /// if the UTC timezone should be used to format timestamps. The default value is . + /// [System.ObsoleteAttribute("ConsoleLoggerOptions.UseUtcTimestamp has been deprecated. Use ConsoleFormatterOptions.UseUtcTimestamp instead.")] public bool UseUtcTimestamp { get; set; } private ConsoleLoggerQueueFullMode _queueFullMode = ConsoleLoggerQueueFullMode.Wait; /// - /// Gets or sets the desired console logger behavior when the queue becomes full. Defaults to Wait. + /// Gets or sets the desired console logger behavior when the queue becomes full. /// + /// + /// The default value is . + /// public ConsoleLoggerQueueFullMode QueueFullMode { get => _queueFullMode; @@ -85,8 +106,11 @@ public ConsoleLoggerQueueFullMode QueueFullMode private int _maxQueuedMessages = DefaultMaxQueueLengthValue; /// - /// Gets or sets the maximum number of enqueued messages. Defaults to 2500. + /// Gets or sets the maximum number of enqueued messages. /// + /// + /// The default value is 2500. + /// public int MaxQueueLength { get => _maxQueuedMessages; diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerProvider.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerProvider.cs index 8551e74056f4c..68a356de9ba74 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerProvider.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerProvider.cs @@ -37,7 +37,7 @@ public ConsoleLoggerProvider(IOptionsMonitor options) /// Creates an instance of . /// /// The options to create instances with. - /// Log formatters added for insteaces. + /// Log formatters added for instances. public ConsoleLoggerProvider(IOptionsMonitor options, IEnumerable? formatters) { _options = options; diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerQueueFullMode.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerQueueFullMode.cs index d17e3662a73f7..b13a35b6d4bdc 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerQueueFullMode.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerQueueFullMode.cs @@ -4,7 +4,7 @@ namespace Microsoft.Extensions.Logging.Console { /// - /// Determines the console logger behavior when the queue becomes full. + /// Describes the console logger behavior when the queue becomes full. /// public enum ConsoleLoggerQueueFullMode { diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatterOptions.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatterOptions.cs index 00f0f3773dadb..eff4a8ab1a72a 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatterOptions.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatterOptions.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.Logging.Console { /// - /// Options for the built-in json console log formatter. + /// Options for the built-in JSON console log formatter. /// public class JsonConsoleFormatterOptions : ConsoleFormatterOptions { diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/LoggerColorBehavior.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/LoggerColorBehavior.cs index c38ec1969b43d..8d57b0e325def 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Console/src/LoggerColorBehavior.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/LoggerColorBehavior.cs @@ -4,7 +4,7 @@ namespace Microsoft.Extensions.Logging.Console { /// - /// Determines when to use color when logging messages. + /// Describes when to use color when logging messages. /// public enum LoggerColorBehavior { @@ -16,11 +16,11 @@ public enum LoggerColorBehavior /// Default, /// - /// Enable color for logging + /// Enable color for logging. /// Enabled, /// - /// Disable color for logging + /// Disable color for logging. /// Disabled, } diff --git a/src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatterOptions.cs b/src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatterOptions.cs index 326fb16d752bb..699f25b0bad9e 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatterOptions.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatterOptions.cs @@ -16,13 +16,16 @@ public class SimpleConsoleFormatterOptions : ConsoleFormatterOptions public SimpleConsoleFormatterOptions() { } /// - /// Determines when to use color when logging messages. + /// Gets or sets the behavior that describes when to use color when logging messages. /// public LoggerColorBehavior ColorBehavior { get; set; } /// - /// When , the entire message gets logged in a single line. + /// Gets or sets a value that indicates whether the entire message is logged in a single line. /// + /// + /// if the entire message is logged in a single line. + /// public bool SingleLine { get; set; } internal override void Configure(IConfiguration configuration) => configuration.Bind(this); diff --git a/src/libraries/Microsoft.Extensions.Logging.Debug/src/DebugLoggerFactoryExtensions.cs b/src/libraries/Microsoft.Extensions.Logging.Debug/src/DebugLoggerFactoryExtensions.cs index 025bcb64460ac..a33b375fe7236 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Debug/src/DebugLoggerFactoryExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Logging.Debug/src/DebugLoggerFactoryExtensions.cs @@ -27,13 +27,13 @@ public static class DebugLoggerFactoryExtensions /// Adds a debug logger that is enabled as defined by the filter function. /// /// The extension method argument. - /// The function used to filter events based on the log level. This parameter is no longer honored and will be ignored. + /// The function used to filter events based on the log level. This parameter is no longer honored and is ignored. [EditorBrowsable(EditorBrowsableState.Never)] [Obsolete("This method is retained only for compatibility. The recommended alternative is AddDebug(this ILoggingBuilder builder).", error: true)] public static ILoggerFactory AddDebug(this ILoggerFactory factory, Func filter) => AddDebug(factory); /// - /// Adds a debug logger that is enabled for s of minLevel or higher. + /// Adds a debug logger that is enabled for log levels of minLevel or higher. /// /// The extension method argument. [EditorBrowsable(EditorBrowsableState.Never)] diff --git a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogSettings.cs b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogSettings.cs index ea5b4340f6c75..35be4111fbd58 100644 --- a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogSettings.cs +++ b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogSettings.cs @@ -13,22 +13,22 @@ public class EventLogSettings private IEventLog? _eventLog; /// - /// Name of the event log. If null or not specified, "Application" is the default. + /// Gets or sets the name of the event log. If or not specified, "Application" is the default. /// public string? LogName { get; set; } /// - /// Name of the event log source. If null or not specified, ".NET Runtime" is the default. + /// Gets or sets the name of the event log source. If or not specified, ".NET Runtime" is the default. /// public string? SourceName { get; set; } /// - /// Name of the machine having the event log. If null or not specified, local machine is the default. + /// Gets or sets the name of the machine with the event log. If or not specified, local machine is the default. /// public string? MachineName { get; set; } /// - /// The function used to filter events based on the log level. + /// Gets or sets the function used to filter events based on the log level. /// public Func? Filter { get; set; } diff --git a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLoggerFactoryExtensions.cs b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLoggerFactoryExtensions.cs index 1ff31e4e1586a..3b01b7de138fb 100644 --- a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLoggerFactoryExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLoggerFactoryExtensions.cs @@ -15,7 +15,7 @@ namespace Microsoft.Extensions.Logging public static class EventLoggerFactoryExtensions { /// - /// Adds an event logger. Use to enable logging for specific s. + /// Adds an event logger. Use to enable logging for specific log levels. /// /// The extension method argument. /// The . @@ -34,7 +34,7 @@ public static ILoggerFactory AddEventLog(this ILoggerFactory factory, EventLog.E /// Adds an event logger that is enabled for s of minLevel or higher. /// /// The extension method argument. - /// The minimum to be logged + /// The minimum to be logged. [EditorBrowsable(EditorBrowsableState.Never)] [Obsolete("This method is retained only for compatibility. The recommended alternative is AddEventLog(this ILoggingBuilder builder).", error: true)] public static ILoggerFactory AddEventLog(this ILoggerFactory factory, LogLevel minLevel) => @@ -63,7 +63,7 @@ public static ILoggingBuilder AddEventLog(this ILoggingBuilder builder) } /// - /// Adds an event logger. Use to enable logging for specific s. + /// Adds an event logger. Use to enable logging for specific log levels. /// /// The extension method argument. /// The . @@ -79,7 +79,7 @@ public static ILoggingBuilder AddEventLog(this ILoggingBuilder builder, EventLog } /// - /// Adds an event logger. Use to enable logging for specific s. + /// Adds an event logger. Use to enable logging for specific log levels. /// /// The extension method argument. /// A delegate to configure the . diff --git a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLoggerFactoryExtensions.cs b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLoggerFactoryExtensions.cs index cd92ca6b2aee4..1c25028f8a200 100644 --- a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLoggerFactoryExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLoggerFactoryExtensions.cs @@ -16,7 +16,7 @@ namespace Microsoft.Extensions.Logging public static class EventSourceLoggerFactoryExtensions { /// - /// Adds an logger that writes messages to the instance. + /// Adds a logger that writes messages to the instance. /// /// The extension method argument. /// The so that additional calls can be chained. @@ -32,7 +32,7 @@ public static ILoggerFactory AddEventSourceLogger(this ILoggerFactory factory) } /// - /// Adds an logger that writes messages to the instance. + /// Adds a logger that writes messages to the instance. /// /// The extension method argument. /// The so that additional calls can be chained. diff --git a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs index 62100ee9723b1..d2d10e7099b75 100644 --- a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs +++ b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs @@ -13,8 +13,9 @@ namespace Microsoft.Extensions.Logging.EventSource { /// - /// The LoggingEventSource is the bridge from all ILogger based logging to EventSource/EventListener logging. - /// + /// Bridges all ILogger-based logging to EventSource/EventListener logging. + /// + /// /// You turn this logging on by enabling the EventSource called /// /// Microsoft-Extensions-Logging @@ -76,7 +77,7 @@ namespace Microsoft.Extensions.Logging.EventSource /// Console.WriteLine("Logger {0}: {1}", eventData.Payload[2], eventData.Payload[4]); /// } /// } - /// + /// [EventSource(Name = "Microsoft-Extensions-Logging")] public sealed class LoggingEventSource : System.Diagnostics.Tracing.EventSource { diff --git a/src/libraries/Microsoft.Extensions.Logging/src/ActivityTrackingOptions.cs b/src/libraries/Microsoft.Extensions.Logging/src/ActivityTrackingOptions.cs index 580d7cf732937..6a4ec3ac2b5f7 100644 --- a/src/libraries/Microsoft.Extensions.Logging/src/ActivityTrackingOptions.cs +++ b/src/libraries/Microsoft.Extensions.Logging/src/ActivityTrackingOptions.cs @@ -16,17 +16,17 @@ public enum ActivityTrackingOptions None = 0x0000, /// - /// Span Id will be included in the logging. + /// Span ID will be included in the logging. /// SpanId = 0x0001, /// - /// Trace Id will be included in the logging. + /// Trace ID will be included in the logging. /// TraceId = 0x0002, /// - /// Parent Id will be included in the logging. + /// Parent ID will be included in the logging. /// ParentId = 0x0004, diff --git a/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactory.cs b/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactory.cs index 2cb0994acc167..8260ea6381ba7 100644 --- a/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactory.cs +++ b/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactory.cs @@ -256,7 +256,7 @@ private LoggerInformation[] CreateLoggers(string categoryName) /// /// Check if the factory has been disposed. /// - /// True when as been called + /// when as been called protected virtual bool CheckDisposed() => _disposed; /// diff --git a/src/libraries/Microsoft.Extensions.Logging/src/LoggerFilterOptions.cs b/src/libraries/Microsoft.Extensions.Logging/src/LoggerFilterOptions.cs index b19970ca64c16..b9032de8800cd 100644 --- a/src/libraries/Microsoft.Extensions.Logging/src/LoggerFilterOptions.cs +++ b/src/libraries/Microsoft.Extensions.Logging/src/LoggerFilterOptions.cs @@ -18,8 +18,11 @@ public class LoggerFilterOptions public LoggerFilterOptions() { } /// - /// Gets or sets value indicating whether logging scopes are being captured. Defaults to true + /// Gets or sets a value indicating whether logging scopes are being captured. /// + /// + /// The default value is + /// public bool CaptureScopes { get; set; } = true; /// diff --git a/src/libraries/Microsoft.Extensions.Logging/src/LoggingBuilderExtensions.cs b/src/libraries/Microsoft.Extensions.Logging/src/LoggingBuilderExtensions.cs index ea3b7b0cb2b36..eee9e26f2f813 100644 --- a/src/libraries/Microsoft.Extensions.Logging/src/LoggingBuilderExtensions.cs +++ b/src/libraries/Microsoft.Extensions.Logging/src/LoggingBuilderExtensions.cs @@ -52,8 +52,8 @@ public static ILoggingBuilder ClearProviders(this ILoggingBuilder builder) /// /// Configure the with the . /// - /// The to be configured with - /// The action used to configure the logger factory + /// The to be configured with . + /// The action used to configure the logger factory. /// The so that additional calls can be chained. public static ILoggingBuilder Configure(this ILoggingBuilder builder, Action action) { diff --git a/src/libraries/Microsoft.Extensions.Logging/src/ProviderAliasAttribute.cs b/src/libraries/Microsoft.Extensions.Logging/src/ProviderAliasAttribute.cs index b7158b428c037..e7ca0385eea42 100644 --- a/src/libraries/Microsoft.Extensions.Logging/src/ProviderAliasAttribute.cs +++ b/src/libraries/Microsoft.Extensions.Logging/src/ProviderAliasAttribute.cs @@ -21,7 +21,7 @@ public ProviderAliasAttribute(string alias) } /// - /// The alias of the provider. + /// Gets the alias of the provider. /// public string Alias { get; } diff --git a/src/libraries/Microsoft.Extensions.Primitives/src/CompositeChangeToken.cs b/src/libraries/Microsoft.Extensions.Primitives/src/CompositeChangeToken.cs index a6779654fbe1f..6eb1398cc2258 100644 --- a/src/libraries/Microsoft.Extensions.Primitives/src/CompositeChangeToken.cs +++ b/src/libraries/Microsoft.Extensions.Primitives/src/CompositeChangeToken.cs @@ -10,7 +10,7 @@ namespace Microsoft.Extensions.Primitives { /// - /// An which represents one or more instances. + /// An that represents one or more instances. /// [DebuggerDisplay("HasChanged = {HasChanged}")] public class CompositeChangeToken : IChangeToken @@ -47,7 +47,7 @@ public CompositeChangeToken(IReadOnlyList changeTokens) } /// - /// Returns the list of which compose the current . + /// Returns the list of that compose the current . /// public IReadOnlyList ChangeTokens { get; } diff --git a/src/libraries/Microsoft.Extensions.Primitives/src/Extensions.cs b/src/libraries/Microsoft.Extensions.Primitives/src/Extensions.cs index e002bc0decc3c..c197f22ba6d32 100644 --- a/src/libraries/Microsoft.Extensions.Primitives/src/Extensions.cs +++ b/src/libraries/Microsoft.Extensions.Primitives/src/Extensions.cs @@ -11,7 +11,7 @@ namespace Microsoft.Extensions.Primitives public static class Extensions { /// - /// Add the given to the . + /// Adds the given to the . /// /// The to add to. /// The to add. diff --git a/src/libraries/Microsoft.Extensions.Primitives/src/IChangeToken.cs b/src/libraries/Microsoft.Extensions.Primitives/src/IChangeToken.cs index f34122c21f723..33095e0c14e9d 100644 --- a/src/libraries/Microsoft.Extensions.Primitives/src/IChangeToken.cs +++ b/src/libraries/Microsoft.Extensions.Primitives/src/IChangeToken.cs @@ -16,7 +16,7 @@ public interface IChangeToken bool HasChanged { get; } /// - /// Indicates if this token will pro-actively raise callbacks. If false, the token consumer must + /// Indicates if this token will proactively raise callbacks. If false, the token consumer must /// poll to detect changes. /// bool ActiveChangeCallbacks { get; } diff --git a/src/libraries/Microsoft.Extensions.Primitives/src/StringSegment.cs b/src/libraries/Microsoft.Extensions.Primitives/src/StringSegment.cs index f91f2314439ca..ab49958a4fe41 100644 --- a/src/libraries/Microsoft.Extensions.Primitives/src/StringSegment.cs +++ b/src/libraries/Microsoft.Extensions.Primitives/src/StringSegment.cs @@ -193,7 +193,7 @@ public static int Compare(StringSegment a, StringSegment b, StringComparison com /// Indicates whether the current object is equal to another object of the same type. /// /// An object to compare with this object. - /// if the current object is equal to the other parameter; otherwise, . + /// if the current object is equal to ; otherwise, . public override bool Equals([NotNullWhen(true)] object? obj) { return obj is StringSegment segment && Equals(segment); @@ -203,7 +203,7 @@ public override bool Equals([NotNullWhen(true)] object? obj) /// Indicates whether the current object is equal to another object of the same type. /// /// An object to compare with this object. - /// if the current object is equal to the other parameter; otherwise, . + /// if the current object is equal to ; otherwise, . public bool Equals(StringSegment other) => Equals(other, StringComparison.Ordinal); /// @@ -211,7 +211,7 @@ public override bool Equals([NotNullWhen(true)] object? obj) /// /// An object to compare with this object. /// One of the enumeration values that specifies the rules to use in the comparison. - /// if the current object is equal to the other parameter; otherwise, . + /// if the current object is equal to ; otherwise, . public bool Equals(StringSegment other, StringComparison comparisonType) { if (HasValue && other.HasValue) @@ -303,7 +303,7 @@ public override int GetHashCode() /// /// Creates a new from the given . /// - /// The to convert to a + /// The to convert to a . public static implicit operator StringSegment(string? value) => new StringSegment(value); /// @@ -376,7 +376,7 @@ public bool EndsWith(string text, StringComparison comparisonType) /// /// The zero-based starting character position of a substring in this . /// A that is equivalent to the substring of remaining length that begins at - /// in this + /// in this . /// /// is greater than or equal to or less than zero. /// @@ -389,7 +389,7 @@ public bool EndsWith(string text, StringComparison comparisonType) /// The zero-based starting character position of a substring in this . /// The number of characters in the substring. /// A that is equivalent to the substring of that begins at - /// in this + /// in this . /// /// or is less than zero, or + is /// greater than . @@ -423,7 +423,7 @@ public string Substring(int offset, int length) /// /// The zero-based starting character position of a substring in this . /// The number of characters in the substring. - /// A that is equivalent to the substring of that begins at in this + /// A that is equivalent to the substring of that begins at in this . /// /// or is less than zero, or + is /// greater than . diff --git a/src/libraries/Microsoft.Extensions.Primitives/src/StringTokenizer.cs b/src/libraries/Microsoft.Extensions.Primitives/src/StringTokenizer.cs index 9c4c19cfb542b..932ce5adc782e 100644 --- a/src/libraries/Microsoft.Extensions.Primitives/src/StringTokenizer.cs +++ b/src/libraries/Microsoft.Extensions.Primitives/src/StringTokenizer.cs @@ -8,7 +8,7 @@ namespace Microsoft.Extensions.Primitives { /// - /// Tokenizes a into s. + /// Tokenizes a into StringSegments. /// public readonly struct StringTokenizer : IEnumerable { @@ -87,7 +87,7 @@ internal Enumerator(in StringSegment value, char[] separators) /// /// Initializes an using a . /// - /// containing value and separators for enumeration. + /// A that contains the value to enumerate and token separators. public Enumerator(ref StringTokenizer tokenizer) { _value = tokenizer._value; diff --git a/src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs b/src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs index 67d9261276d7d..59b249438a1d5 100644 --- a/src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs +++ b/src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs @@ -31,7 +31,7 @@ namespace Microsoft.Extensions.Primitives /// /// Initializes a new instance of the structure using the specified string. /// - /// A string value or null. + /// A string value or . public StringValues(string? value) { _values = value; @@ -68,7 +68,7 @@ public static implicit operator StringValues(string?[]? values) /// Defines an implicit conversion of a given to a string, with multiple values joined as a comma separated string. /// /// - /// Returns null where has been initialized from an empty string array or is . + /// Returns where has been initialized from an empty string array or is . /// /// A to implicitly convert. public static implicit operator string?(StringValues values) @@ -114,7 +114,7 @@ public int Count bool ICollection.IsReadOnly => true; /// - /// Gets the at index. + /// Gets the at the specified index. /// /// The string at the specified index. /// The zero-based index of the element to get. @@ -126,7 +126,7 @@ public int Count } /// - /// Gets the at index. + /// Gets the at the specified index. /// /// The string at the specified index. /// The zero-based index of the element to get. @@ -348,7 +348,7 @@ private int IndexOf(string? item) /// The zero-based index in the destination array at which copying begins. /// 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 . + /// 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 contains a single null or empty string or an empty array; otherwise, false. + /// if contains a single or empty string or an empty array; otherwise, . public static bool IsNullOrEmpty(StringValues value) { object? data = value._values; @@ -524,7 +524,7 @@ public static StringValues Concat(string? value, in StringValues values) /// /// The first to compare. /// The second to compare. - /// true if the value of is the same as the value of ; otherwise, false. + /// if the value of is the same as the value of ; otherwise, . public static bool Equals(StringValues left, StringValues right) { int count = left.Count; @@ -550,7 +550,7 @@ public static bool Equals(StringValues left, StringValues right) /// /// The first to compare. /// The second to compare. - /// true if the value of is the same as the value of ; otherwise, false. + /// if the value of is the same as the value of ; otherwise, . public static bool operator ==(StringValues left, StringValues right) { return Equals(left, right); @@ -561,7 +561,7 @@ public static bool Equals(StringValues left, StringValues right) /// /// The first to compare. /// The second to compare. - /// true if the value of is different to the value of ; otherwise, false. + /// if the value of is different to the value of ; otherwise, . public static bool operator !=(StringValues left, StringValues right) { return !Equals(left, right); @@ -571,7 +571,7 @@ public static bool Equals(StringValues left, StringValues right) /// Determines whether this instance and another specified object have the same values. /// /// The string to compare to this instance. - /// true if the value of is the same as the value of this instance; otherwise, false. + /// if the value of is the same as the value of this instance; otherwise, . public bool Equals(StringValues other) => Equals(this, other); /// @@ -579,7 +579,7 @@ public static bool Equals(StringValues left, StringValues right) /// /// The to compare. /// The to compare. - /// true if the value of is the same as the value of ; otherwise, false. If is null, the method returns false. + /// if the value of is the same as the value of ; otherwise, . If is , the method returns . public static bool Equals(string? left, StringValues right) => Equals(new StringValues(left), right); /// @@ -587,14 +587,14 @@ public static bool Equals(StringValues left, StringValues right) /// /// The to compare. /// The to compare. - /// true if the value of is the same as the value of ; otherwise, false. If is null, the method returns false. + /// if the value of is the same as the value of ; otherwise, . If is , the method returns . public static bool Equals(StringValues left, string? right) => Equals(left, new StringValues(right)); /// /// Determines whether this instance and a specified , have the same value. /// /// The to compare to this instance. - /// true if the value of is the same as this instance; otherwise, false. If is null, returns false. + /// if the value of is the same as this instance; otherwise, . If is , returns . public bool Equals(string? other) => Equals(this, new StringValues(other)); /// @@ -602,7 +602,7 @@ public static bool Equals(StringValues left, StringValues right) /// /// The string array to compare. /// The to compare. - /// true if the value of is the same as the value of ; otherwise, false. + /// if the value of is the same as the value of ; otherwise, . public static bool Equals(string?[]? left, StringValues right) => Equals(new StringValues(left), right); /// @@ -610,14 +610,14 @@ public static bool Equals(StringValues left, StringValues right) /// /// The to compare. /// The string array to compare. - /// true if the value of is the same as the value of ; otherwise, false. + /// if the value of is the same as the value of ; otherwise, . public static bool Equals(StringValues left, string?[]? right) => Equals(left, new StringValues(right)); /// /// Determines whether this instance and a specified string array have the same values. /// /// The string array to compare to this instance. - /// true if the value of is the same as this instance; otherwise, false. + /// if the value of is the same as this instance; otherwise, . public bool Equals(string?[]? other) => Equals(this, new StringValues(other)); /// @@ -628,7 +628,7 @@ public static bool Equals(StringValues left, StringValues right) /// /// The to compare. /// The to compare. - /// true if the value of is different to the value of ; otherwise, false. + /// if the value of is different to the value of ; otherwise, . public static bool operator !=(StringValues left, string? right) => !Equals(left, new StringValues(right)); /// @@ -639,7 +639,7 @@ public static bool Equals(StringValues left, StringValues right) /// /// The to compare. /// The to compare. - /// true if the value of is different to the value of ; otherwise, false. + /// if the value of is different to the value of ; otherwise, . public static bool operator !=(string? left, StringValues right) => !Equals(new StringValues(left), right); /// @@ -650,7 +650,7 @@ public static bool Equals(StringValues left, StringValues right) /// /// The to compare. /// The string array to compare. - /// true if the value of is different to the value of ; otherwise, false. + /// if the value of is different to the value of ; otherwise, . public static bool operator !=(StringValues left, string?[]? right) => !Equals(left, new StringValues(right)); /// @@ -661,7 +661,7 @@ public static bool Equals(StringValues left, StringValues right) /// /// The string array to compare. /// The to compare. - /// true if the value of is different to the value of ; otherwise, false. + /// if the value of is different to the value of ; otherwise, . public static bool operator !=(string?[]? left, StringValues right) => !Equals(new StringValues(left), right); /// @@ -670,7 +670,7 @@ public static bool Equals(StringValues left, StringValues right) /// /// The to compare. /// The to compare. - /// true if the object is equal to the ; otherwise, false. + /// if the object is equal to the ; otherwise, . public static bool operator ==(StringValues left, object? right) => left.Equals(right); /// @@ -679,7 +679,7 @@ public static bool Equals(StringValues left, StringValues right) /// /// The to compare. /// The to compare. - /// true if the object is equal to the ; otherwise, false. + /// if the object is equal to the ; otherwise, . public static bool operator !=(StringValues left, object? right) => !left.Equals(right); /// @@ -688,7 +688,7 @@ public static bool Equals(StringValues left, StringValues right) /// /// The to compare. /// The to compare. - /// true if the object is equal to the ; otherwise, false. + /// if the object is equal to the ; otherwise, . public static bool operator ==(object? left, StringValues right) => right.Equals(left); /// @@ -696,14 +696,14 @@ public static bool Equals(StringValues left, StringValues right) /// /// The to compare. /// The to compare. - /// true if the object is equal to the ; otherwise, false. + /// if the object is equal to the ; otherwise, . public static bool operator !=(object? left, StringValues right) => !right.Equals(left); /// /// Determines whether this instance and a specified object have the same value. /// /// An object to compare with this object. - /// true if the current object is equal to ; otherwise, false. + /// if the current object is equal to ; otherwise, . public override bool Equals(object? obj) { if (obj == null)