From 1eb949f6c3431d2db9806f3fa87d3e901ac5a323 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Sat, 10 Jun 2023 17:01:14 -0700 Subject: [PATCH 1/3] fix up docs --- .../Common/Utilities/SyntaxNodeExtensions.cs | 10 +-- .../ApiLifecycle/Json/JsonObject.cs | 2 +- .../ApiLifecycle/Json/JsonValue.cs | 2 +- .../ApiLifecycle/Json/JsonValueType.cs | 2 +- .../NullableAttributes.cs | 8 +- .../DictionaryExtensions.cs | 4 +- .../GetOrAdd/GetOrAddExtensions.cs | 2 +- .../UnconditionalSuppressMessageAttribute.cs | 2 +- src/LegacySupport/xxH3/XxHash3.cs | 4 +- .../AsyncStateHttpContextExtensions.cs | 2 +- .../ConnectionTimeoutOptions.cs | 6 +- .../CommonHeaders.cs | 2 +- .../HeaderSetup.cs | 4 +- .../HostHeaderValue.cs | 4 +- .../RequestLatencyTelemetryExtensions.cs | 8 +- .../Latency/RequestLatencyTelemetryOptions.cs | 6 +- .../Logging/HttpLoggingServiceExtensions.cs | 6 +- .../Logging/LoggingOptions.cs | 75 ++++++++++------- .../RequestHeadersEnricherExtensions.cs | 6 +- .../RequestHeadersLogEnricher.cs | 2 +- .../Tracing/HttpTracingExtensions.cs | 6 +- .../Tracing/HttpTracingOptions.cs | 12 +-- .../ApplicationMetadata.cs | 8 +- .../ApplicationMetadataExtensions.cs | 12 +-- .../ApplicationMetadataSource.cs | 4 +- .../AsyncStateExtensions.cs | 2 +- .../AsyncStateToken.cs | 6 +- .../IAsyncState.cs | 2 +- .../Classification/DataClassification.cs | 8 +- .../Redaction/IRedactionBuilder.cs | 2 +- .../RedactionAbstractionsExtensions.cs | 10 +-- .../Redaction/Redactor.cs | 10 +-- .../NullRedactorProvider.cs | 2 +- .../RedactionExtensions.cs | 16 ++-- .../RedactionExtensions.xxHash.cs | 4 +- .../XXHash3RedactorOptions.cs | 5 +- .../FakeRedactionCollector.cs | 4 +- .../FakeRedactionExtensions.cs | 20 ++--- .../RedactorRequested.cs | 2 +- .../Abstractions/ExceptionSummary.cs | 4 +- .../ExceptionSummarizationExtensions.cs | 6 +- ...thChecksExtensions.ApplicationLifecycle.cs | 2 +- .../CommonHealthChecksExtensions.Manual.cs | 8 +- ...althChecksExtensions.TelemetryPublisher.cs | 6 +- .../TelemetryHealthCheckPublisherOptions.cs | 9 +- .../ResourceUsageThresholds.cs | 12 +-- ...esourceUtilizationHealthCheckExtensions.cs | 16 ++-- .../ResourceUtilizationHealthCheckOptions.cs | 6 +- ...KubernetesProbesOptions.EndpointOptions.cs | 26 +++--- .../Linux/Internal/LinuxUtilizationParser.cs | 4 +- ...LinuxResourceUtilizationProviderOptions.cs | 8 +- .../Null/NullUtilizationExtensions.cs | 4 +- .../ResourceMonitoringExtensions.cs | 8 +- .../ResourceMonitoringOptions.cs | 17 ++-- .../Windows/Internal/Interop/JobObjectInfo.cs | 4 +- .../Windows/WindowsCountersOptions.cs | 6 +- .../FakeHostOptions.cs | 12 ++- .../HostingFakesExtensions.cs | 8 +- .../HttpClientFaultInjectionExtensions.cs | 6 +- .../HttpFaultInjectionOptionsBuilder.cs | 8 +- .../FaultInjectionEventMeterDimensions.cs | 2 +- .../Internal/IHttpContentOptionsRegistry.cs | 2 +- .../Routing/IRequestRoutingStrategyFactory.cs | 2 +- .../Polly/HttpRetryPolicyOptions.cs | 12 +-- .../HttpClientLatencyTelemetryOptions.cs | 6 +- .../Logging/HttpClientLoggingExtensions.cs | 4 +- .../Logging/LoggingOptions.cs | 52 +++++++----- .../Tracing/HttpClientTracingOptions.cs | 10 ++- .../FaultInjectionExtensions.cs | 14 ++-- .../FaultInjectionOptionsBuilder.cs | 14 ++-- .../IFaultInjectionOptionsProvider.cs | 2 +- .../FaultInjection/InjectedFaultException.cs | 2 +- .../Internals/ExceptionRegistry.cs | 2 +- .../FaultInjectionEventMeterDimensions.cs | 2 +- .../FaultInjectionOptionsProvider.cs | 2 +- .../Options/ChaosPolicyOptionsBase.cs | 6 +- .../Options/ChaosPolicyOptionsGroup.cs | 18 ++-- .../HttpResponseInjectionPolicyOptions.cs | 2 +- .../Polly/Hedging/AsyncHedgingSyntax.cs | 2 +- .../Polly/Internals/PolicyFactory.cs | 2 +- ...olicyFactoryServiceCollectionExtensions.cs | 2 +- .../Polly/Internals/PolicyFactoryUtility.cs | 2 +- .../Polly/Options/BulkheadPolicyOptions.cs | 12 +-- .../Options/CircuitBreakerPolicyOptions.cs | 28 ++++--- .../Polly/Options/HedgingPolicyOptions.cs | 9 +- .../Polly/Options/RetryPolicyOptions.cs | 18 ++-- .../Polly/Options/RetryPolicyOptionsT.cs | 2 +- .../Polly/Options/TimeoutPolicyOptions.cs | 6 +- .../Resilience/IResiliencePipelineProvider.cs | 8 +- .../Internal/IResiliencePipelineFactory.cs | 2 +- .../Internal/OptionsBuilderExtensions.cs | 4 +- .../Resilience/ServiceCollectionExtensions.cs | 2 +- .../Enrichment/EnricherExtensions.cs | 8 +- .../Enrichment/IEnrichmentPropertyBag.cs | 4 +- .../Http/HttpRouteParameterRedactionMode.cs | 6 +- .../Http/RequestMetadata.cs | 2 +- .../Latency/Checkpoint.cs | 6 +- .../Latency/ILatencyContext.cs | 2 +- .../Latency/Measure.cs | 4 +- .../Latency/NullLatencyContextExtensions.cs | 2 +- .../Latency/Registration/CheckpointToken.cs | 2 +- .../ILatencyContextTokenIssuer.cs | 6 +- .../Registration/LatencyRegistryExtensions.cs | 6 +- .../Latency/Registration/MeasureToken.cs | 2 +- .../Latency/Registration/TagToken.cs | 2 +- .../Logging/ILogPropertyCollector.cs | 4 +- .../Logging/LogMethodAttribute.cs | 6 +- .../Logging/LogPropertiesAttribute.cs | 12 +-- .../Metering/MeteringExtensions.cs | 2 +- .../Latency/LarencyConsoleOptions.cs | 12 +-- .../Latency/LatencyConsoleExtensions.cs | 2 +- .../Logging/Internal/LogFormatterOptions.cs | 56 ++++++------- .../Logging/Internal/LogFormatterTheme.cs | 18 ++-- .../Logging/LoggingConsoleOptions.cs | 84 ++++++++++--------- .../Logging/FakeLogCollector.cs | 2 +- .../Logging/FakeLogCollectorOptions.cs | 4 +- .../Logging/FakeLogRecord.cs | 8 +- .../Logging/FakeLogger.cs | 2 +- .../Logging/FakeLoggerExtensions.cs | 2 +- .../Metering/MetricCollector.cs | 2 +- .../ProcessEnricherExtensions.cs | 6 +- .../ProcessLogEnricherOptions.cs | 12 +-- .../ServiceEnricherExtensions.cs | 12 +-- .../ServiceLogEnricherOptions.cs | 24 +++--- .../ServiceMetricEnricherOptions.cs | 24 +++--- .../ServiceTraceEnricherOptions.cs | 24 +++--- .../Latency/LatencyContextOptions.cs | 7 +- .../Logging/LoggingOptions.cs | 31 +++---- .../EventCountersCollectorOptions.cs | 28 ++++--- .../Metering/MeteringOptions.cs | 6 +- .../Exceptions/DatabaseClientException.cs | 4 +- .../Exceptions/DatabaseServerException.cs | 4 +- .../Model/DatabaseOptions.cs | 18 ++-- .../Model/FetchMode.cs | 4 +- .../Model/QueryRequestOptions.cs | 4 +- .../Model/RegionalDatabaseOptions.cs | 6 +- .../Model/RequestOptions.cs | 8 +- .../Model/Throughput.cs | 6 +- .../MessagePostponeFeatureExtensions.cs | 8 +- ...MessageVisibilityDelayFeatureExtensions.cs | 8 +- ...rializedMessagePayloadFeatureExtensions.cs | 8 +- .../Interfaces/IMessageMiddleware.cs | 4 +- .../Interfaces/MessageConsumer.cs | 4 +- .../Abstractions/Interfaces/MessageContext.cs | 10 +-- .../Interfaces/MessageDelegate.cs | 2 +- .../PipelineMessageDelegateStitcher.cs | 2 +- .../Extensions/MessageMiddlewareExtensions.cs | 2 +- ...syncProcessingPipelineBuilderExtensions.cs | 30 +++---- .../Extensions/ServiceCollectionExtensions.cs | 2 +- .../Internal/ConsumerBackgroundService.cs | 2 +- .../LatencyRecorderMiddlewareExtensions.cs | 8 +- .../MessageLatencyContextFeatureExtensions.cs | 4 +- .../ExclusiveRangeAttribute.cs | 2 +- src/Shared/Data.Validation/LengthAttribute.cs | 14 ++-- .../Data.Validation/TimeSpanAttribute.cs | 6 +- .../EmptyCollectionExtensions.cs | 44 +++++----- src/Shared/Text.Formatting/CompositeFormat.cs | 6 +- .../DependencyInjectionExtensions.cs | 4 +- .../StartupInitializationOptions.cs | 6 +- .../SocketsHttpHandlerOptions.cs | 54 ++++++------ 160 files changed, 758 insertions(+), 693 deletions(-) diff --git a/src/Analyzers/Microsoft.Extensions.ExtraAnalyzers/Common/Utilities/SyntaxNodeExtensions.cs b/src/Analyzers/Microsoft.Extensions.ExtraAnalyzers/Common/Utilities/SyntaxNodeExtensions.cs index 7569252ca1c..173bdd35bad 100644 --- a/src/Analyzers/Microsoft.Extensions.ExtraAnalyzers/Common/Utilities/SyntaxNodeExtensions.cs +++ b/src/Analyzers/Microsoft.Extensions.ExtraAnalyzers/Common/Utilities/SyntaxNodeExtensions.cs @@ -16,11 +16,11 @@ namespace Microsoft.Extensions.ExtraAnalyzers.Utilities; internal static class SyntaxNodeExtensions { /// - /// Finds closest ancestor by syntax kind. + /// Finds the closest ancestor by syntax kind. /// - /// Start node. - /// Kind to search by. - /// Found node or null. + /// The start node. + /// The kind to search by. + /// The found node or . public static SyntaxNode? GetFirstAncestorOfSyntaxKind(this SyntaxNode node, SyntaxKind kind) { var n = node.Parent; @@ -98,7 +98,7 @@ public static bool NodeHasSpecifiedMethod( /// The semantic model. /// Expected full method names. /// Root node types. - /// Found invocation node or null. + /// Found invocation node or . public static SyntaxNode? FindNodeInTreeUpToSpecifiedParentByMethodName( this SyntaxNode nodeToStart, SemanticModel semanticModel, diff --git a/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonObject.cs b/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonObject.cs index d45e6c4302f..54bc365173b 100644 --- a/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonObject.cs +++ b/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonObject.cs @@ -48,7 +48,7 @@ public JsonValue this[string key] } /// - /// Adds a key with a null value to this collection. + /// Adds a key with a value to this collection. /// /// The key of the property to be added. /// Returns this JsonObject. diff --git a/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonValue.cs b/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonValue.cs index 20ee492e5f5..93aa01236d5 100644 --- a/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonValue.cs +++ b/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonValue.cs @@ -21,7 +21,7 @@ namespace Microsoft.Extensions.LocalAnalyzers.Json; internal readonly struct JsonValue : IEquatable { /// - /// Represents a null JsonValue. + /// Represents a JsonValue. /// public static readonly JsonValue Null = new(JsonValueType.Null, default, null); private readonly object? _reference; diff --git a/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonValueType.cs b/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonValueType.cs index 6854c2d7597..63d44f14823 100644 --- a/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonValueType.cs +++ b/src/Analyzers/Microsoft.Extensions.LocalAnalyzers/ApiLifecycle/Json/JsonValueType.cs @@ -11,7 +11,7 @@ namespace Microsoft.Extensions.LocalAnalyzers.Json; internal enum JsonValueType { /// - /// A null value. + /// A value. /// Null = 0, diff --git a/src/LegacySupport/DiagnosticAttributes/NullableAttributes.cs b/src/LegacySupport/DiagnosticAttributes/NullableAttributes.cs index bc2a5b684a7..300e0459e05 100644 --- a/src/LegacySupport/DiagnosticAttributes/NullableAttributes.cs +++ b/src/LegacySupport/DiagnosticAttributes/NullableAttributes.cs @@ -55,7 +55,7 @@ internal sealed class MaybeNullWhenAttribute : Attribute { /// Initializes the attribute with the specified return value condition. /// - /// The return value condition. If the method returns this value, the associated parameter may be null. + /// The return value condition. If the method returns this value, the associated parameter may be . /// public MaybeNullWhenAttribute(bool returnValue) => ReturnValue = returnValue; @@ -70,7 +70,7 @@ internal sealed class NotNullWhenAttribute : Attribute { /// Initializes the attribute with the specified return value condition. /// - /// The return value condition. If the method returns this value, the associated parameter will not be null. + /// The return value condition. If the method returns this value, the associated parameter will not be . /// public NotNullWhenAttribute(bool returnValue) => ReturnValue = returnValue; @@ -145,7 +145,7 @@ internal sealed class MemberNotNullWhenAttribute : Attribute { /// Initializes the attribute with the specified return value condition and a field or property member. /// - /// The return value condition. If the method returns this value, the associated parameter will not be null. + /// The return value condition. If the method returns this value, the associated parameter will not be . /// /// /// The field or property member that is promised to be not-null. @@ -158,7 +158,7 @@ public MemberNotNullWhenAttribute(bool returnValue, string member) /// Initializes the attribute with the specified return value condition and list of field and property members. /// - /// The return value condition. If the method returns this value, the associated parameter will not be null. + /// The return value condition. If the method returns this value, the associated parameter will not be . /// /// /// The list of field and property members that are promised to be not-null. diff --git a/src/LegacySupport/DictionaryExtensions/DictionaryExtensions.cs b/src/LegacySupport/DictionaryExtensions/DictionaryExtensions.cs index 6b2cf5cfaee..19ba32b2035 100644 --- a/src/LegacySupport/DictionaryExtensions/DictionaryExtensions.cs +++ b/src/LegacySupport/DictionaryExtensions/DictionaryExtensions.cs @@ -17,9 +17,9 @@ internal static class DictionaryExtensions /// The type of the values in the dictionary. /// The dictionary to operate on. /// The key of the value to query or add. - /// When this method returns true, the removed value; when this method returns false, the default value for TValue. + /// When this method returns true, the removed value; when this method returns false, the default value for . /// true when a value is found in the dictionary with the specified key; false when the dictionary cannot find a value associated with the specified key. - /// If the dictionary or key are . + /// The dictionary or key is . [ExcludeFromCodeCoverage] public static bool Remove(this IDictionary dictionary, TKey key, [MaybeNullWhen(false)] out TValue value) { diff --git a/src/LegacySupport/GetOrAdd/GetOrAddExtensions.cs b/src/LegacySupport/GetOrAdd/GetOrAddExtensions.cs index b495983f022..4181439fba8 100644 --- a/src/LegacySupport/GetOrAdd/GetOrAddExtensions.cs +++ b/src/LegacySupport/GetOrAdd/GetOrAddExtensions.cs @@ -21,7 +21,7 @@ internal static class GetOrAddExtensions /// A function that returns a value to insert into the dictionary if it is not already present. /// The state to pass to the value factory. /// The value for the key. This will be either the existing value for the key if the key is already in the dictionary, or the new value if the key was not in the dictionary. - /// If the dictionary, key, or value factory are . + /// The dictionary, key, or value factory is . [ExcludeFromCodeCoverage] public static TValue GetOrAdd(this ConcurrentDictionary dictionary, TKey key, Func valueFactory, TArg factoryArgument) { diff --git a/src/LegacySupport/TrimAttributes/UnconditionalSuppressMessageAttribute.cs b/src/LegacySupport/TrimAttributes/UnconditionalSuppressMessageAttribute.cs index c9095d2261d..50a66797c10 100644 --- a/src/LegacySupport/TrimAttributes/UnconditionalSuppressMessageAttribute.cs +++ b/src/LegacySupport/TrimAttributes/UnconditionalSuppressMessageAttribute.cs @@ -79,7 +79,7 @@ public UnconditionalSuppressMessageAttribute(string category, string checkId) /// Gets or sets an optional argument expanding on exclusion criteria. /// /// - /// The property is an optional argument that specifies additional + /// The property is an optional argument that specifies additional /// exclusion where the literal metadata target is not sufficiently precise. For example, /// the cannot be applied within a method, /// and it may be desirable to suppress a violation against a statement in the method that will diff --git a/src/LegacySupport/xxH3/XxHash3.cs b/src/LegacySupport/xxH3/XxHash3.cs index 52bf41dd131..90a86367fc3 100644 --- a/src/LegacySupport/xxH3/XxHash3.cs +++ b/src/LegacySupport/xxH3/XxHash3.cs @@ -117,14 +117,14 @@ public XxHash3(long seed) /// Computes the XXH3 hash of the provided data. /// The data to hash. /// The XXH3 64-bit hash code of the provided data. - /// is null. + /// is . public static byte[] Hash(byte[] source) => Hash(source, seed: 0); /// Computes the XXH3 hash of the provided data using the provided seed. /// The data to hash. /// The seed value for this hash computation. /// The XXH3 64-bit hash code of the provided data. - /// is null. + /// is . public static byte[] Hash(byte[] source, long seed) { #if NET6_0_OR_GREATER diff --git a/src/Libraries/Microsoft.AspNetCore.AsyncState/AsyncStateHttpContextExtensions.cs b/src/Libraries/Microsoft.AspNetCore.AsyncState/AsyncStateHttpContextExtensions.cs index dfe79fe290c..c4301e85b23 100644 --- a/src/Libraries/Microsoft.AspNetCore.AsyncState/AsyncStateHttpContextExtensions.cs +++ b/src/Libraries/Microsoft.AspNetCore.AsyncState/AsyncStateHttpContextExtensions.cs @@ -20,7 +20,7 @@ public static class AsyncStateHttpContextExtensions /// /// The to add the service to. /// The value of . - /// If is . + /// is . public static IServiceCollection AddAsyncStateHttpContext(this IServiceCollection services) { _ = Throw.IfNull(services); diff --git a/src/Libraries/Microsoft.AspNetCore.ConnectionTimeout/ConnectionTimeoutOptions.cs b/src/Libraries/Microsoft.AspNetCore.ConnectionTimeout/ConnectionTimeoutOptions.cs index f6333eedd7b..86fc6e285cc 100644 --- a/src/Libraries/Microsoft.AspNetCore.ConnectionTimeout/ConnectionTimeoutOptions.cs +++ b/src/Libraries/Microsoft.AspNetCore.ConnectionTimeout/ConnectionTimeoutOptions.cs @@ -16,9 +16,9 @@ public class ConnectionTimeoutOptions /// /// Gets or sets the time after which a connection will be shut down. /// - /// - /// Default set to 5 minutes. - /// + /// + /// The default value is 5 minutes. + /// [TimeSpan(0, Exclusive = true)] public TimeSpan Timeout { get; set; } = _defaultTimeout; } diff --git a/src/Libraries/Microsoft.AspNetCore.HeaderParsing/CommonHeaders.cs b/src/Libraries/Microsoft.AspNetCore.HeaderParsing/CommonHeaders.cs index 1cf3a99f405..a1f6772123a 100644 --- a/src/Libraries/Microsoft.AspNetCore.HeaderParsing/CommonHeaders.cs +++ b/src/Libraries/Microsoft.AspNetCore.HeaderParsing/CommonHeaders.cs @@ -90,7 +90,7 @@ public static class CommonHeaders public static HeaderSetup Range => new(HeaderNames.Range, RangeHeaderValueParser.Instance); /// - /// Gets Referer header setup. + /// Gets Referrer header setup. /// public static HeaderSetup Referer => new(HeaderNames.Referer, Parsers.UriParser.Instance, cacheable: true); diff --git a/src/Libraries/Microsoft.AspNetCore.HeaderParsing/HeaderSetup.cs b/src/Libraries/Microsoft.AspNetCore.HeaderParsing/HeaderSetup.cs index e8ec2683e23..daf63aaaa04 100644 --- a/src/Libraries/Microsoft.AspNetCore.HeaderParsing/HeaderSetup.cs +++ b/src/Libraries/Microsoft.AspNetCore.HeaderParsing/HeaderSetup.cs @@ -21,13 +21,13 @@ public class HeaderSetup /// /// Gets the type of the parser to parse header values. /// - /// Not null when is and vice versa. + /// Not when is and vice versa. public Type? ParserType { get; } /// /// Gets the parser to parse header values. /// - /// Not null when is and vice versa. + /// Not when is and vice versa. public HeaderParser? ParserInstance { get; } /// diff --git a/src/Libraries/Microsoft.AspNetCore.HeaderParsing/HostHeaderValue.cs b/src/Libraries/Microsoft.AspNetCore.HeaderParsing/HostHeaderValue.cs index 8827129146c..7280efe5e22 100644 --- a/src/Libraries/Microsoft.AspNetCore.HeaderParsing/HostHeaderValue.cs +++ b/src/Libraries/Microsoft.AspNetCore.HeaderParsing/HostHeaderValue.cs @@ -45,7 +45,7 @@ public HostHeaderValue(string host, int? port) /// /// First value. /// Second value. - /// , if its operands are equal, otherwise. + /// if the operands are equal, otherwise. public static bool operator ==(HostHeaderValue left, HostHeaderValue right) { return left.Equals(right); @@ -56,7 +56,7 @@ public HostHeaderValue(string host, int? port) /// /// First value. /// Second value. - /// , if its operands are inequal, otherwise. + /// if the operands are unequal, otherwise. public static bool operator !=(HostHeaderValue left, HostHeaderValue right) { return !(left == right); diff --git a/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Latency/RequestLatencyTelemetryExtensions.cs b/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Latency/RequestLatencyTelemetryExtensions.cs index 7366244eab6..e036cf6cf5f 100644 --- a/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Latency/RequestLatencyTelemetryExtensions.cs +++ b/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Latency/RequestLatencyTelemetryExtensions.cs @@ -24,7 +24,7 @@ public static class RequestLatencyTelemetryExtensions /// /// The to add to. /// Provided service collection with request latency telemetry middleware added. - /// When is . + /// is . public static IServiceCollection AddRequestLatencyTelemetry(this IServiceCollection services) { _ = Throw.IfNull(services); @@ -43,7 +43,7 @@ public static IServiceCollection AddRequestLatencyTelemetry(this IServiceCollect /// The to add to. /// Configuration of . /// Provided service collection with request latency telemetry middleware added. - /// When either or is . + /// Either or is . public static IServiceCollection AddRequestLatencyTelemetry(this IServiceCollection services, Action configure) { _ = Throw.IfNull(services); @@ -61,7 +61,7 @@ public static IServiceCollection AddRequestLatencyTelemetry(this IServiceCollect /// The to add to. /// Configuration of . /// Provided service collection with request latency telemetry middleware added. - /// When either or is . + /// Either or is . [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, type: typeof(RequestLatencyTelemetryOptions))] [UnconditionalSuppressMessage( "Trimming", @@ -83,7 +83,7 @@ public static IServiceCollection AddRequestLatencyTelemetry(this IServiceCollect /// /// The . /// The so that additional calls can be chained. - /// When is . + /// is . public static IApplicationBuilder UseRequestLatencyTelemetry(this IApplicationBuilder builder) { _ = Throw.IfNull(builder); diff --git a/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Latency/RequestLatencyTelemetryOptions.cs b/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Latency/RequestLatencyTelemetryOptions.cs index 67b06f7792e..561e7723e83 100644 --- a/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Latency/RequestLatencyTelemetryOptions.cs +++ b/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Latency/RequestLatencyTelemetryOptions.cs @@ -17,9 +17,9 @@ public class RequestLatencyTelemetryOptions /// /// Gets or sets the amount of time to wait for export of latency data. /// - /// - /// Default set to 5 seconds. - /// + /// + /// The default value is 5 seconds. + /// [TimeSpan(RequestLatencyTelemetryOptionsValidator.MinimumTimeoutInMs)] public TimeSpan LatencyDataExportTimeout { get; set; } = _defaultTimeout; } diff --git a/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/HttpLoggingServiceExtensions.cs b/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/HttpLoggingServiceExtensions.cs index bfa5f65e800..5f9789043b0 100644 --- a/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/HttpLoggingServiceExtensions.cs +++ b/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/HttpLoggingServiceExtensions.cs @@ -27,7 +27,7 @@ public static class HttpLoggingServiceExtensions /// /// The to add the service to. /// The so that additional calls can be chained. - /// The is . + /// is . public static IServiceCollection AddHttpLogging(this IServiceCollection services) { _ = Throw.IfNull(services); @@ -81,7 +81,7 @@ public static IServiceCollection AddHttpLogging(this IServiceCollection services /// Type of enricher. /// The to add the instance of to. /// The so that additional calls can be chained. - /// The is . + /// is . public static IServiceCollection AddHttpLogEnricher(this IServiceCollection services) where T : class, IHttpLogEnricher { @@ -98,7 +98,7 @@ public static IServiceCollection AddHttpLogEnricher(this IServiceCollection s /// /// An application's request pipeline builder. /// The so that additional calls can be chained. - /// The is . + /// is . public static IApplicationBuilder UseHttpLoggingMiddleware(this IApplicationBuilder builder) { _ = Throw.IfNull(builder); diff --git a/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/LoggingOptions.cs b/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/LoggingOptions.cs index 0433145b15d..526ec25985b 100644 --- a/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/LoggingOptions.cs +++ b/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/LoggingOptions.cs @@ -26,30 +26,36 @@ public class LoggingOptions private static readonly TimeSpan _defaultReadTimeout = TimeSpan.FromSeconds(1); /// - /// Gets or sets a value indicating whether request will be logged additionally before any further processing. + /// Gets or sets a value indicating whether the request is logged additionally before any further processing. /// + /// + /// The default value is . + /// /// /// When enabled, two entries will be logged for each incoming request. Note, that the first log record won't be enriched. /// When disabled, only one entry will be logged for each incoming request (with corresponding response's data). - /// Default set to . /// public bool LogRequestStart { get; set; } /// /// Gets or sets a value indicating whether HTTP request and response body will be logged. /// + /// + /// The default value is . + /// /// - /// Please avoid enabling this options in production environment as it might lead to leaking privacy information. - /// Default set to . + /// Avoid enabling this option in a production environment as it might lead to leaking privacy information. /// public bool LogBody { get; set; } /// /// Gets or sets a strategy how request path should be logged. /// + /// + /// The default value is . + /// /// /// Make sure you add redactors to ensure that sensitive information doesn't find its way into your log records. - /// Default set to . /// This option only applies when the /// option is not set to . /// @@ -58,28 +64,30 @@ public class LoggingOptions /// /// Gets or sets a value indicating how request path parameter should be redacted. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// [Experimental] public HttpRouteParameterRedactionMode RequestPathParameterRedactionMode { get; set; } = DefaultPathParameterRedactionMode; /// /// Gets or sets a maximum amount of time to wait for the request body to be read. /// + /// + /// The default value is 1 second. + /// /// /// The number should be above 1 millisecond and below 1 minute. - /// Default set to 1 second. /// [TimeSpan(Millisecond, Minute)] public TimeSpan RequestBodyReadTimeout { get; set; } = _defaultReadTimeout; /// - /// Gets or sets a value indicating the maximum number of bytes of the request/response body to be read. + /// Gets or sets the maximum number of bytes of the request/response body to be read. /// /// - /// The number should ideally be below 85K to not be allocated on the large object heap. - /// Default set to ≈ 32K. + /// The number should ideally be below 85K to not be allocated on the large object heap. + /// The default is set to ≈ 32K. /// [Range(1, MaxBodyReadSize)] public int BodySizeLimit { get; set; } = DefaultBodyReadSizeLimit; @@ -87,8 +95,10 @@ public class LoggingOptions /// /// Gets or sets a map between HTTP path parameters and their data classification. /// + /// + /// The default value is an empty dictionary. + /// /// - /// Default set to an empty dictionary. /// If a parameter within a controller's action is not annotated with a data classification attribute and /// it's not found in this map, it will be redacted as if it was . /// If you don't want a parameter to be redacted, mark it as . @@ -100,10 +110,9 @@ public class LoggingOptions /// /// Gets or sets a map between request headers to be logged and their data classification. /// - /// - /// Default set to an empty dictionary. - /// That means that no request header will be logged by default. - /// + /// + /// The default value is an empty dictionary, which means that no request header is logged by default. + /// [Required] [SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "Options pattern.")] @@ -112,12 +121,13 @@ public class LoggingOptions /// /// Gets or sets the set of request body content types which are considered text and thus possible to log. /// + /// + /// The default value is an empty , which means that the request's body isn't logged. + /// /// - /// Make sure to not enable body logging in production environment, as it will cause - /// both performance impact and leakage of sensitive data. - /// If you need to log body in production, please go through compliance and security. - /// Default set to an empty . - /// That means that request's body will not be logged by default. + /// Don't enable body logging in a production environment, as it might impact + /// performance and leak sensitive data. + /// If you need to log body in production, go through compliance and security. /// /// /// A typical set of known text content-types like json, xml or text would be: @@ -140,10 +150,9 @@ public class LoggingOptions /// /// Gets or sets a map between response headers to be logged and their data classification. /// - /// - /// Default set to an empty dictionary. - /// That means that no response header will be logged by default. - /// + /// + /// The default value is an empty dictionary, which means that no response header is logged by default. + /// [Required] [SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "Options pattern.")] @@ -152,12 +161,12 @@ public class LoggingOptions /// /// Gets or sets the set of response body content types which are considered text and thus possible to log. /// + /// + /// The default value is an empty , which means that the response's body isn't logged. + /// /// - /// Make sure to not enable body logging in production environment, as it will cause - /// both performance impact and leakage of sensitive data. - /// If you need to log body in production, please go through compliance and security. - /// Default set to an empty . - /// That means that response's body will not be logged by default. + /// Don't enable body logging in a production environment, as it might impact performance and leak sensitive data. + /// If you need to log body in production, go through compliance and security. /// /// /// A typical set of known text content-types like json, xml or text would be: @@ -180,10 +189,12 @@ public class LoggingOptions /// /// Gets or sets the set of HTTP paths that should be excluded from logging. /// + /// + /// The default value is an empty . + /// /// /// Any path added to the set will not be logged. /// Paths are case insensitive. - /// Default set to an empty . /// /// /// A typical set of HTTP paths would be: diff --git a/src/Libraries/Microsoft.AspNetCore.Telemetry/Enrichment.RequestHeaders/RequestHeadersEnricherExtensions.cs b/src/Libraries/Microsoft.AspNetCore.Telemetry/Enrichment.RequestHeaders/RequestHeadersEnricherExtensions.cs index 9e98d6dc31d..5e55a98f1c7 100644 --- a/src/Libraries/Microsoft.AspNetCore.Telemetry/Enrichment.RequestHeaders/RequestHeadersEnricherExtensions.cs +++ b/src/Libraries/Microsoft.AspNetCore.Telemetry/Enrichment.RequestHeaders/RequestHeadersEnricherExtensions.cs @@ -21,7 +21,7 @@ public static class RequestHeadersEnricherExtensions /// /// The to add the Request Headers Log Enricher to. /// The so that additional calls can be chained. - /// The is . + /// is . public static IServiceCollection AddRequestHeadersLogEnricher(this IServiceCollection services) { _ = Throw.IfNull(services); @@ -37,7 +37,7 @@ public static IServiceCollection AddRequestHeadersLogEnricher(this IServiceColle /// The to add the Request Headers Log Enricher to. /// The configuration delegate. /// The so that additional calls can be chained. - /// The is . + /// is . public static IServiceCollection AddRequestHeadersLogEnricher(this IServiceCollection services, Action configure) { _ = Throw.IfNull(services); @@ -55,7 +55,7 @@ public static IServiceCollection AddRequestHeadersLogEnricher(this IServiceColle /// The to use for configuring /// in the Request Headers Log Enricher. /// The so that additional calls can be chained. - /// The is . + /// is . [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(RequestHeadersLogEnricherOptions))] [UnconditionalSuppressMessage( "Trimming", diff --git a/src/Libraries/Microsoft.AspNetCore.Telemetry/Enrichment.RequestHeaders/RequestHeadersLogEnricher.cs b/src/Libraries/Microsoft.AspNetCore.Telemetry/Enrichment.RequestHeaders/RequestHeadersLogEnricher.cs index 07eba0631e5..7ea1bea6856 100644 --- a/src/Libraries/Microsoft.AspNetCore.Telemetry/Enrichment.RequestHeaders/RequestHeadersLogEnricher.cs +++ b/src/Libraries/Microsoft.AspNetCore.Telemetry/Enrichment.RequestHeaders/RequestHeadersLogEnricher.cs @@ -26,7 +26,7 @@ internal sealed class RequestHeadersLogEnricher : ILogEnricher /// /// HttpContextAccessor responsible for obtaining properties from HTTP context. /// Options to customize configuration of . - /// RedactorProvidor to get redactor to redact enriched data according to the data class. + /// RedactorProvider to get redactor to redact enriched data according to the data class. public RequestHeadersLogEnricher(IHttpContextAccessor httpContextAccessor, IOptions options, IRedactorProvider? redactorProvider = null) { diff --git a/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingExtensions.cs b/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingExtensions.cs index f3bbf3a225f..0a2eaef5181 100644 --- a/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingExtensions.cs +++ b/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingExtensions.cs @@ -25,7 +25,7 @@ public static class HttpTracingExtensions /// /// The to add the tracing auto collector. /// The so that additional calls can be chained. - /// One of the arguments is . + /// Any of the arguments is . public static TracerProviderBuilder AddHttpTracing(this TracerProviderBuilder builder) { _ = Throw.IfNull(builder); @@ -42,7 +42,7 @@ public static TracerProviderBuilder AddHttpTracing(this TracerProviderBuilder bu /// The to add the tracing auto collector. /// The configuration delegate. /// The so that additional calls can be chained. - /// One of the arguments is . + /// Any of the arguments is . public static TracerProviderBuilder AddHttpTracing(this TracerProviderBuilder builder, Action configure) { _ = Throw.IfNull(builder); @@ -61,7 +61,7 @@ public static TracerProviderBuilder AddHttpTracing(this TracerProviderBuilder bu /// The to add the tracing auto collector. /// Configuration section that contains . /// The so that additional calls can be chained. - /// One of the arguments is . + /// Any of the arguments is . [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(HttpTracingOptions))] [UnconditionalSuppressMessage( "Trimming", diff --git a/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs b/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs index 8f2157b0420..d23128360b6 100644 --- a/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs +++ b/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs @@ -20,8 +20,10 @@ public class HttpTracingOptions /// /// Gets or sets a map between HTTP request parameters and their data classification. /// + /// + /// The default value is . + /// /// - /// Default set to empty . /// If a parameter in requestUrl is not found in this map, it will be redacted as if it was . /// If the parameter will not contain sensitive information and shouldn't be redacted, mark it as . /// @@ -34,17 +36,17 @@ public class HttpTracingOptions /// Gets or sets a value indicating whether to include path with redacted parameters. /// /// - /// When false the exported traces will contain the route template. + /// When false, the exported traces will contain the route template. /// When true, the request path will be recreated using the redacted parameter and included in the exported traces. - /// Default value is false. + /// The default value is false. /// public bool IncludePath { get; set; } /// - /// Gets or sets a value indicating how HTTP path parameter should be redacted. + /// Gets or sets a value indicating how the HTTP path parameter should be redacted. /// /// - /// Default set to . + /// The default is set to . /// It is applicable when option is enabled. /// [Experimental] diff --git a/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadata.cs b/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadata.cs index b5795fb34e5..3b63a0037a2 100644 --- a/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadata.cs +++ b/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadata.cs @@ -11,23 +11,23 @@ namespace Microsoft.Extensions.AmbientMetadata; public class ApplicationMetadata { /// - /// Gets or sets a value that represents the deployment ring from where the application is running. + /// Gets or sets the deployment ring from where the application is running. /// public string? DeploymentRing { get; set; } /// - /// Gets or sets a value that represents the application's build version. + /// Gets or sets the application's build version. /// public string? BuildVersion { get; set; } /// - /// Gets or sets a value that represents the application's name. + /// Gets or sets the application's name. /// [Required] public string ApplicationName { get; set; } = string.Empty; /// - /// Gets or sets a value that represents the application's environment name, such as Development, Staging, Production. + /// Gets or sets the application's environment name, such as Development, Staging, or Production. /// [Required] public string EnvironmentName { get; set; } = string.Empty; diff --git a/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadataExtensions.cs b/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadataExtensions.cs index 0b580e8222a..98e76fd349d 100644 --- a/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadataExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadataExtensions.cs @@ -24,8 +24,8 @@ public static class ApplicationMetadataExtensions /// The host builder. /// Section name to bind configuration from. Default set to "ambientmetadata:application". /// The value of >. - /// If is . - /// If is either , empty or whitespace. + /// is . + /// is either , empty or whitespace. [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(ApplicationMetadata))] [UnconditionalSuppressMessage( "Trimming", @@ -52,8 +52,8 @@ public static IHostBuilder UseApplicationMetadata(this IHostBuilder builder, str /// An instance of . /// Section name to save configuration into. Default set to "ambientmetadata:application". /// The value of >. - /// If or is . - /// If is either , empty or whitespace. + /// or is . + /// is either , empty or whitespace. public static IConfigurationBuilder AddApplicationMetadata(this IConfigurationBuilder builder, IHostEnvironment hostEnvironment, string sectionName = DefaultSectionName) { _ = Throw.IfNull(builder); @@ -69,7 +69,7 @@ public static IConfigurationBuilder AddApplicationMetadata(this IConfigurationBu /// The dependency injection container to add the instance to. /// The configuration section to bind. /// The value of >. - /// If or are . + /// or are . [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(ApplicationMetadata))] [UnconditionalSuppressMessage( "Trimming", @@ -91,7 +91,7 @@ public static IServiceCollection AddApplicationMetadata(this IServiceCollection /// The dependency injection container to add the instance to. /// The delegate to configure with. /// The value of >. - /// If or are . + /// or are . public static IServiceCollection AddApplicationMetadata(this IServiceCollection services, Action configure) { _ = Throw.IfNull(services); diff --git a/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadataSource.cs b/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadataSource.cs index ae6c35b1333..f53dff54ae8 100644 --- a/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadataSource.cs +++ b/src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadataSource.cs @@ -21,8 +21,8 @@ internal sealed class ApplicationMetadataSource : IConfigurationSource /// /// An instance of . /// Section name to be used in configuration. - /// If is . - /// If is either , empty or whitespace. + /// is . + /// is either , empty or whitespace. public ApplicationMetadataSource(IHostEnvironment hostEnvironment, string sectionName) { _hostEnvironment = Throw.IfNull(hostEnvironment); diff --git a/src/Libraries/Microsoft.Extensions.AsyncState/AsyncStateExtensions.cs b/src/Libraries/Microsoft.Extensions.AsyncState/AsyncStateExtensions.cs index 0780ce1d51b..4907cd931bf 100644 --- a/src/Libraries/Microsoft.Extensions.AsyncState/AsyncStateExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.AsyncState/AsyncStateExtensions.cs @@ -37,7 +37,7 @@ public static IServiceCollection AddAsyncStateCore(this IServiceCollection servi /// /// The dependency injection container to remove the implementations from. /// The value of . - /// If is . + /// is . [EditorBrowsable(EditorBrowsableState.Never)] public static IServiceCollection TryRemoveAsyncStateCore(this IServiceCollection services) { diff --git a/src/Libraries/Microsoft.Extensions.AsyncState/AsyncStateToken.cs b/src/Libraries/Microsoft.Extensions.AsyncState/AsyncStateToken.cs index 526bb703215..216e78e37aa 100644 --- a/src/Libraries/Microsoft.Extensions.AsyncState/AsyncStateToken.cs +++ b/src/Libraries/Microsoft.Extensions.AsyncState/AsyncStateToken.cs @@ -6,7 +6,7 @@ namespace Microsoft.Extensions.AsyncState; /// -/// Async state token representing a registered context wihtin the asynchornous state. +/// Async state token representing a registered context within the asynchronous state. /// public readonly struct AsyncStateToken : IEquatable { @@ -21,7 +21,7 @@ internal AsyncStateToken(int index) /// Determines whether the specified object is equal to the current async state token. /// /// The object to compare. - /// If the specified object is identical to the current async state token; otherwise, . + /// if the specified object is identical to the current async state token; otherwise, . public override bool Equals(object? obj) { return obj is AsyncStateToken token && Equals(token); @@ -31,7 +31,7 @@ public override bool Equals(object? obj) /// Determines whether this async state token and a specified async state token are identical. /// /// The other async state token. - /// If the two async state tokens are identical; otherwise, . + /// if the two async state tokens are identical; otherwise, . public bool Equals(AsyncStateToken other) { return Index == other.Index; diff --git a/src/Libraries/Microsoft.Extensions.AsyncState/IAsyncState.cs b/src/Libraries/Microsoft.Extensions.AsyncState/IAsyncState.cs index 228320582aa..960d6672967 100644 --- a/src/Libraries/Microsoft.Extensions.AsyncState/IAsyncState.cs +++ b/src/Libraries/Microsoft.Extensions.AsyncState/IAsyncState.cs @@ -38,7 +38,7 @@ public interface IAsyncState /// Gets the stored async context from the state. /// /// The token representing the state to extract. - /// If the context is not initialized. + /// The context is not initialized. /// The asynchronous state corresponding to the token. object? Get(AsyncStateToken token); diff --git a/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Classification/DataClassification.cs b/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Classification/DataClassification.cs index a484bcd157c..e8adf3e04ac 100644 --- a/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Classification/DataClassification.cs +++ b/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Classification/DataClassification.cs @@ -45,9 +45,9 @@ namespace Microsoft.Extensions.Compliance.Classification; /// /// Initializes a new instance of the struct. /// - /// Name of the taxonomy this classification belongs to. + /// The name of the taxonomy this classification belongs to. /// The taxonomy-specific bit vector representing the data classes. - /// If bit 63, corresponding to is set in the value. + /// Bit 63, which corresponds to , is set in the value. public DataClassification(string taxonomyName, ulong value) { TaxonomyName = Throw.IfNullOrEmpty(taxonomyName); @@ -116,7 +116,7 @@ public override int GetHashCode() /// The first classification to combine. /// The second classification to combine. /// A new classification object representing the combination of the two input classifications. - /// if the two classifications aren't part of the same taxonomy. + /// The two classifications aren't part of the same taxonomy. public static DataClassification Combine(DataClassification left, DataClassification right) { if (string.IsNullOrEmpty(left.TaxonomyName)) @@ -142,7 +142,7 @@ public static DataClassification Combine(DataClassification left, DataClassifica /// The first classification to combine. /// The second classification to combine. /// A new classification object representing the combination of the two input classifications. - /// if the two classifications aren't part of the same taxonomy. + /// The two classifications aren't part of the same taxonomy. [SuppressMessage("Usage", "CA2225:Operator overloads have named alternates", Justification = "It's called Combine")] public static DataClassification operator |(DataClassification left, DataClassification right) { diff --git a/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/IRedactionBuilder.cs b/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/IRedactionBuilder.cs index 59cce31c238..30148f45a15 100644 --- a/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/IRedactionBuilder.cs +++ b/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/IRedactionBuilder.cs @@ -23,7 +23,7 @@ public interface IRedactionBuilder /// Redactor type. /// The data classes for which the redactor type should be used. /// The value of this instance. - /// If is . + /// is . IRedactionBuilder SetRedactor(params DataClassification[] classifications) where T : Redactor; diff --git a/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/RedactionAbstractionsExtensions.cs b/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/RedactionAbstractionsExtensions.cs index f175b26fc12..83caaf98985 100644 --- a/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/RedactionAbstractionsExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/RedactionAbstractionsExtensions.cs @@ -28,9 +28,9 @@ public static class RedactionAbstractionsExtensions /// /// When the is nothing will be appended to the string builder. /// - /// When is . - /// When is . - /// When is . + /// is . + /// is . + /// is . public static StringBuilder AppendRedacted(this StringBuilder stringBuilder, Redactor redactor, string? value) => AppendRedacted(stringBuilder, redactor, value.AsSpan()); @@ -41,8 +41,8 @@ public static StringBuilder AppendRedacted(this StringBuilder stringBuilder, Red /// The redactor that will redact the input value. /// Value to redact. /// Returns the value of . - /// When is . - /// When is . + /// is . + /// is . [SkipLocalsInit] public static StringBuilder AppendRedacted(this StringBuilder stringBuilder, Redactor redactor, ReadOnlySpan value) { diff --git a/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/Redactor.cs b/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/Redactor.cs index d02a8538f17..411f21e9fa8 100644 --- a/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/Redactor.cs +++ b/src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Redaction/Redactor.cs @@ -67,7 +67,7 @@ public string Redact(ReadOnlySpan source) /// Value to redact. /// Buffer to store redacted value. /// Number of characters produced when redacting the given source input. - /// When is too small. + /// is too small. public abstract int Redact(ReadOnlySpan source, Span destination); /// @@ -79,7 +79,7 @@ public string Redact(ReadOnlySpan source) /// Returns 0 when is . /// /// Number of characters written to the buffer. - /// When is too small. + /// is too small. public int Redact(string? source, Span destination) => Redact(source.AsSpan(), destination); /// @@ -90,7 +90,7 @@ public string Redact(ReadOnlySpan source) /// /// Returns an empty string when is . /// - /// When is . + /// is . public virtual string Redact(string? source) => Redact(source.AsSpan()); /// @@ -104,7 +104,7 @@ public string Redact(ReadOnlySpan source) /// /// Format provider to retrieve format for span formattable. /// Redacted value. - /// When is . + /// is . [SkipLocalsInit] [SuppressMessage("Minor Code Smell", "S3247:Duplicate casts should not be made", Justification = "Avoid pattern matching to improve jitted code")] public string Redact(T value, string? format = null, IFormatProvider? provider = null) @@ -156,7 +156,7 @@ public string Redact(T value, string? format = null, IFormatProvider? provide /// /// Format provider to retrieve format for span formattable. /// Number of characters written to the buffer. - /// When is . + /// is . [SkipLocalsInit] [SuppressMessage("Minor Code Smell", "S3247:Duplicate casts should not be made", Justification = "Avoid pattern matching to improve jitted code")] public int Redact(T value, Span destination, string? format = null, IFormatProvider? provider = null) diff --git a/src/Libraries/Microsoft.Extensions.Compliance.Redaction/NullRedactorProvider.cs b/src/Libraries/Microsoft.Extensions.Compliance.Redaction/NullRedactorProvider.cs index e433b95c2d8..0591d0590df 100644 --- a/src/Libraries/Microsoft.Extensions.Compliance.Redaction/NullRedactorProvider.cs +++ b/src/Libraries/Microsoft.Extensions.Compliance.Redaction/NullRedactorProvider.cs @@ -6,7 +6,7 @@ namespace Microsoft.Extensions.Compliance.Redaction; /// -/// A provider that only returns the null redactor implementation used for situations that don't require redaction. +/// A provider that only returns the redactor implementation used for situations that don't require redaction. /// public sealed class NullRedactorProvider : IRedactorProvider { diff --git a/src/Libraries/Microsoft.Extensions.Compliance.Redaction/RedactionExtensions.cs b/src/Libraries/Microsoft.Extensions.Compliance.Redaction/RedactionExtensions.cs index 9d4cd97bd4d..8ba5611c98b 100644 --- a/src/Libraries/Microsoft.Extensions.Compliance.Redaction/RedactionExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Compliance.Redaction/RedactionExtensions.cs @@ -19,7 +19,7 @@ public static partial class RedactionExtensions /// /// instance. /// The value of . - /// When is . + /// is . public static IHostBuilder ConfigureRedaction(this IHostBuilder builder) { _ = Throw.IfNull(builder); @@ -33,8 +33,8 @@ public static IHostBuilder ConfigureRedaction(this IHostBuilder builder) /// instance. /// Configuration for . /// The value of . - /// When is . - /// When is . + /// is . + /// is . public static IHostBuilder ConfigureRedaction( this IHostBuilder builder, Action configure) @@ -51,8 +51,8 @@ public static IHostBuilder ConfigureRedaction( /// instance. /// Configuration for . /// The value of . - /// When is . - /// When is . + /// is . + /// is . public static IHostBuilder ConfigureRedaction(this IHostBuilder builder, Action configure) { _ = Throw.IfNull(builder); @@ -66,7 +66,7 @@ public static IHostBuilder ConfigureRedaction(this IHostBuilder builder, Action< /// /// Instance of used to configure redaction. /// The value of . - /// When is . + /// is . public static IServiceCollection AddRedaction(this IServiceCollection services) { _ = Throw.IfNull(services); @@ -80,8 +80,8 @@ public static IServiceCollection AddRedaction(this IServiceCollection services) /// Instance of used to configure redaction. /// Configuration function for . /// The value of . - /// When is . - /// When is . + /// is . + /// is . public static IServiceCollection AddRedaction(this IServiceCollection services, Action configure) { _ = Throw.IfNull(services); diff --git a/src/Libraries/Microsoft.Extensions.Compliance.Redaction/RedactionExtensions.xxHash.cs b/src/Libraries/Microsoft.Extensions.Compliance.Redaction/RedactionExtensions.xxHash.cs index 7a90578b4f6..0a99a8cc770 100644 --- a/src/Libraries/Microsoft.Extensions.Compliance.Redaction/RedactionExtensions.xxHash.cs +++ b/src/Libraries/Microsoft.Extensions.Compliance.Redaction/RedactionExtensions.xxHash.cs @@ -19,7 +19,7 @@ public static partial class RedactionExtensions /// Configuration function. /// The data classes for which the redactor type should be used. /// The value of . - /// If , or are . + /// , or are . public static IRedactionBuilder SetXXHash3Redactor(this IRedactionBuilder builder, Action configure, params DataClassification[] classifications) { _ = Throw.IfNull(builder); @@ -41,7 +41,7 @@ public static IRedactionBuilder SetXXHash3Redactor(this IRedactionBuilder builde /// Configuration section. /// The data classes for which the redactor type should be used. /// The value of . - /// If , or are . + /// , or are . [DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(XXHash3RedactorOptions))] [UnconditionalSuppressMessage( "Trimming", diff --git a/src/Libraries/Microsoft.Extensions.Compliance.Redaction/XXHash3RedactorOptions.cs b/src/Libraries/Microsoft.Extensions.Compliance.Redaction/XXHash3RedactorOptions.cs index adfb30de21e..8fecb9d5bad 100644 --- a/src/Libraries/Microsoft.Extensions.Compliance.Redaction/XXHash3RedactorOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Compliance.Redaction/XXHash3RedactorOptions.cs @@ -11,12 +11,13 @@ public class XXHash3RedactorOptions /// /// Gets or sets a hash seed used when computing hashes during redaction. /// + /// + /// The default value is 0. + /// /// /// You typically pick a unique value for your application and don't change it afterwards. You'll want a different value for /// different deployment environments in order to prevent identifiers from one environment being redacted to the same /// value across environments. - /// - /// Default set to 0. /// public ulong HashSeed { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Compliance.Testing/FakeRedactionCollector.cs b/src/Libraries/Microsoft.Extensions.Compliance.Testing/FakeRedactionCollector.cs index 2b686268383..79c6037cce9 100644 --- a/src/Libraries/Microsoft.Extensions.Compliance.Testing/FakeRedactionCollector.cs +++ b/src/Libraries/Microsoft.Extensions.Compliance.Testing/FakeRedactionCollector.cs @@ -18,7 +18,7 @@ public class FakeRedactionCollector /// /// Gets the last redactor request "event". /// - /// When there has been no previous redactor request event. + /// There has been no previous redactor request event. public RedactorRequested LastRedactorRequested { get @@ -52,7 +52,7 @@ public IReadOnlyList AllRedactorRequests /// /// Gets the last redaction "event". /// - /// When there has been no previous redaction event. + /// There has been no previous redaction event. public RedactedData LastRedactedData { get diff --git a/src/Libraries/Microsoft.Extensions.Compliance.Testing/FakeRedactionExtensions.cs b/src/Libraries/Microsoft.Extensions.Compliance.Testing/FakeRedactionExtensions.cs index 2b0919860ff..86adf7ffe85 100644 --- a/src/Libraries/Microsoft.Extensions.Compliance.Testing/FakeRedactionExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Compliance.Testing/FakeRedactionExtensions.cs @@ -25,7 +25,7 @@ public static class FakeRedactionExtensions /// The builder to attach the redactorr to. /// The data classes for which the redactor type should be used. /// The value of . - /// When is . + /// is . public static IRedactionBuilder SetFakeRedactor(this IRedactionBuilder builder, params DataClassification[] classifications) { _ = Throw.IfNull(builder); @@ -42,7 +42,7 @@ public static IRedactionBuilder SetFakeRedactor(this IRedactionBuilder builder, /// Configuration function. /// The data classes for which the redactor type should be used. /// The value of . - /// When or are . + /// or are . public static IRedactionBuilder SetFakeRedactor(this IRedactionBuilder builder, Action configure, params DataClassification[] classifications) { _ = Throw.IfNull(builder); @@ -64,7 +64,7 @@ public static IRedactionBuilder SetFakeRedactor(this IRedactionBuilder builder, /// Configuration section. /// The data classes for which the redactor type should be used. /// The value of . - /// When or are . + /// or are . [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = "The type is FakeRedactorOptions and we know it.")] @@ -87,7 +87,7 @@ public static IRedactionBuilder SetFakeRedactor(this IRedactionBuilder builder, /// /// Container used to register fake redaction classes. /// The value of . - /// When is . + /// is . public static IServiceCollection AddFakeRedaction(this IServiceCollection services) { _ = Throw.IfNull(services); @@ -112,7 +112,7 @@ public static IServiceCollection AddFakeRedaction(this IServiceCollection servic /// Container used to register fake redaction classes. /// Configures fake redactor. /// The value of . - /// When or > are . + /// or > are . public static IServiceCollection AddFakeRedaction(this IServiceCollection services, Action configure) { _ = Throw.IfNull(services); @@ -135,12 +135,12 @@ public static IServiceCollection AddFakeRedaction(this IServiceCollection servic } /// - /// Gets the fake redacton collector instance from the dependency injection container. + /// Gets the fake redactor collector instance from the dependency injection container. /// - /// Container used to obtain collector instance. - /// Obtained collector. - /// When collector is not in the container. - /// When is . + /// The container used to obtain the collector instance. + /// The obtained collector. + /// The collector is not in the container. + /// is . /// /// should be registered and used only with fake redaction implementation. /// diff --git a/src/Libraries/Microsoft.Extensions.Compliance.Testing/RedactorRequested.cs b/src/Libraries/Microsoft.Extensions.Compliance.Testing/RedactorRequested.cs index bfb045ae2b9..c123e8e5fff 100644 --- a/src/Libraries/Microsoft.Extensions.Compliance.Testing/RedactorRequested.cs +++ b/src/Libraries/Microsoft.Extensions.Compliance.Testing/RedactorRequested.cs @@ -12,7 +12,7 @@ namespace Microsoft.Extensions.Compliance.Testing; public readonly struct RedactorRequested : IEquatable { /// - /// Gets the the data classification for which the redactor was returned. + /// Gets the data classification for which the redactor was returned. /// public DataClassification DataClassification { get; } diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.ExceptionSummarization/Abstractions/ExceptionSummary.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.ExceptionSummarization/Abstractions/ExceptionSummary.cs index 9ca9550c18c..6040515f476 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.ExceptionSummarization/Abstractions/ExceptionSummary.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.ExceptionSummarization/Abstractions/ExceptionSummary.cs @@ -97,7 +97,7 @@ public bool Equals(ExceptionSummary other) /// /// First value. /// Second value. - /// , if its operands are equal, otherwise. + /// if the operands are equal, otherwise. public static bool operator ==(ExceptionSummary left, ExceptionSummary right) { return left.Equals(right); @@ -108,7 +108,7 @@ public bool Equals(ExceptionSummary other) /// /// First value. /// Second value. - /// , if its operands are equal, otherwise. + /// if the operands are equal, otherwise. public static bool operator !=(ExceptionSummary left, ExceptionSummary right) { return !left.Equals(right); diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.ExceptionSummarization/Implementation/ExceptionSummarizationExtensions.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.ExceptionSummarization/Implementation/ExceptionSummarizationExtensions.cs index dce8faff6f1..48bd90090bc 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.ExceptionSummarization/Implementation/ExceptionSummarizationExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.ExceptionSummarization/Implementation/ExceptionSummarizationExtensions.cs @@ -20,7 +20,7 @@ public static class ExceptionSummarizationExtensions /// /// The dependency injection container to add the summarizer to. /// The value of . - /// If is . + /// is . public static IServiceCollection AddExceptionSummarizer(this IServiceCollection services) { _ = Throw.IfNull(services); @@ -35,7 +35,7 @@ public static IServiceCollection AddExceptionSummarizer(this IServiceCollection /// The dependency injection container to add the summarizer to. /// Delegates that configures the set of registered summary providers. /// The value of . - /// If or are . + /// or are . public static IServiceCollection AddExceptionSummarizer(this IServiceCollection services, Action configure) { _ = Throw.IfNull(services); @@ -52,6 +52,6 @@ public static IServiceCollection AddExceptionSummarizer(this IServiceCollection /// /// The builder to attach the provider to. /// The value of . - /// If is . + /// is . public static IExceptionSummarizationBuilder AddHttpProvider(this IExceptionSummarizationBuilder builder) => Throw.IfNull(builder).AddProvider(); } diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.ApplicationLifecycle.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.ApplicationLifecycle.cs index 89aec5d6439..7dac62e2244 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.ApplicationLifecycle.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.ApplicationLifecycle.cs @@ -29,7 +29,7 @@ public static IHealthChecksBuilder AddApplicationLifecycleHealthCheck(this IHeal /// The builder to add the provider to. /// A list of tags that can be used to filter health checks. /// The value of . - /// If or are . + /// or are . public static IHealthChecksBuilder AddApplicationLifecycleHealthCheck(this IHealthChecksBuilder builder, IEnumerable tags) => Throw.IfNull(builder) .AddCheck("ApplicationLifecycle", tags: Throw.IfNull(tags)); diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.Manual.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.Manual.cs index 4e87ee9690a..2e4666db984 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.Manual.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.Manual.cs @@ -16,7 +16,7 @@ public static partial class CommonHealthChecksExtensions /// The builder to add the provider to. /// A list of tags that can be used to filter health checks. /// The value of . - /// If or are . + /// or are . public static IHealthChecksBuilder AddManualHealthCheck(this IHealthChecksBuilder builder, params string[] tags) => Throw.IfNull(builder) .AddManualHealthCheckDependencies() @@ -28,7 +28,7 @@ public static IHealthChecksBuilder AddManualHealthCheck(this IHealthChecksBuilde /// The builder to add the provider to. /// A list of tags that can be used to filter health checks. /// The value of . - /// If or are . + /// or are . public static IHealthChecksBuilder AddManualHealthCheck(this IHealthChecksBuilder builder, IEnumerable tags) => Throw.IfNull(builder) .AddManualHealthCheckDependencies() @@ -38,7 +38,7 @@ public static IHealthChecksBuilder AddManualHealthCheck(this IHealthChecksBuilde /// Sets the manual health check to the healthy state. /// /// The . - /// If is . + /// is . public static void ReportHealthy(this IManualHealthCheck manualHealthCheck) => Throw.IfNull(manualHealthCheck).Result = HealthCheckResult.Healthy(); @@ -47,7 +47,7 @@ public static void ReportHealthy(this IManualHealthCheck manualHealthCheck) /// /// The . /// The reason why the health check is unhealthy. - /// If is . + /// is . public static void ReportUnhealthy(this IManualHealthCheck manualHealthCheck, string reason) => Throw.IfNull(manualHealthCheck).Result = HealthCheckResult.Unhealthy(Throw.IfNullOrWhitespace(reason)); diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.TelemetryPublisher.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.TelemetryPublisher.cs index f1dc9db7433..ac7cbf8edee 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.TelemetryPublisher.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/CommonHealthChecksExtensions.TelemetryPublisher.cs @@ -17,7 +17,7 @@ public static partial class CommonHealthChecksExtensions /// /// The dependency injection container to add the publisher to. /// The value of . - /// If is . + /// is . public static IServiceCollection AddTelemetryHealthCheckPublisher(this IServiceCollection services) => Throw.IfNull(services) .RegisterMetering() @@ -29,7 +29,7 @@ public static IServiceCollection AddTelemetryHealthCheckPublisher(this IServiceC /// The dependency injection container to add the publisher to. /// Configuration for . /// The value of . - /// If or are . + /// or are . [Experimental] public static IServiceCollection AddTelemetryHealthCheckPublisher(this IServiceCollection services, IConfigurationSection section) => Throw.IfNull(services) @@ -43,7 +43,7 @@ public static IServiceCollection AddTelemetryHealthCheckPublisher(this IServiceC /// The dependency injection container to add the publisher to. /// Configuration for . /// The value of . - /// If or are . + /// or are . [Experimental] public static IServiceCollection AddTelemetryHealthCheckPublisher(this IServiceCollection services, Action configure) => Throw.IfNull(services) diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/TelemetryHealthCheckPublisherOptions.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/TelemetryHealthCheckPublisherOptions.cs index 7a82c5efc2e..bf5d07c5dce 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/TelemetryHealthCheckPublisherOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.Common/TelemetryHealthCheckPublisherOptions.cs @@ -12,10 +12,11 @@ namespace Microsoft.Extensions.Diagnostics.HealthChecks; public class TelemetryHealthCheckPublisherOptions { /// - /// Gets or sets a value indicating whether to log only when unhealthy reports are received. Set to false to always log. + /// Gets or sets a value indicating whether to log only when unhealthy reports are received. /// - /// - /// Default set to false. - /// + /// + /// to only log unhealthy reports; to always log. + /// The default value is . + /// public bool LogOnlyUnhealthy { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUsageThresholds.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUsageThresholds.cs index 0aff091d8ea..a3fc5f3ed76 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUsageThresholds.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUsageThresholds.cs @@ -15,18 +15,18 @@ public class ResourceUsageThresholds /// /// Gets or sets the percentage threshold for the degraded state. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// [Range(0.0, 100.0)] public double? DegradedUtilizationPercentage { get; set; } /// /// Gets or sets the percentage threshold for the unhealthy state. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// [Range(0.0, 100.0)] public double? UnhealthyUtilizationPercentage { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUtilizationHealthCheckExtensions.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUtilizationHealthCheckExtensions.cs index b131402940c..6cd1cfdfb81 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUtilizationHealthCheckExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUtilizationHealthCheckExtensions.cs @@ -24,7 +24,7 @@ public static class ResourceUtilizationHealthCheckExtensions /// The builder to add the provider to. /// A list of tags that can be used to filter health checks. /// The value of . - /// If is . + /// is . public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealthChecksBuilder builder, params string[] tags) { _ = Throw.IfNull(builder); @@ -40,7 +40,7 @@ public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealt /// The builder to add the provider to. /// A list of tags that can be used to filter health checks. /// The value of . - /// If is . + /// is . public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealthChecksBuilder builder, IEnumerable tags) { _ = Throw.IfNull(builder); @@ -56,7 +56,7 @@ public static IHealthChecksBuilder AddResourceUtilizationHealthCheck(this IHealt /// The builder to add the provider to. /// Configuration for . /// The value of . - /// If or are . + /// or are . [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(ResourceUtilizationHealthCheckOptions))] [UnconditionalSuppressMessage( "Trimming", @@ -80,7 +80,7 @@ public static IHealthChecksBuilder AddResourceUtilizationHealthCheck( /// Configuration section holding an instance of . /// A list of tags that can be used to filter health checks. /// The value of . - /// If , or are . + /// , or are . [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(ResourceUtilizationHealthCheckOptions))] [UnconditionalSuppressMessage( "Trimming", @@ -106,7 +106,7 @@ public static IHealthChecksBuilder AddResourceUtilizationHealthCheck( /// Configuration section holding an instance of . /// A list of tags that can be used to filter health checks. /// The value of . - /// If , or are . + /// , or are . [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(ResourceUtilizationHealthCheckOptions))] [UnconditionalSuppressMessage( "Trimming", @@ -131,7 +131,7 @@ public static IHealthChecksBuilder AddResourceUtilizationHealthCheck( /// The builder to add the provider to. /// Configuration callback. /// The value of . - /// If or are . + /// or are . public static IHealthChecksBuilder AddResourceUtilizationHealthCheck( this IHealthChecksBuilder builder, Action configure) @@ -150,7 +150,7 @@ public static IHealthChecksBuilder AddResourceUtilizationHealthCheck( /// Configuration callback. /// A list of tags that can be used to filter health checks. /// The value of . - /// If , or are . + /// , or are . public static IHealthChecksBuilder AddResourceUtilizationHealthCheck( this IHealthChecksBuilder builder, Action configure, @@ -171,7 +171,7 @@ public static IHealthChecksBuilder AddResourceUtilizationHealthCheck( /// Configuration callback. /// A list of tags that can be used to filter health checks. /// The value of . - /// If , or are . + /// , or are . public static IHealthChecksBuilder AddResourceUtilizationHealthCheck( this IHealthChecksBuilder builder, Action configure, diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUtilizationHealthCheckOptions.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUtilizationHealthCheckOptions.cs index 8fcf9e445a6..29afe898c19 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUtilizationHealthCheckOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.HealthChecks.ResourceUtilization/ResourceUtilizationHealthCheckOptions.cs @@ -39,9 +39,9 @@ public class ResourceUtilizationHealthCheckOptions /// /// Gets or sets the time window for used for calculating CPU and memory utilization averages. /// - /// - /// Default set to 5 seconds. - /// + /// + /// The default value is 5 seconds. + /// [TimeSpan(MinimumSamplingWindow, int.MaxValue)] public TimeSpan SamplingWindow { get; set; } = DefaultSamplingWindow; } diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.Probes/Kubernetes/KubernetesProbesOptions.EndpointOptions.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.Probes/Kubernetes/KubernetesProbesOptions.EndpointOptions.cs index 516483221b9..c2846d2cdef 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.Probes/Kubernetes/KubernetesProbesOptions.EndpointOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.Probes/Kubernetes/KubernetesProbesOptions.EndpointOptions.cs @@ -22,38 +22,38 @@ public class EndpointOptions private const int DefaultTcpPort = 2305; /// - /// Gets or sets the TCP port which gets opened if service is healthy and closed otherwise. + /// Gets or sets the TCP port that gets opened if the service is healthy and closed otherwise. /// - /// - /// Default set to 2305. - /// + /// + /// The default value is 2305. + /// [Range(1, 65535)] public int TcpPort { get; set; } = DefaultTcpPort; /// /// Gets or sets the maximum length of the pending connections queue. /// - /// - /// Default set to 10. - /// + /// + /// The default value is 10. + /// [Range(1, 10000)] public int MaxPendingConnections { get; set; } = DefaultMaxPendingConnections; /// /// Gets or sets the interval at which the health of the application is assessed. /// - /// - /// Default set to 30 seconds. - /// + /// + /// The default value is 30 seconds. + /// [TimeSpan("00:00:05", "00:05:00")] public TimeSpan Period { get; set; } = TimeSpan.FromSeconds(30); /// /// Gets or sets a predicate that is used to include health checks based on user-defined criteria. /// - /// - /// Default set to which has the effect of enabling all health checks. - /// + /// + /// The default value is , which has the effect of enabling all health checks. + /// public Func? FilterChecks { get; set; } } } diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Linux/Internal/LinuxUtilizationParser.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Linux/Internal/LinuxUtilizationParser.cs index 728efce5f37..b020fee33de 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Linux/Internal/LinuxUtilizationParser.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Linux/Internal/LinuxUtilizationParser.cs @@ -28,10 +28,10 @@ internal sealed class LinuxUtilizationParser /// /// Stat file contains information about all CPUs and their time. /// - /// + /// /// The file has format of whitespace separated values. Each value has its own meaning and unit. /// To know which value we read, why and what it means refer to proc (5) man page (its POSIX). - /// + /// private static readonly FileInfo _procStat = new("/proc/stat"); /// diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Linux/LinuxResourceUtilizationProviderOptions.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Linux/LinuxResourceUtilizationProviderOptions.cs index a497095e658..2651d3bdc53 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Linux/LinuxResourceUtilizationProviderOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Linux/LinuxResourceUtilizationProviderOptions.cs @@ -18,9 +18,11 @@ public class LinuxResourceUtilizationProviderOptions /// /// Gets or sets the default interval used for refreshing values reported by . /// + /// + /// The default value is 5 seconds. + /// /// /// This is the time interval for a metric value to fetch resource utilization data from the operating system. - /// Default set to 5 seconds. /// [TimeSpan(MinimumCachingInterval, MaximumCachingInterval)] public TimeSpan CpuConsumptionRefreshInterval { get; set; } = DefaultRefreshInterval; @@ -28,9 +30,11 @@ public class LinuxResourceUtilizationProviderOptions /// /// Gets or sets the default interval used for refreshing values reported by . /// + /// + /// The default value is 5 seconds. + /// /// /// This is the time interval for a metric value to fetch resource utilization data from the operating system. - /// Default set to 5 seconds. /// [TimeSpan(MinimumCachingInterval, MaximumCachingInterval)] public TimeSpan MemoryConsumptionRefreshInterval { get; set; } = DefaultRefreshInterval; diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Null/NullUtilizationExtensions.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Null/NullUtilizationExtensions.cs index b695d93e378..d51d4b28bf3 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Null/NullUtilizationExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Null/NullUtilizationExtensions.cs @@ -9,7 +9,7 @@ namespace Microsoft.Extensions.Diagnostics.ResourceMonitoring; /// -/// Extensions for adding the null resource utilization provider. +/// Extensions for adding the resource utilization provider. /// public static class NullUtilizationExtensions { @@ -21,7 +21,7 @@ public static class NullUtilizationExtensions /// This extension method will add a non-operational provider that generates fixed CPU and Memory information. Don't use this in /// production, but you can use it in development environment when you're uncertain about the underlying platform and don't need real data /// to be generated. - /// If is . + /// is . public static IResourceMonitorBuilder AddNullProvider(this IResourceMonitorBuilder builder) { _ = Throw.IfNull(builder); diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/ResourceMonitoringExtensions.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/ResourceMonitoringExtensions.cs index 36a0ca3c75d..57c26f65c98 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/ResourceMonitoringExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/ResourceMonitoringExtensions.cs @@ -24,7 +24,7 @@ public static class ResourceMonitoringExtensions /// The dependency injection container to add the monitor to. /// Delegate to configure . /// The value of . - /// If either or are . + /// Either or is . public static IServiceCollection AddResourceMonitoring( this IServiceCollection services, Action configure) @@ -41,7 +41,7 @@ public static IServiceCollection AddResourceMonitoring( /// The host builder to bind to. /// Delegate to configure . /// The value of . - /// If either or are . + /// Either or is . public static IHostBuilder ConfigureResourceMonitoring( this IHostBuilder builder, Action configure) @@ -60,7 +60,7 @@ public static IHostBuilder ConfigureResourceMonitoring( /// The builder instance used to configure the tracker. /// Delegate to configure . /// The value of . - /// If either or are . + /// Either or is . public static IResourceMonitorBuilder ConfigureMonitor( this IResourceMonitorBuilder builder, Action configure) @@ -77,7 +77,7 @@ public static IResourceMonitorBuilder ConfigureMonitor( /// The builder instance used to configure the tracker. /// The to use for configuring . /// The value of . - /// If either or are . + /// Either or is . [UnconditionalSuppressMessage( "Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/ResourceMonitoringOptions.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/ResourceMonitoringOptions.cs index a09bce70cc7..d6b55d14820 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/ResourceMonitoringOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/ResourceMonitoringOptions.cs @@ -25,26 +25,29 @@ public class ResourceMonitoringOptions /// /// Gets or sets the maximum time window for which utilization can be requested. /// - /// - /// Default set to 5 seconds. - /// + /// + /// The default value is 5 seconds. + /// [TimeSpan(MinimumSamplingWindow, MaximumSamplingWindow)] public TimeSpan CollectionWindow { get; set; } = DefaultCollectionWindow; /// /// Gets or sets the interval at which a new utilization sample is captured. /// - /// - /// Default set to 1 second. - /// + /// + /// The default value is 1 second. + /// [TimeSpan(MinimumSamplingPeriod, MaximumSamplingPeriod)] public TimeSpan SamplingInterval { get; set; } = DefaultSamplingInterval; /// /// Gets or sets the default period used for utilization calculation. /// + /// + /// The default value is 5 seconds. + /// /// - /// Default set to 5 seconds. The value needs to be less than or equal to the . + /// The value needs to be less than or equal to the . /// Most importantly, this period is used to calculate instances pushed to publishers. /// [Experimental] diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Windows/Internal/Interop/JobObjectInfo.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Windows/Internal/Interop/JobObjectInfo.cs index c001d091d08..11afc89d4e6 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Windows/Internal/Interop/JobObjectInfo.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Windows/Internal/Interop/JobObjectInfo.cs @@ -184,8 +184,8 @@ public sealed class SafeJobHandle : SafeHandleZeroOrMinusOneIsInvalid /// /// Validate that the process is inside a JobObject. /// - /// if the process is not running in a job. - /// A boolean to determine if the process is inside a JobObject or not. + /// The process is not running in a job. + /// if the process is inside a JobObject; otherwise, . public static bool IsProcessInJob() { const uint DUPLICATE_SAME_ACCESS = 0x00000002; diff --git a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Windows/WindowsCountersOptions.cs b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Windows/WindowsCountersOptions.cs index e481a0ec3cd..5d90106ce54 100644 --- a/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Windows/WindowsCountersOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Windows/WindowsCountersOptions.cs @@ -30,9 +30,9 @@ public class WindowsCountersOptions /// /// Gets or sets the default interval used for freshing TcpStateInfo Cache. /// - /// - /// Default set to 5 seconds. - /// + /// + /// The default value is 5 seconds. + /// [Experimental] [TimeSpan(MinimumCachingInterval, MaximumCachingInterval)] public TimeSpan CachingInterval { get; set; } = DefaultCachingInterval; diff --git a/src/Libraries/Microsoft.Extensions.Hosting.Testing/FakeHostOptions.cs b/src/Libraries/Microsoft.Extensions.Hosting.Testing/FakeHostOptions.cs index 620ceddc3b8..7c064791630 100644 --- a/src/Libraries/Microsoft.Extensions.Hosting.Testing/FakeHostOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Hosting.Testing/FakeHostOptions.cs @@ -34,9 +34,11 @@ public class FakeHostOptions public TimeSpan TimeToLive { get; set; } = TimeSpan.FromSeconds(30); /// - /// Gets or sets a value indicating whether fake logging would be configured automatically. + /// Gets or sets a value indicating whether fake logging is configured automatically. /// - /// Default is . + /// + /// The default value is . + /// public bool FakeLogging { get; set; } = true; /// @@ -46,8 +48,10 @@ public class FakeHostOptions public bool ValidateOnBuild { get; set; } = true; /// - /// Gets or sets a value indicating whether fake redaction would be configured automatically. + /// Gets or sets a value indicating whether fake redaction is configured automatically. /// - /// Default is . + /// + /// The default value is . + /// public bool FakeRedaction { get; set; } = true; } diff --git a/src/Libraries/Microsoft.Extensions.Hosting.Testing/HostingFakesExtensions.cs b/src/Libraries/Microsoft.Extensions.Hosting.Testing/HostingFakesExtensions.cs index d93ef4b91ab..57234351d7c 100644 --- a/src/Libraries/Microsoft.Extensions.Hosting.Testing/HostingFakesExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Hosting.Testing/HostingFakesExtensions.cs @@ -46,8 +46,8 @@ public static async Task StartAndStopAsync(this IHostedService service, Cancella /// Gets the object that collects log records sent to the fake logger. /// /// An instance. - /// When no collector exists in the provider. - /// The collector which tracks records logged to fake loggers. + /// No collector exists in the provider. + /// The collector that tracks records logged to fake loggers. public static FakeLogCollector GetFakeLogCollector(this IHost host) { _ = Throw.IfNull(host); @@ -58,8 +58,8 @@ public static FakeLogCollector GetFakeLogCollector(this IHost host) /// Gets the object reporting all redactions performed. /// /// An instance. - /// When no collector exists in the provider. - /// The collector which tracks redactions performed on log messages. + /// No collector exists in the provider. + /// The collector that tracks redactions performed on log messages. public static FakeRedactionCollector GetFakeRedactionCollector(this IHost host) { _ = Throw.IfNull(host); diff --git a/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/HttpClientFaultInjectionExtensions.cs b/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/HttpClientFaultInjectionExtensions.cs index f94df64d78c..86764f8e973 100644 --- a/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/HttpClientFaultInjectionExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/HttpClientFaultInjectionExtensions.cs @@ -29,7 +29,7 @@ public static class HttpClientFaultInjectionExtensions /// The so that additional calls can be chained. /// /// - /// All parameters cannot be null. + /// Any parameter is . /// public static IServiceCollection AddHttpClientFaultInjection(this IServiceCollection services) { @@ -50,7 +50,7 @@ public static IServiceCollection AddHttpClientFaultInjection(this IServiceCollec /// The so that additional calls can be chained. /// /// - /// All parameters cannot be null. + /// Any parameter is . /// public static IServiceCollection AddHttpClientFaultInjection(this IServiceCollection services, IConfiguration section) @@ -73,7 +73,7 @@ public static IServiceCollection AddHttpClientFaultInjection(this IServiceCollec /// The so that additional calls can be chained. /// /// - /// All parameters cannot be null. + /// Any parameter is . /// /// /// If the default instance of is used, this method also adds a diff --git a/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/HttpFaultInjectionOptionsBuilder.cs b/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/HttpFaultInjectionOptionsBuilder.cs index 2fbdaa77b87..eb329df34c5 100644 --- a/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/HttpFaultInjectionOptionsBuilder.cs +++ b/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/HttpFaultInjectionOptionsBuilder.cs @@ -51,7 +51,7 @@ public HttpFaultInjectionOptionsBuilder Configure() /// /// The builder object itself so that additional calls can be chained. /// - /// All parameters cannot be null. + /// Any parameter is . /// public HttpFaultInjectionOptionsBuilder Configure(IConfiguration section) { @@ -68,7 +68,7 @@ public HttpFaultInjectionOptionsBuilder Configure(IConfiguration section) /// /// The builder object itself so that additional calls can be chained. /// - /// All parameters cannot be null. + /// Any parameter is . /// public HttpFaultInjectionOptionsBuilder Configure(Action configureOptions) { @@ -83,10 +83,10 @@ public HttpFaultInjectionOptionsBuilder Configure(Action /// The exception instance to be added. /// The builder object itself so that additional calls can be chained. /// - /// The exception cannot be null. + /// is . /// /// - /// The key must not be an empty string or null. + /// is an empty string or . /// public HttpFaultInjectionOptionsBuilder AddException(string key, Exception exception) { diff --git a/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/Internal/FaultInjectionEventMeterDimensions.cs b/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/Internal/FaultInjectionEventMeterDimensions.cs index 73168d5b8f9..ed6ad7964bb 100644 --- a/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/Internal/FaultInjectionEventMeterDimensions.cs +++ b/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/Internal/FaultInjectionEventMeterDimensions.cs @@ -19,7 +19,7 @@ internal static class FaultInjectionEventMeterDimensions public const string FaultType = "FaultType"; /// - /// Value corresponding to injected fault, e.g., NotFonudException, 200ms. + /// Value corresponding to injected fault, for example, NotFoundException, 200ms. /// public const string InjectedValue = "InjectedValue"; diff --git a/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/Internal/IHttpContentOptionsRegistry.cs b/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/Internal/IHttpContentOptionsRegistry.cs index 51bb9c6c7ed..259f3102cdb 100644 --- a/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/Internal/IHttpContentOptionsRegistry.cs +++ b/src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/Internal/IHttpContentOptionsRegistry.cs @@ -18,7 +18,7 @@ internal interface IHttpContentOptionsRegistry /// /// An instance of from the registered /// instance identified by the given key. - /// Returns null if the provided key is null or not found. + /// Returns if the provided key is or not found. /// public HttpContent? GetHttpContent(string key); } diff --git a/src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/Routing/IRequestRoutingStrategyFactory.cs b/src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/Routing/IRequestRoutingStrategyFactory.cs index 54517521e51..91c42cda113 100644 --- a/src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/Routing/IRequestRoutingStrategyFactory.cs +++ b/src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/Routing/IRequestRoutingStrategyFactory.cs @@ -14,7 +14,7 @@ public interface IRequestRoutingStrategyFactory /// /// Creates a new instance of . /// - /// The RequestRoutingStragegy for providing the routes. + /// The RequestRoutingStrategy for providing the routes. [EditorBrowsable(EditorBrowsableState.Never)] IRequestRoutingStrategy CreateRoutingStrategy(); } diff --git a/src/Libraries/Microsoft.Extensions.Http.Resilience/Polly/HttpRetryPolicyOptions.cs b/src/Libraries/Microsoft.Extensions.Http.Resilience/Polly/HttpRetryPolicyOptions.cs index f32c5aa5c67..e6e6ae37756 100644 --- a/src/Libraries/Microsoft.Extensions.Http.Resilience/Polly/HttpRetryPolicyOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Http.Resilience/Polly/HttpRetryPolicyOptions.cs @@ -14,12 +14,14 @@ public class HttpRetryPolicyOptions : RetryPolicyOptions private bool _shouldRetryAfterHeader; /// - /// Gets or sets a value indicating whether should retry after header. + /// Gets or sets a value indicating whether to retry after header. /// + /// + /// The default value is false. + /// /// - /// By default the property is set to false. /// If the property is set to true, then the DelayGenerator will maximize - /// based on the RetryAfter header rules, otherwise it will remain null. + /// based on the RetryAfter header rules, otherwise it will remain . /// public bool ShouldRetryAfterHeader { @@ -35,8 +37,8 @@ public bool ShouldRetryAfterHeader /// Initializes a new instance of the class. /// /// - /// By default the options is set to handle only transient failures, - /// i.e. timeouts, 5xx responses and exceptions. + /// By default, the options are set to handle only transient failures, + /// that is, timeouts, 5xx responses, and exceptions. /// public HttpRetryPolicyOptions() { diff --git a/src/Libraries/Microsoft.Extensions.Http.Telemetry/Latency/HttpClientLatencyTelemetryOptions.cs b/src/Libraries/Microsoft.Extensions.Http.Telemetry/Latency/HttpClientLatencyTelemetryOptions.cs index 8488de6ad78..fcb5b47494c 100644 --- a/src/Libraries/Microsoft.Extensions.Http.Telemetry/Latency/HttpClientLatencyTelemetryOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Http.Telemetry/Latency/HttpClientLatencyTelemetryOptions.cs @@ -13,9 +13,11 @@ public class HttpClientLatencyTelemetryOptions /// /// Gets or sets a value indicating whether to collect detailed latency breakdown of call. /// + /// + /// The default value is . + /// /// - /// Detailed breakdowns add checkpoints for HTTP operations such as connection open, request headers sent etc. - /// Defaults to . + /// Detailed breakdowns add checkpoints for HTTP operations, such as connection open and request headers sent. /// public bool EnableDetailedLatencyBreadkdown { get; set; } = true; } diff --git a/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs b/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs index e1cdedae6e2..64ad5ec45ea 100644 --- a/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs @@ -160,7 +160,7 @@ public static IHttpClientBuilder AddHttpClientLogging(this IHttpClientBuilder bu /// /// An that can be used to configure the client. /// - /// One of the arguments is . + /// Any of the arguments is . [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(LoggingOptions))] [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", @@ -194,7 +194,7 @@ public static IHttpClientBuilder AddHttpClientLogging(this IHttpClientBuilder bu /// /// An that can be used to configure the client. /// - /// One of the arguments is . + /// Any of the arguments is . [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(LoggingOptions))] [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", diff --git a/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/LoggingOptions.cs b/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/LoggingOptions.cs index c369dccdaff..0d44db5149a 100644 --- a/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/LoggingOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/LoggingOptions.cs @@ -24,40 +24,48 @@ public class LoggingOptions private const HttpRouteParameterRedactionMode DefaultPathParameterRedactionMode = HttpRouteParameterRedactionMode.Strict; /// - /// Gets or sets a value indicating whether request will be logged additionally before any further processing. + /// Gets or sets a value indicating whether the request is logged additionally before any further processing. /// + /// + /// The default value is . + /// /// /// When enabled, two entries will be logged for each incoming request - one for request and one for response, if available. - /// When disabled, only one entry will be logged for each incoming request which includes both request and response data. - /// Default set to . + /// When disabled, only one entry will be logged for each incoming request, which includes both request and response data. /// public bool LogRequestStart { get; set; } /// - /// Gets or sets a value indicating whether HTTP request and response body will be logged. + /// Gets or sets a value indicating whether the HTTP request and response body are logged. /// + /// + /// The default value is . + /// /// - /// Please avoid enabling this options in production environment as it might lead to leaking privacy information. - /// Default set to . + /// Avoid enabling this option in a production environment as it might lead to leaking privacy information. /// public bool LogBody { get; set; } /// - /// Gets or sets a value indicating the maximum number of bytes of the request or response body to read. + /// Gets or sets the maximum number of bytes of the request or response body to read. /// + /// + /// The default value is ≈ 32K. + /// /// - /// The number should ideally be below 85K to not be allocated on the large object heap. - /// Default set to ≈ 32K. + /// The number should ideally be below 85K to not be allocated on the large object heap. /// [Range(1, MaxIncomingBodySize)] public int BodySizeLimit { get; set; } = DefaultReadSizeLimit; /// - /// Gets or sets a value indicating the maximum amount of time to wait for the request or response body to be read. + /// Gets or sets the maximum amount of time to wait for the request or response body to be read. /// + /// + /// The default value is 1 second. + /// /// /// The number should be above 1 millisecond and below 1 hour. - /// Default set to 1 second. /// [TimeSpan(Millisecond, Hour)] public TimeSpan BodyReadTimeout { get; set; } = TimeSpan.FromSeconds(1); @@ -81,10 +89,12 @@ public class LoggingOptions /// /// Gets or sets the set of HTTP request headers to log and their respective data classes to use for redaction. /// + /// + /// The default value is . + /// /// /// If empty, no HTTP request headers will be logged. /// If the data class is , no redaction will be done. - /// Default set to . /// [SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "Options pattern.")] @@ -94,10 +104,12 @@ public class LoggingOptions /// /// Gets or sets the set of HTTP response headers to log and their respective data classes to use for redaction. /// + /// + /// The default value is . + /// /// /// If the data class is , no redaction will be done. /// If empty, no HTTP response headers will be logged. - /// Default set to . /// [SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "Options pattern.")] @@ -105,21 +117,23 @@ public class LoggingOptions public IDictionary ResponseHeadersDataClasses { get; set; } = new Dictionary(); /// - /// Gets or sets a value indicating how outgoing HTTP request path should be logged. + /// Gets or sets a value indicating how the outgoing HTTP request path should be logged. /// + /// + /// The default value is . + /// /// - /// Default set to . /// This option is applied only when the option is not set to , - /// otherwise this setting is ignored and unredacted HTTP request path is logged. + /// otherwise this setting is ignored and the unredacted HTTP request path is logged. /// public OutgoingPathLoggingMode RequestPathLoggingMode { get; set; } = DefaultPathLoggingMode; /// /// Gets or sets a value indicating how outgoing HTTP request path parameters should be redacted. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// [Experimental] public HttpRouteParameterRedactionMode RequestPathParameterRedactionMode { get; set; } = DefaultPathParameterRedactionMode; diff --git a/src/Libraries/Microsoft.Extensions.Http.Telemetry/Tracing/HttpClientTracingOptions.cs b/src/Libraries/Microsoft.Extensions.Http.Telemetry/Tracing/HttpClientTracingOptions.cs index a97b5c3c347..ac0e56ff31c 100644 --- a/src/Libraries/Microsoft.Extensions.Http.Telemetry/Tracing/HttpClientTracingOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Http.Telemetry/Tracing/HttpClientTracingOptions.cs @@ -20,17 +20,19 @@ public class HttpClientTracingOptions /// /// Gets or sets a value indicating how HTTP request path parameters should be redacted. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// [Experimental] public HttpRouteParameterRedactionMode RequestPathParameterRedactionMode { get; set; } = DefaultPathParameterRedactionMode; /// /// Gets or sets a map between HTTP request parameters and their data classification. /// + /// + /// The default value is an empty . + /// /// - /// Default set to empty . /// If a parameter within a controller's action is not annotated with a data classification attribute and /// it's not found in this map, it will be redacted as if it was . /// If the parameter will not contain sensitive information and shouldn't be redacted, mark it as . diff --git a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/FaultInjectionExtensions.cs b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/FaultInjectionExtensions.cs index 939e48c26fd..315decc55e3 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/FaultInjectionExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/FaultInjectionExtensions.cs @@ -29,7 +29,7 @@ public static class FaultInjectionExtensions /// The so that additional calls can be chained. /// /// - /// All parameters cannot be null. + /// Any parameter is . /// public static IServiceCollection AddFaultInjection(this IServiceCollection services) { @@ -50,7 +50,7 @@ public static IServiceCollection AddFaultInjection(this IServiceCollection servi /// The so that additional calls can be chained. /// /// - /// All parameters cannot be null. + /// Any parameter is . /// public static IServiceCollection AddFaultInjection(this IServiceCollection services, IConfiguration section) { @@ -71,7 +71,7 @@ public static IServiceCollection AddFaultInjection(this IServiceCollection servi /// The so that additional calls can be chained. /// /// - /// All parameters cannot be null. + /// Any parameter is . /// public static IServiceCollection AddFaultInjection(this IServiceCollection services, Action configure) { @@ -101,7 +101,7 @@ public static IServiceCollection AddFaultInjection(this IServiceCollection servi /// The so that additional calls can be chained. /// /// - /// All parameters must not be null. + /// Any of the parameters are . /// public static Context WithFaultInjection(this Context context, string groupName) { @@ -123,7 +123,7 @@ public static Context WithFaultInjection(this Context context, string groupName) /// The so that additional calls can be chained. /// /// - /// All parameters must not be null. + /// Any of the parameters are . /// [Experimental] public static Context WithFaultInjection(this Context context, FaultPolicyWeightAssignmentsOptions weightAssignments) @@ -143,10 +143,10 @@ public static Context WithFaultInjection(this Context context, FaultPolicyWeight /// /// The context instance. /// - /// The if registered; null if it isn't. + /// The if registered; if it isn't. /// /// - /// All parameters must not be null. + /// Any of the parameters are . /// public static string? GetFaultInjectionGroupName(this Context context) { diff --git a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/FaultInjectionOptionsBuilder.cs b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/FaultInjectionOptionsBuilder.cs index 8136ad636da..eb126f6615f 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/FaultInjectionOptionsBuilder.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/FaultInjectionOptionsBuilder.cs @@ -23,7 +23,7 @@ public class FaultInjectionOptionsBuilder /// /// The services collection. /// - /// All parameters cannot be null. + /// Any parameter is . /// public FaultInjectionOptionsBuilder(IServiceCollection services) { @@ -52,7 +52,7 @@ public FaultInjectionOptionsBuilder Configure() /// /// The builder object itself so that additional calls can be chained. /// - /// All parameters cannot be null. + /// Any parameter is . /// [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(FaultInjectionOptions))] [UnconditionalSuppressMessage( @@ -79,7 +79,7 @@ public FaultInjectionOptionsBuilder Configure(IConfiguration section) /// /// The builder object itself so that additional calls can be chained. /// - /// All parameters cannot be null. + /// Any parameter is . /// public FaultInjectionOptionsBuilder Configure(Action configureOptions) { @@ -99,10 +99,10 @@ public FaultInjectionOptionsBuilder Configure(Action conf /// The exception instance to be added. /// The builder object itself so that additional calls can be chained. /// - /// The exception cannot be null. + /// is . /// /// - /// The key must not be an empty string or null. + /// is an empty string or . /// public FaultInjectionOptionsBuilder AddException(string key, Exception exception) { @@ -121,10 +121,10 @@ public FaultInjectionOptionsBuilder AddException(string key, Exception exception /// The custom result object instance to be added. /// The builder object itself so that additional calls can be chained. /// - /// The exception cannot be null. + /// is . /// /// - /// The key must not be an empty string or null. + /// is an empty string or . /// [Experimental] public FaultInjectionOptionsBuilder AddCustomResult(string key, object customResult) diff --git a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/IFaultInjectionOptionsProvider.cs b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/IFaultInjectionOptionsProvider.cs index 3b6736b63e3..955506200d8 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/IFaultInjectionOptionsProvider.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/IFaultInjectionOptionsProvider.cs @@ -19,7 +19,7 @@ public interface IFaultInjectionOptionsProvider /// /// The chaos policy options group name. /// - /// The associated with the options group name if it is found; otherwise, null. + /// The associated with the options group name if it is found; otherwise, . /// /// /// True if the associated with the options group name if it is found; otherwise, false. diff --git a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/InjectedFaultException.cs b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/InjectedFaultException.cs index 1d9b76d827b..f1a6e90787b 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/InjectedFaultException.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/InjectedFaultException.cs @@ -32,7 +32,7 @@ public InjectedFaultException(string message) /// The error message that explains the reason for the exception. /// /// The exception that is the cause of the current exception, - /// or a null reference (Nothing in Visual Basic) if no inner exception is specified. + /// or a reference (Nothing in Visual Basic) if no inner exception is specified. /// public InjectedFaultException(string message, Exception innerException) : base(message, innerException) diff --git a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/ExceptionRegistry.cs b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/ExceptionRegistry.cs index f9cead2208b..24922273967 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/ExceptionRegistry.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/ExceptionRegistry.cs @@ -21,7 +21,7 @@ internal sealed class ExceptionRegistry : IExceptionRegistry /// The instance to retrieve from. /// /// - /// All parameters must not be null. + /// Any of the parameters are . /// public ExceptionRegistry(IOptionsMonitor options) { diff --git a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/FaultInjectionEventMeterDimensions.cs b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/FaultInjectionEventMeterDimensions.cs index 2681e235e0f..6e342472c31 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/FaultInjectionEventMeterDimensions.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/FaultInjectionEventMeterDimensions.cs @@ -19,7 +19,7 @@ internal static class FaultInjectionEventMeterDimensions public const string FaultType = "FaultType"; /// - /// Value corresponding to injected fault, e.g., NotFonudException, 200ms. + /// Value corresponding to injected fault, for example, NotFoundException, 200ms. /// public const string InjectedValue = "InjectedValue"; } diff --git a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/FaultInjectionOptionsProvider.cs b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/FaultInjectionOptionsProvider.cs index b1223a8d5e7..d0b2cc3761b 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/FaultInjectionOptionsProvider.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Internals/FaultInjectionOptionsProvider.cs @@ -22,7 +22,7 @@ internal sealed class FaultInjectionOptionsProvider : IFaultInjectionOptionsProv /// The options monitor instance to retrieve chaos policy related configurations from. /// /// - /// All parameters must not be null. + /// Any of the parameters are . /// public FaultInjectionOptionsProvider(IOptionsMonitor optionsMonitor) { diff --git a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/ChaosPolicyOptionsBase.cs b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/ChaosPolicyOptionsBase.cs index ec5c2692c6c..9a907f84d30 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/ChaosPolicyOptionsBase.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/ChaosPolicyOptionsBase.cs @@ -24,9 +24,9 @@ protected ChaosPolicyOptionsBase() /// Gets or sets a value indicating whether /// a chaos policy should be enabled or not. /// - /// - /// Default is set to . - /// + /// + /// The default value is . + /// public bool Enabled { get; set; } = DefaultEnabled; /// diff --git a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/ChaosPolicyOptionsGroup.cs b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/ChaosPolicyOptionsGroup.cs index 43e9b53b508..13473760cc1 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/ChaosPolicyOptionsGroup.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/ChaosPolicyOptionsGroup.cs @@ -14,27 +14,27 @@ public class ChaosPolicyOptionsGroup /// /// Gets or sets the latency policy options of the chaos policy options group. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// [ValidateObjectMembers] public LatencyPolicyOptions? LatencyPolicyOptions { get; set; } /// /// Gets or sets the http response injection policy options of the chaos policy options group. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// [ValidateObjectMembers] public HttpResponseInjectionPolicyOptions? HttpResponseInjectionPolicyOptions { get; set; } /// /// Gets or sets the exception policy options of the chaos policy options group. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// [ValidateObjectMembers] public ExceptionPolicyOptions? ExceptionPolicyOptions { get; set; } diff --git a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/HttpResponseInjectionPolicyOptions.cs b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/HttpResponseInjectionPolicyOptions.cs index 44f83912777..b1b616b52db 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/HttpResponseInjectionPolicyOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/FaultInjection/Options/HttpResponseInjectionPolicyOptions.cs @@ -26,7 +26,7 @@ public class HttpResponseInjectionPolicyOptions : ChaosPolicyOptionsBase /// Gets or sets the key to retrieve custom response settings. /// /// - /// This field is optional and it defaults to null. + /// This field is optional and it defaults to . /// public string? HttpContentKey { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Hedging/AsyncHedgingSyntax.cs b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Hedging/AsyncHedgingSyntax.cs index dad1214acee..a7989434809 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Hedging/AsyncHedgingSyntax.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Hedging/AsyncHedgingSyntax.cs @@ -35,7 +35,7 @@ internal static class AsyncHedgingSyntax /// /// The policy instance. /// - /// Arguments cannot be null. + /// Any of the parameters are . public static AsyncHedgingPolicy AsyncHedgingPolicy( this PolicyBuilder policyBuilder, HedgedTaskProvider hedgedTaskProvider, diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactory.cs b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactory.cs index 340be8448ed..660d3287c4d 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactory.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactory.cs @@ -311,7 +311,7 @@ private static void DisposeResult(DelegateResult delegateResul /// /// Validates the options. /// - /// When are not valid. + /// are not valid. private static void ValidateOptions(IValidateOptions validator, TOptions options) where TOptions : class, new() { diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactoryServiceCollectionExtensions.cs b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactoryServiceCollectionExtensions.cs index 493419b31ea..1b9ddb0d437 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactoryServiceCollectionExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactoryServiceCollectionExtensions.cs @@ -21,7 +21,7 @@ internal static class PolicyFactoryServiceCollectionExtensions /// The type of the result returned by the action executed by the policies. /// The DI container. /// The input . - /// cannot be null. + /// is . public static IServiceCollection AddPolicyFactory(this IServiceCollection services) { _ = Throw.IfNull(services); diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactoryUtility.cs b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactoryUtility.cs index 909f56d4ae2..afe8e97a303 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactoryUtility.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Internals/PolicyFactoryUtility.cs @@ -20,7 +20,7 @@ internal sealed class PolicyFactoryUtility /// /// Validates the options. /// - /// When are not valid. + /// are not valid. public static void ValidateOptions(IValidateOptions validator, TOptions options) where TOptions : class, new() { diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/BulkheadPolicyOptions.cs b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/BulkheadPolicyOptions.cs index 7ff7a426a48..1efaf982cdc 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/BulkheadPolicyOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/BulkheadPolicyOptions.cs @@ -20,18 +20,18 @@ public class BulkheadPolicyOptions /// /// Gets or sets the maximum parallelization of executions through the bulkhead. /// - /// - /// Default set to 1000. - /// + /// + /// The default value is 1000. + /// [Range(1, DefaultMaxLimitActions)] public int MaxConcurrency { get; set; } = DefaultMaxConcurrency; /// /// Gets or sets the maximum number of actions that may be queued (waiting to acquire an execution slot) at any one time. /// - /// - /// Default set to 0. - /// + /// + /// The default value is 0. + /// [Range(0, DefaultMaxLimitActions)] public int MaxQueuedActions { get; set; } = DefaultMaxQueuedActions; diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/CircuitBreakerPolicyOptions.cs b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/CircuitBreakerPolicyOptions.cs index c10430c8845..68e8df6ed77 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/CircuitBreakerPolicyOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/CircuitBreakerPolicyOptions.cs @@ -25,10 +25,11 @@ public class CircuitBreakerPolicyOptions /// /// Gets or sets the failure threshold. /// + /// + /// A ratio number higher than 0, up to 1. The default value is 0.1. + /// /// - /// If the ratio (between the number of failed request and total request) exceeds this threshold, the circuit will break. - /// A ratio number higher than 0, up to 1. - /// Default set to 0.1. + /// If the ratio of the number of failed requests to total requests exceeds this threshold, the circuit will break. /// [ExclusiveRange(0, 1.0)] public double FailureThreshold { get; set; } = DefaultFailureThreshold; @@ -36,11 +37,13 @@ public class CircuitBreakerPolicyOptions /// /// Gets or sets the minimum throughput. /// + /// + /// The default value is 100. + /// /// /// This defines how many actions must pass through the circuit in the time-slice, /// for statistics to be considered significant and the circuit-breaker to come into action. - /// Value must be greater than one. - /// Default set to 100. + /// The value must be greater than 1. /// [ExclusiveRange(1, int.MaxValue)] public int MinimumThroughput { get; set; } = DefaultMinimumThroughput; @@ -48,10 +51,11 @@ public class CircuitBreakerPolicyOptions /// /// Gets or sets the duration of break. /// + /// + /// The duration the circuit will stay open before resetting. The default value is 100. + /// /// - /// The duration the circuit will stay open before resetting. - /// Value must be greater than 0.5 seconds. - /// Default set to 5 seconds. + /// The value must be greater than 0.5 seconds. /// [TimeSpan(MinPolicyWaitingMilliseconds, Exclusive = true)] public TimeSpan BreakDuration { get; set; } = _defaultBreakDuration; @@ -59,11 +63,11 @@ public class CircuitBreakerPolicyOptions /// /// Gets or sets the duration of the sampling. /// - /// + /// /// The duration of the time-slice over which failure ratios are assessed. - /// Value must be greater than 0.5 seconds. - /// Default set to 30 seconds. - /// + /// The value must be greater than 0.5 seconds. + /// The default value is 30 seconds. + /// [TimeSpan(MinPolicyWaitingMilliseconds, Exclusive = true)] public TimeSpan SamplingDuration { get; set; } = _defaultSamplingDuration; diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/HedgingPolicyOptions.cs b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/HedgingPolicyOptions.cs index 165271d7ce7..b5e5725df87 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/HedgingPolicyOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/HedgingPolicyOptions.cs @@ -51,12 +51,13 @@ public class HedgingPolicyOptions /// /// Gets or sets the maximum hedged attempts to perform the desired task. /// + /// + /// The number of concurrent hedged tasks that will be triggered by the policy. The default value is 2. + /// /// - /// Default set to 2. - /// The value defines how many concurrent hedged tasks will be triggered by the policy. - /// This includes the primary hedged task that is initially performed, and the further tasks that will + /// This value includes the primary hedged task that is initially performed, and the further tasks that will /// be fetched from the provider and spawned in parallel. - /// The value must be bigger or equal to 2, and lower or equal to 10. + /// The value must be greater than or equal to 2, and less than or equal to 10. /// [Range(MinimumHedgedAttempts, MaximumHedgedAttempts)] public int MaxHedgedAttempts { get; set; } = DefaultMaxHedgedAttempts; diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/RetryPolicyOptions.cs b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/RetryPolicyOptions.cs index 7355f07bbf2..3292c3eab04 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/RetryPolicyOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/RetryPolicyOptions.cs @@ -45,19 +45,21 @@ public class RetryPolicyOptions /// /// Gets or sets the type of the back-off. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public BackoffType BackoffType { get; set; } = DefaultBackoffType; /// - /// Gets or sets the delay between retries based on the backoff type, . + /// Gets or sets the delay between retries based on the backoff type). /// + /// + /// The default value is 2 seconds. + /// /// - /// Default set to 2 seconds. - /// For this represents the median delay to target before the first retry. - /// For the it represents the initial delay, the following delays increasing linearly with this value. - /// In case of it represents the constant delay between retries. + /// For , this property represents the median delay to target before the first retry. + /// For the , this property represents the initial delay. The subsequent delays increase linearly with this value. + /// In case of , this property represents the constant delay between retries. /// [TimeSpan(0, MaxBaseDelay)] public TimeSpan BaseDelay { get; set; } = _defaultBackoffBasedDelay; diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/RetryPolicyOptionsT.cs b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/RetryPolicyOptionsT.cs index 1bc17eeb2da..93f264c0266 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/RetryPolicyOptionsT.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/RetryPolicyOptionsT.cs @@ -49,7 +49,7 @@ public Predicate ShouldHandleResultAsError /// Gets or sets the delegate for customizing delay for the retry policy. /// /// - /// By default this is null and the delay will be calculated based on the backoff type only. + /// By default this is and the delay will be calculated based on the backoff type only. /// public Func, TimeSpan>? RetryDelayGenerator { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/TimeoutPolicyOptions.cs b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/TimeoutPolicyOptions.cs index 33fdf18470f..46de8126abe 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/TimeoutPolicyOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Polly/Options/TimeoutPolicyOptions.cs @@ -21,9 +21,9 @@ public class TimeoutPolicyOptions /// /// Gets or sets the timeout interval. /// - /// - /// Default set to 30 seconds. - /// + /// + /// The default value is 30 seconds. + /// [TimeSpan(0, Exclusive = true)] public TimeSpan TimeoutInterval { get; set; } = _defaultTimeoutInterval; diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Resilience/IResiliencePipelineProvider.cs b/src/Libraries/Microsoft.Extensions.Resilience/Resilience/IResiliencePipelineProvider.cs index 49c3ce6ac7e..6090d7a1488 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Resilience/IResiliencePipelineProvider.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Resilience/IResiliencePipelineProvider.cs @@ -22,11 +22,11 @@ public interface IResiliencePipelineProvider /// A pipeline name. /// The pipeline instance. /// The type of the result returned by the action executed by the policies. - /// The cannot be an empty string. + /// is an empty string. /// The pipeline identified by is invalid or not configured. /// /// Make sure that the pipeline identified by is configured, otherwise the provider won't be able to create - /// it and throws an error. + /// it and throws an exception. /// public IAsyncPolicy GetPipeline(string pipelineName); @@ -36,12 +36,12 @@ public interface IResiliencePipelineProvider /// The pipeline key associated with a cached instance of a pipeline. /// The pipeline instance. /// The type of the result returned by the action executed by the policies. - /// The cannot be an empty string. + /// is an empty string. /// The pipeline identified by is invalid or not configured. /// /// This method enables to have multiple instances of the same pipeline that are cached by the . /// Make sure that the pipeline identified by is configured, otherwise the provider won't be able to create - /// it and throws an error. + /// it and throws an exception. /// public IAsyncPolicy GetPipeline(string pipelineName, string pipelineKey); } diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Resilience/Internal/IResiliencePipelineFactory.cs b/src/Libraries/Microsoft.Extensions.Resilience/Resilience/Internal/IResiliencePipelineFactory.cs index 6705323675c..a108bce7539 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Resilience/Internal/IResiliencePipelineFactory.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Resilience/Internal/IResiliencePipelineFactory.cs @@ -22,7 +22,7 @@ internal interface IResiliencePipelineFactory /// The pipeline name. /// The pipeline key. /// The policy pipeline. - /// The is null or empty string. + /// is or empty string. /// The pipeline identified by is not recognized. IAsyncPolicy CreatePipeline(string pipelineName, string pipelineKey = ""); } diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Resilience/Internal/OptionsBuilderExtensions.cs b/src/Libraries/Microsoft.Extensions.Resilience/Resilience/Internal/OptionsBuilderExtensions.cs index fbff724a045..0bff0195411 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Resilience/Internal/OptionsBuilderExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Resilience/Internal/OptionsBuilderExtensions.cs @@ -21,8 +21,8 @@ internal static class OptionsBuilderExtensions /// /// The options type. /// The options builder instance. - /// The section. This parameter can be null. - /// The configure options action. This parameter can be null. + /// The section. This parameter can be . + /// The configure options action. This parameter can be . /// The builder instance. [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", diff --git a/src/Libraries/Microsoft.Extensions.Resilience/Resilience/ServiceCollectionExtensions.cs b/src/Libraries/Microsoft.Extensions.Resilience/Resilience/ServiceCollectionExtensions.cs index 87722fde423..3232e40b9d3 100644 --- a/src/Libraries/Microsoft.Extensions.Resilience/Resilience/ServiceCollectionExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Resilience/Resilience/ServiceCollectionExtensions.cs @@ -24,7 +24,7 @@ public static class ServiceCollectionExtensions /// The DI container. /// The pipeline name. /// The input . - /// cannot be null. + /// is . public static IResiliencePipelineBuilder AddResiliencePipeline( this IServiceCollection services, string pipelineName) diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Enrichment/EnricherExtensions.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Enrichment/EnricherExtensions.cs index e18123eb464..936adf55559 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Enrichment/EnricherExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Enrichment/EnricherExtensions.cs @@ -18,7 +18,7 @@ public static class EnricherExtensions /// The dependency injection container to add the enricher type to. /// Enricher type. /// The value of . - /// When is . + /// is . public static IServiceCollection AddLogEnricher(this IServiceCollection services) where T : class, ILogEnricher { @@ -33,7 +33,7 @@ public static IServiceCollection AddLogEnricher(this IServiceCollection servi /// The dependency injection container to add the enricher instance to. /// The enricher instance to add. /// The value of . - /// When or are . + /// or are . public static IServiceCollection AddLogEnricher(this IServiceCollection services, ILogEnricher enricher) { _ = Throw.IfNull(services); @@ -48,7 +48,7 @@ public static IServiceCollection AddLogEnricher(this IServiceCollection services /// Enricher type. /// The dependency injection container to add the enricher type to. /// The value of . - /// When is . + /// is . public static IServiceCollection AddMetricEnricher(this IServiceCollection services) where T : class, IMetricEnricher { @@ -63,7 +63,7 @@ public static IServiceCollection AddMetricEnricher(this IServiceCollection se /// The dependency injection container to add the enricher instance to. /// The enricher instance to add. /// The value of . - /// When or are . + /// or are . public static IServiceCollection AddMetricEnricher(this IServiceCollection services, IMetricEnricher enricher) { _ = Throw.IfNull(services); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Enrichment/IEnrichmentPropertyBag.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Enrichment/IEnrichmentPropertyBag.cs index c29b59883a7..0eb5e83617b 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Enrichment/IEnrichmentPropertyBag.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Enrichment/IEnrichmentPropertyBag.cs @@ -17,7 +17,7 @@ public interface IEnrichmentPropertyBag /// /// Enrichment property key. /// Enrichment property value. - /// When is an empty string. + /// is an empty string. /// /// Either or is . /// @@ -54,7 +54,7 @@ public interface IEnrichmentPropertyBag /// /// Enrichment property key. /// Enrichment property value. - /// When is an empty string. + /// is an empty string. /// /// Either or is . /// diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Http/HttpRouteParameterRedactionMode.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Http/HttpRouteParameterRedactionMode.cs index 218d29d1ca8..3f6a2828b71 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Http/HttpRouteParameterRedactionMode.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Http/HttpRouteParameterRedactionMode.cs @@ -12,7 +12,7 @@ public enum HttpRouteParameterRedactionMode /// All parameters are considered as sensitive and are required to be explicitly annotated with a data classification. /// /// - /// UNannotated parameters are always redacted with the erasing redactor. + /// Unannotated parameters are always redacted with the erasing redactor. /// Strict, @@ -20,12 +20,12 @@ public enum HttpRouteParameterRedactionMode /// All parameters are considered as non-sensitive and included as-is by default. /// /// - /// Only parameters explicitly annotaed with a data classification are redacted. + /// Only parameters explicitly annotated with a data classification are redacted. /// Loose, /// - /// Route parameters are not redacted regardless of the presence of data classifcation annotations. + /// Route parameters are not redacted regardless of the presence of data classification annotations. /// None, } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Http/RequestMetadata.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Http/RequestMetadata.cs index 0e9126320e8..d522cb3075f 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Http/RequestMetadata.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Http/RequestMetadata.cs @@ -30,7 +30,7 @@ public RequestMetadata() /// /// The property is initialized to "unknown". /// - /// When any of the parameters are . + /// Any of the parameters are . public RequestMetadata(string methodType, string requestRoute, string requestName = TelemetryConstants.Unknown) { MethodType = Throw.IfNull(methodType); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Checkpoint.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Checkpoint.cs index a2a262224e8..ebc8cbb2bb0 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Checkpoint.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Checkpoint.cs @@ -34,7 +34,7 @@ public Checkpoint(string name, long elapsed, long frequency) public string Name { get; } /// - /// Gets the relative time since the begining of the associated operation at which the checkpoint was created. + /// Gets the relative time since the beginning of the associated operation at which the checkpoint was created. /// public long Elapsed { get; } @@ -70,7 +70,7 @@ public override int GetHashCode() /// /// First value. /// Second value. - /// if its operands are equal, otherwise. + /// if the operands are equal, otherwise. public static bool operator ==(Checkpoint left, Checkpoint right) { return left.Equals(right); @@ -81,7 +81,7 @@ public override int GetHashCode() /// /// First value. /// Second value. - /// if its operands are inequal, otherwise. + /// if the operands are unequal, otherwise. public static bool operator !=(Checkpoint left, Checkpoint right) { return !(left == right); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/ILatencyContext.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/ILatencyContext.cs index a51141d6813..6ef5565a9fa 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/ILatencyContext.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/ILatencyContext.cs @@ -25,7 +25,7 @@ public interface ILatencyContext : IDisposable /// slice and dice the data for analysis. Examples include API, Client, UserType etc. /// Setting a tag with same name overrides its prior value i.e., last call wins. /// - /// When is . + /// is . void SetTag(TagToken token, string value); /// diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Measure.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Measure.cs index d2ac70be9d0..2ab705d5aee 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Measure.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Measure.cs @@ -61,7 +61,7 @@ public Measure(string name, long value) /// /// First value. /// Second value. - /// if its operands are equal, otherwise. + /// if the operands are equal, otherwise. public static bool operator ==(Measure left, Measure right) { return left.Equals(right); @@ -72,7 +72,7 @@ public Measure(string name, long value) /// /// First value. /// Second value. - /// if its operands are inequal, otherwise. + /// if the operands are unequal, otherwise. public static bool operator !=(Measure left, Measure right) { return !(left == right); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/NullLatencyContextExtensions.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/NullLatencyContextExtensions.cs index 3d43a15b91c..3e806f9c79b 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/NullLatencyContextExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/NullLatencyContextExtensions.cs @@ -18,7 +18,7 @@ public static class NullLatencyContextExtensions /// /// The dependency injection container to add the context to. /// The value of . - /// When is . + /// is . public static IServiceCollection AddNullLatencyContext(this IServiceCollection services) { _ = Throw.IfNull(services); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/CheckpointToken.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/CheckpointToken.cs index 45b72a66a23..c0aaa976987 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/CheckpointToken.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/CheckpointToken.cs @@ -28,7 +28,7 @@ public readonly struct CheckpointToken /// /// Name of the checkpoint. /// Position of the token in the token table. - /// When is null. + /// is . public CheckpointToken(string name, int position) { Name = Throw.IfNullOrWhitespace(name); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/ILatencyContextTokenIssuer.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/ILatencyContextTokenIssuer.cs index 716076a232f..bc0fe11a39f 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/ILatencyContextTokenIssuer.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/ILatencyContextTokenIssuer.cs @@ -15,7 +15,7 @@ public interface ILatencyContextTokenIssuer /// /// Name of the tag. /// Token to use with . - /// When is . + /// is . TagToken GetTagToken(string name); /// @@ -23,7 +23,7 @@ public interface ILatencyContextTokenIssuer /// /// Name of the checkpoint. /// Token to use with . - /// When is . + /// is . CheckpointToken GetCheckpointToken(string name); /// @@ -32,6 +32,6 @@ public interface ILatencyContextTokenIssuer /// Name of the measure. /// Token to use with /// and . - /// When is . + /// is . MeasureToken GetMeasureToken(string name); } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/LatencyRegistryExtensions.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/LatencyRegistryExtensions.cs index 85818cdf326..5de36f7f1c9 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/LatencyRegistryExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/LatencyRegistryExtensions.cs @@ -18,7 +18,7 @@ public static class LatencyRegistryExtensions /// The dependency injection container to add the names to. /// Set of checkpoint names. /// The value of . - /// When or are . + /// or are . public static IServiceCollection RegisterCheckpointNames(this IServiceCollection services, params string[] names) { _ = Throw.IfNull(services); @@ -36,7 +36,7 @@ public static IServiceCollection RegisterCheckpointNames(this IServiceCollection /// The dependency injection container to add the names to. /// Set of measure names. /// Provided service collection. - /// When or are . + /// or are . public static IServiceCollection RegisterMeasureNames(this IServiceCollection services, params string[] names) { _ = Throw.IfNull(services); @@ -54,7 +54,7 @@ public static IServiceCollection RegisterMeasureNames(this IServiceCollection se /// The dependency injection container to add the names to. /// Set of tag names. /// Provided service collection. - /// When or are . + /// or are . public static IServiceCollection RegisterTagNames(this IServiceCollection services, params string[] names) { _ = Throw.IfNull(services); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/MeasureToken.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/MeasureToken.cs index d8657c23065..cbc5dd5fc13 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/MeasureToken.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/MeasureToken.cs @@ -28,7 +28,7 @@ public readonly struct MeasureToken /// /// Name of the measure. /// Position of the token in the token table. - /// When is null. + /// is . public MeasureToken(string name, int position) { Name = Throw.IfNullOrWhitespace(name); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/TagToken.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/TagToken.cs index 2b9dbb94404..1fefab91406 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/TagToken.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Latency/Registration/TagToken.cs @@ -28,7 +28,7 @@ public readonly struct TagToken /// /// Name of the tag. /// Position of the token in the token table. - /// When is null. + /// is . public TagToken(string name, int position) { Name = Throw.IfNullOrWhitespace(name); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/ILogPropertyCollector.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/ILogPropertyCollector.cs index a39d40b6d93..bb2d6823f8a 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/ILogPropertyCollector.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/ILogPropertyCollector.cs @@ -18,8 +18,8 @@ public interface ILogPropertyCollector /// /// The name of the property to add. /// The value of the property to add. - /// When is . - /// When is empty or contains exclusively whitespace, + /// is . + /// is empty or contains exclusively whitespace, /// or when a property of the same name has already been added. /// void Add(string propertyName, object? propertyValue); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/LogMethodAttribute.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/LogMethodAttribute.cs index b18ecec7f42..5942a141091 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/LogMethodAttribute.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/LogMethodAttribute.cs @@ -302,13 +302,13 @@ public LogMethodAttribute() /// /// Gets or sets a value indicating whether the generated code should omit the logic to check whether a log level is enabled. /// + /// + /// The default value is if the log method's logging level is Error or Critical; otherwise the default value is . + /// /// /// The generated code contains an optimization to avoid calling into the underlying if the log method's log level /// is currently not enabled. If your application is already performing this check before calling the logging method, then you /// can remove the redundant check performed in the generated code by setting this option to . - /// - /// This defaults to if the log method's logging level is Error or Critical, otherwise it defaults - /// to . /// public bool SkipEnabledCheck { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/LogPropertiesAttribute.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/LogPropertiesAttribute.cs index 946ad39d07b..49e8645e8f2 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/LogPropertiesAttribute.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/LogPropertiesAttribute.cs @@ -21,7 +21,7 @@ public sealed class LogPropertiesAttribute : Attribute /// /// Use this parameterless constructor if you want /// to get a source-generated set of properties to be logged. - /// In case you need to provide your own set of properties or their custom names, please + /// In case you need to provide your own set of properties or their custom names, /// use the constructor overload instead. /// /// @@ -99,18 +99,18 @@ public LogPropertiesAttribute(Type providerType, string providerMethod) public string? ProviderMethod { get; } /// - /// Gets or sets a value indicating whether null properties are logged. + /// Gets or sets a value indicating whether properties are logged. /// - /// + /// /// Defaults to . - /// + /// public bool SkipNullProperties { get; set; } /// /// Gets or sets a value indicating whether to prefix the name of the logging method parameter to the generated name of each property being logged. /// - /// + /// /// Defaults to . - /// + /// public bool OmitParameterName { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Metering/MeteringExtensions.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Metering/MeteringExtensions.cs index 87e705ca2e4..e69dbb13093 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Metering/MeteringExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Metering/MeteringExtensions.cs @@ -13,7 +13,7 @@ namespace Microsoft.Extensions.Telemetry.Metering; public static class MeteringExtensions { /// - /// Registers to a dependency injecion container. + /// Registers to a dependency injection container. /// /// The dependency injection container to register metering into. /// The value of . diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Console/Latency/LarencyConsoleOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Console/Latency/LarencyConsoleOptions.cs index 676cdd0d793..3d02c03ed11 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Console/Latency/LarencyConsoleOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Console/Latency/LarencyConsoleOptions.cs @@ -11,24 +11,24 @@ public class LarencyConsoleOptions /// /// Gets or sets a value indicating whether to emit latency checkpoint information to the console. /// - /// + /// /// Defaults to . - /// + /// public bool OutputCheckpoints { get; set; } = true; /// /// Gets or sets a value indicating whether to emit latency tag information to the console. /// - /// + /// /// Defaults to . - /// + /// public bool OutputTags { get; set; } = true; /// /// Gets or sets a value indicating whether to emit latency measure information to the console. /// - /// + /// /// Defaults to . - /// + /// public bool OutputMeasures { get; set; } = true; } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Console/Latency/LatencyConsoleExtensions.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Console/Latency/LatencyConsoleExtensions.cs index 0683a3c0d79..ade7227d0b3 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Console/Latency/LatencyConsoleExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Console/Latency/LatencyConsoleExtensions.cs @@ -21,7 +21,7 @@ public static class LatencyConsoleExtensions /// /// Dependency injection container. /// Provided service collection with added. - /// When is . + /// is . public static IServiceCollection AddConsoleLatencyDataExporter(this IServiceCollection services) { _ = Throw.IfNull(services); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/Internal/LogFormatterOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/Internal/LogFormatterOptions.cs index a8ba1280dc6..742587d691c 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/Internal/LogFormatterOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/Internal/LogFormatterOptions.cs @@ -23,59 +23,59 @@ public LogFormatterOptions() } /// - /// Gets or sets a value indicating whether to display timestamp. + /// Gets or sets a value indicating whether to display the timestamp. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool IncludeTimestamp { get; set; } = true; /// - /// Gets or sets a value indicating whether to display log level. + /// Gets or sets a value indicating whether to display the log level. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool IncludeLogLevel { get; set; } = true; /// - /// Gets or sets a value indicating whether to display activity TraceId. + /// Gets or sets a value indicating whether to display the activity TraceId. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool IncludeTraceId { get; set; } = true; /// - /// Gets or sets a value indicating whether to display activity SpanId. + /// Gets or sets a value indicating whether to display the activity SpanId. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool IncludeSpanId { get; set; } = true; /// - /// Gets or sets a value indicating whether to display category. + /// Gets or sets a value indicating whether to display the category. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool IncludeCategory { get; set; } = true; /// - /// Gets or sets a value indicating whether to display stack trace. + /// Gets or sets a value indicating whether to display the stack trace. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool IncludeExceptionStacktrace { get; set; } = true; /// - /// Gets or sets a value indicating whether to display dimensions. + /// Gets or sets a value indicating whether to display the dimensions. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool IncludeDimensions { get; set; } } #endif diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/Internal/LogFormatterTheme.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/Internal/LogFormatterTheme.cs index d01676a6158..d7cee334d41 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/Internal/LogFormatterTheme.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/Internal/LogFormatterTheme.cs @@ -13,31 +13,31 @@ internal sealed class LogFormatterTheme /// /// Gets or sets a value indicating whether colors are enabled or not. /// - /// Default is . + /// Default is . public bool ColorsEnabled { get; set; } = true; /// - /// Gets or sets a value indicating what color to use for dimmed text. + /// Gets or sets the color to use for dimmed text. /// - /// Default is . + /// The default value is . public ColorSet Dimmed { get; set; } = Colors.DarkGrayOnNone; /// - /// Gets or sets a value indicating what color to use for exception text. + /// Gets or sets the color to use for exception text. /// - /// Default is . + /// Default is . public ColorSet Exception { get; set; } = Colors.RedOnNone; /// - /// Gets or sets a value indicating what color to use for exception stack trace. + /// Gets or sets the color to use for exception stack trace. /// - /// Default is . + /// Default is . public ColorSet ExceptionStackTrace { get; set; } = Colors.DarkRedOnNone; /// - /// Gets or sets a value indicating what color to use for dimensions. + /// Gets or sets the color to use for dimensions. /// - /// Default is . + /// Default is . public ColorSet Dimensions { get; set; } = Colors.DarkGreenOnNone; } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/LoggingConsoleOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/LoggingConsoleOptions.cs index ccd8bd1a516..e4ccb763c57 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/LoggingConsoleOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Console/Logging/LoggingConsoleOptions.cs @@ -16,128 +16,130 @@ public class LoggingConsoleOptions /// /// Gets or sets a value indicating whether to display scopes. /// - /// + /// /// Defaults to . - /// + /// public bool IncludeScopes { get; set; } = true; /// - /// Gets or sets format string used to format timestamp in logging messages. + /// Gets or sets the format string used to format timestamps in logging messages. /// - /// + /// /// Defaults to yyyy-MM-dd HH:mm:ss.fff. - /// + /// public string? TimestampFormat { get; set; } = "yyyy-MM-dd HH:mm:ss.fff"; /// /// Gets or sets a value indicating whether or not UTC timezone should be used for timestamps in logging messages. /// - /// + /// /// Defaults to . - /// + /// public bool UseUtcTimestamp { get; set; } /// - /// Gets or sets a value indicating whether to display timestamp. + /// Gets or sets a value indicating whether to display the timestamp. /// - /// + /// /// Defaults to . - /// + /// public bool IncludeTimestamp { get; set; } = true; /// - /// Gets or sets a value indicating whether to display log level. + /// Gets or sets a value indicating whether to display the log level. /// - /// + /// /// Defaults to . - /// + /// public bool IncludeLogLevel { get; set; } = true; /// - /// Gets or sets a value indicating whether to display category. + /// Gets or sets a value indicating whether to display the category. /// - /// + /// /// Defaults to . - /// + /// public bool IncludeCategory { get; set; } = true; /// - /// Gets or sets a value indicating whether to display stack trace. + /// Gets or sets a value indicating whether to display the stack trace. /// - /// + /// /// Defaults to . - /// + /// public bool IncludeExceptionStacktrace { get; set; } = true; /// - /// Gets or sets a value indicating whether to display activity TraceId. + /// Gets or sets a value indicating whether to display the activity TraceId. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool IncludeTraceId { get; set; } = true; /// - /// Gets or sets a value indicating whether to display activity SpanId. + /// Gets or sets a value indicating whether to display the activity SpanId. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool IncludeSpanId { get; set; } = true; /// /// Gets or sets a value indicating whether colors are enabled or not. /// - /// Defaults to . + /// + /// Defaults to . + /// public bool ColorsEnabled { get; set; } = true; /// - /// Gets or sets a value indicating what color to use for dimmed text. + /// Gets or sets the color to use for dimmed text. /// - /// Defaults to . + /// Defaults to . public ConsoleColor DimmedColor { get; set; } = ConsoleColor.DarkGray; /// - /// Gets or sets a value indicating what color to use for dimmed text background. + /// Gets or sets the color to use for dimmed text background. /// public ConsoleColor? DimmedBackgroundColor { get; set; } /// - /// Gets or sets a value indicating what color to use for exception text. + /// Gets or sets the color to use for exception text. /// - /// Defaults to . + /// Defaults to . public ConsoleColor ExceptionColor { get; set; } = ConsoleColor.Red; /// - /// Gets or sets a value indicating what color to use for exception text background. + /// Gets or sets the color to use for exception text background. /// public ConsoleColor? ExceptionBackgroundColor { get; set; } /// - /// Gets or sets a value indicating what color to use for exception stack trace text. + /// Gets or sets the color to use for exception stack trace text. /// - /// Defaults to . + /// Defaults to . public ConsoleColor ExceptionStackTraceColor { get; set; } = ConsoleColor.DarkRed; /// - /// Gets or sets a value indicating what color to use for exception stack trace text background. + /// Gets or sets the color to use for exception stack trace text background. /// public ConsoleColor? ExceptionStackTraceBackgroundColor { get; set; } /// /// Gets or sets a value indicating whether to include dimension name/value pairs with each log record. /// - /// Defaults to . + /// Defaults to . public bool IncludeDimensions { get; set; } /// - /// Gets or sets a value indicating what color to use for dimension text. + /// Gets or sets the color to use for dimension text. /// - /// Defaults to . + /// Defaults to . public ConsoleColor DimensionsColor { get; set; } = ConsoleColor.DarkGreen; /// - /// Gets or sets a value indicating what color to use for dimension text background. + /// Gets or sets the color to use for dimension text background. /// public ConsoleColor? DimensionsBackgroundColor { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogCollector.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogCollector.cs index 9abb6c773f3..33d731291c6 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogCollector.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogCollector.cs @@ -81,7 +81,7 @@ public IReadOnlyList GetSnapshot() /// /// The latest log record created. /// - /// When no records have been captured. + /// No records have been captured. public FakeLogRecord LatestRecord { get diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogCollectorOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogCollectorOptions.cs index 25c01cb4b1a..e1e56d85afe 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogCollectorOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogCollectorOptions.cs @@ -35,9 +35,9 @@ public class FakeLogCollectorOptions /// /// Gets or sets a value indicating whether to collect records that are logged when the associated log level is currently disabled. /// - /// + /// /// Defaults to . - /// + /// public bool CollectRecordsForDisabledLogLevels { get; set; } = true; /// diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogRecord.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogRecord.cs index 055fcef040d..533894af852 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogRecord.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogRecord.cs @@ -59,14 +59,12 @@ public FakeLogRecord(LogLevel level, EventId id, object? state, Exception? excep /// Gets the opaque state supplied by the caller when creating the log record as a read-only list. /// /// - /// When logging using the R9 logging model, the arguments you supply to the logging method are packaged into - /// a single state object which is delivered to the + /// When logging using the R9 logging model, the arguments you supply to the logging method are packaged into a single state object which is delivered to the /// method. This state can be retrieved as a set of name/value pairs encoded in a read-only list. /// - /// The object returned by this property is the same as what returns, except it has been cast to a - /// read-only list. + /// The object returned by this property is the same as what returns, except it has been cast to a read-only list. /// - /// If the state object was not generated by the R9 logging model and is not a read-only list. + /// The state object was not generated by the R9 logging model and is not a read-only list. public IReadOnlyList>? StructuredState => (IReadOnlyList>?)State; /// diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogger.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogger.cs index 259f88d8d2c..a13c21cca0e 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogger.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLogger.cs @@ -105,7 +105,7 @@ public void Log(LogLevel logLevel, EventId eventId, TState state, Except /// /// This is a convenience property that merely returns the latest record from the underlying collector. /// - /// When no records have been captured. + /// No records have been captured. public FakeLogRecord LatestRecord => Collector.LatestRecord; /// diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLoggerExtensions.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLoggerExtensions.cs index 1de6eb7ad55..a41238460a7 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLoggerExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Logging/FakeLoggerExtensions.cs @@ -91,7 +91,7 @@ public static ILoggingBuilder AddFakeLogging(this ILoggingBuilder builder, Actio /// Gets the object that collects log records sent to the fake logger. /// /// The service provider containing the logger. - /// When no collector exists in the provider. + /// No collector exists in the provider. /// The collector which tracks records logged to fake loggers. public static FakeLogCollector GetFakeLogCollector(this IServiceProvider services) => services.GetService() ?? throw new InvalidOperationException("No fake log collector registered"); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Metering/MetricCollector.cs b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Metering/MetricCollector.cs index 3432d4d83e3..0a8390a20b5 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Metering/MetricCollector.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry.Testing/Metering/MetricCollector.cs @@ -319,7 +319,7 @@ public void Dispose() } /// - /// Disponse the el. + /// Dispose the el. /// /// Disposing. protected virtual void Dispose(bool disposing) diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Process/ProcessEnricherExtensions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Process/ProcessEnricherExtensions.cs index 1e83b5e6950..4bdbe2879f8 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Process/ProcessEnricherExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Process/ProcessEnricherExtensions.cs @@ -20,7 +20,7 @@ public static class ProcessEnricherExtensions /// /// The to add the process enricher to. /// The so that additional calls can be chained. - /// The is . + /// is . public static IServiceCollection AddProcessLogEnricher(this IServiceCollection services) { _ = Throw.IfNull(services); @@ -35,7 +35,7 @@ public static IServiceCollection AddProcessLogEnricher(this IServiceCollection s /// The to add the process enricher to. /// The configuration delegate. /// The so that additional calls can be chained. - /// One of the arguments is . + /// Any of the arguments is . public static IServiceCollection AddProcessLogEnricher(this IServiceCollection services, Action configure) { _ = Throw.IfNull(services); @@ -52,7 +52,7 @@ public static IServiceCollection AddProcessLogEnricher(this IServiceCollection s /// The to add the process enricher to. /// The to use for configuring in the process enricher. /// The so that additional calls can be chained. - /// One of the arguments is . + /// Any of the arguments is . public static IServiceCollection AddProcessLogEnricher(this IServiceCollection services, IConfigurationSection section) { _ = Throw.IfNull(services); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Process/ProcessLogEnricherOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Process/ProcessLogEnricherOptions.cs index 2cdf3ea9f63..1279042a9e1 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Process/ProcessLogEnricherOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Process/ProcessLogEnricherOptions.cs @@ -11,16 +11,16 @@ public class ProcessLogEnricherOptions /// /// Gets or sets a value indicating whether current process ID is used for log enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool ProcessId { get; set; } = true; /// /// Gets or sets a value indicating whether current thread ID is used for log enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool ThreadId { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceEnricherExtensions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceEnricherExtensions.cs index 630ca1da9fe..9de17701591 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceEnricherExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceEnricherExtensions.cs @@ -36,7 +36,7 @@ public static IServiceCollection AddServiceLogEnricher(this IServiceCollection s /// The to add the service enricher to. /// The configuration delegate. /// The so that additional calls can be chained. - /// One of the arguments is . + /// Any of the arguments is . public static IServiceCollection AddServiceLogEnricher(this IServiceCollection services, Action configure) { _ = Throw.IfNull(services); @@ -53,7 +53,7 @@ public static IServiceCollection AddServiceLogEnricher(this IServiceCollection s /// The to add the service enricher to. /// The to use for configuring in the service enricher. /// The so that additional calls can be chained. - /// One of the arguments is . + /// Any of the arguments is . public static IServiceCollection AddServiceLogEnricher(this IServiceCollection services, IConfigurationSection section) { _ = Throw.IfNull(services); @@ -84,7 +84,7 @@ public static IServiceCollection AddServiceMetricEnricher(this IServiceCollectio /// The to add the service enricher to. /// The configuration delegate. /// The so that additional calls can be chained. - /// One of the arguments is . + /// Any of the arguments is . public static IServiceCollection AddServiceMetricEnricher(this IServiceCollection services, Action configure) { _ = Throw.IfNull(services); @@ -101,7 +101,7 @@ public static IServiceCollection AddServiceMetricEnricher(this IServiceCollectio /// The to add the service enricher to. /// The to use for configuring in the service enricher. /// The so that additional calls can be chained. - /// One of the arguments is . + /// Any of the arguments is . public static IServiceCollection AddServiceMetricEnricher(this IServiceCollection services, IConfigurationSection section) { _ = Throw.IfNull(services); @@ -134,7 +134,7 @@ public static TracerProviderBuilder AddServiceTraceEnricher(this TracerProviderB /// The to add the service trace enricher to. /// The configuration delegate. /// The so that additional calls can be chained. - /// One of the arguments is . + /// Any of the arguments is . public static TracerProviderBuilder AddServiceTraceEnricher(this TracerProviderBuilder builder, Action configure) { _ = Throw.IfNull(builder); @@ -152,7 +152,7 @@ public static TracerProviderBuilder AddServiceTraceEnricher(this TracerProviderB /// The to add the Service trace enricher to. /// The to use for configuring in the Service trace enricher. /// The so that additional calls can be chained. - /// One of the arguments is . + /// Any of the arguments is . public static TracerProviderBuilder AddServiceTraceEnricher(this TracerProviderBuilder builder, IConfigurationSection section) { _ = Throw.IfNull(builder); diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceLogEnricherOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceLogEnricherOptions.cs index 593f8be2d68..e4f1e7b1522 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceLogEnricherOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceLogEnricherOptions.cs @@ -13,32 +13,32 @@ public class ServiceLogEnricherOptions /// /// Gets or sets a value indicating whether is used for logs enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool EnvironmentName { get; set; } = true; /// /// Gets or sets a value indicating whether is used for logs enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool ApplicationName { get; set; } = true; /// /// Gets or sets a value indicating whether is used for logs enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool DeploymentRing { get; set; } /// /// Gets or sets a value indicating whether is used for logs enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool BuildVersion { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceMetricEnricherOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceMetricEnricherOptions.cs index d7c972b2496..f2e3b55cc11 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceMetricEnricherOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceMetricEnricherOptions.cs @@ -13,32 +13,32 @@ public class ServiceMetricEnricherOptions /// /// Gets or sets a value indicating whether is used for metric enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool EnvironmentName { get; set; } = true; /// /// Gets or sets a value indicating whether is used for metric enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool ApplicationName { get; set; } = true; /// /// Gets or sets a value indicating whether is used for metric enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool DeploymentRing { get; set; } /// /// Gets or sets a value indicating whether is used for metric enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool BuildVersion { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceTraceEnricherOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceTraceEnricherOptions.cs index 0d241ccddc0..2097e8a8744 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceTraceEnricherOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry/Enrichment.Service/ServiceTraceEnricherOptions.cs @@ -13,32 +13,32 @@ public class ServiceTraceEnricherOptions /// /// Gets or sets a value indicating whether is used for trace enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool EnvironmentName { get; set; } = true; /// /// Gets or sets a value indicating whether is used for trace enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool ApplicationName { get; set; } = true; /// /// Gets or sets a value indicating whether is used for trace enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool DeploymentRing { get; set; } /// /// Gets or sets a value indicating whether is used for trace enrichment. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool BuildVersion { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Latency/LatencyContextOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Latency/LatencyContextOptions.cs index 1e3966649c3..60fff2468f6 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry/Latency/LatencyContextOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry/Latency/LatencyContextOptions.cs @@ -9,9 +9,10 @@ namespace Microsoft.Extensions.Telemetry.Latency; public class LatencyContextOptions { /// - /// Gets or sets a value indicating whether exception is thrown when using unregistered names. + /// Gets or sets a value indicating whether an exception is thrown when using unregistered names. /// - /// The ILatencyContext APIs throws when using unregistred names if true. - /// Becomes no-op otherwise. Defaults to false. + /// + /// if the ILatencyContext APIs throws when using unregistered names. to no-op. The default value is . + /// public bool ThrowOnUnregisteredNames { get; set; } } diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Logging/LoggingOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Logging/LoggingOptions.cs index c301fef1002..1188d2f7e11 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry/Logging/LoggingOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry/Logging/LoggingOptions.cs @@ -19,42 +19,45 @@ public class LoggingOptions /// Gets or sets a value indicating whether to include log scopes in /// captured log state. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public bool IncludeScopes { get; set; } /// /// Gets or sets a value indicating whether to format the message included in captured log state. /// + /// + /// The default value is . + /// /// - /// When set to the placeholders in the message will be replaced by the actual values + /// When set to the placeholders in the message will be replaced by the actual values, /// otherwise the message template will be included as-is without replacements. - /// - /// Default set to . /// public bool UseFormattedMessage { get; set; } /// /// Gets or sets a value indicating whether to include stack trace when exception is logged. /// + /// + /// The default value is . + /// /// /// When set to and exceptions are logged, the logger will add exception stack trace - /// with inner exception as a separate key-value pair with key 'stackTrace'. The max length of the column + /// with inner exception as a separate key-value pair with key 'stackTrace'. The maximum length of the column /// defaults to 4096 characters and can be modified by setting the property. - /// Stack trace beyond the current limit will be truncated. - /// - /// Default set to . + /// The stack trace beyond the current limit will be truncated. /// public bool IncludeStackTrace { get; set; } /// - /// Gets or sets a value indicating maximum stack trace length configured by the user. + /// Gets or sets the maximum stack trace length configured by the user. /// + /// + /// The default value is 4096. + /// /// - /// When set to a value less than 2kb or greater than 32kb, an exception will be thrown. - /// - /// Default set to 4096. + /// When set to a value less than 2 KB or greater than 32 KB, an exception will be thrown. /// [Experimental] [Range(MinDefinedStackTraceLength, MaxDefinedStackTraceLength, ErrorMessage = "Maximum stack trace length should be between 2kb and 32kb")] diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Metering.Collectors.EventCounters/EventCountersCollectorOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Metering.Collectors.EventCounters/EventCountersCollectorOptions.cs index d01a645ebc1..2bb199698a3 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry/Metering.Collectors.EventCounters/EventCountersCollectorOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry/Metering.Collectors.EventCounters/EventCountersCollectorOptions.cs @@ -28,11 +28,13 @@ public class EventCountersCollectorOptions /// /// Gets or sets a list of EventSources and CounterNames to listen for. /// + /// + /// The default value is an empty dictionary. + /// /// /// It is a dictionary of EventSource to the set of counters that needs to be collected from the event source. - /// Please visit + /// See /// for well known event counters and their availability. - /// Default set to an empty dictionary. /// [Required] #pragma warning disable CA2227 // Collection properties should be read only @@ -45,20 +47,22 @@ public class EventCountersCollectorOptions /// /// Gets or sets a sampling interval for counters. /// - /// - /// Default set to 1 second. - /// + /// + /// The default value is 1 second. + /// [TimeSpan("00:00:01", "00:10:00")] public TimeSpan SamplingInterval { get; set; } = _defaultSamplingInterval; /// /// Gets or sets a value indicating whether to include recommended default counters. /// + /// + /// The default value is . If is empty, the default value is so the + /// default recommended counters are included when the listener is created. + /// /// /// Includes the recommended default event counters in addition to the counters specified in . - /// Default set to false. However, if is empty, it is set to true so - /// default recommended counters are included when the listener is created. - /// Please see the list of recommended default counters in . + /// See the list of recommended default counters in . /// EventSource: "System.Runtime", Counters: /// - "cpu-usage", "working-set", "time-in-gc", "alloc-rate", "exception-count", "gen-2-gc-count", "gen-2-size", /// - "monitor-lock-contention-count", "active-timer-count", "threadpool-queue-length", "threadpool-thread-count", @@ -72,10 +76,12 @@ public class EventCountersCollectorOptions /// /// Gets or sets the interval at which to recycle the . /// + /// + /// The default value is 1 hour. + /// /// - /// This is a work-around for this issue. - /// Default set to 1 hour. - /// This only has an effect on .NET 5, it is ignored for .NET 6 and above. + /// This property is a work-around for dotnet/runtime issue 43985. + /// It only has an effect on .NET 5, and is ignored for .NET 6 and later versions. /// // The property is intended to be used on .NET 5 only, we ship it for newer TFMs to resolve package compositional issues. Refer to discussion for details: // https://domoreexp.visualstudio.com/R9/_git/SDK/pullrequest/552703?_a=files&path=/src/Extensions/Metering.Collectors.EventCounters/EventCountersCollectorOptions.cs&discussionId=9983912 diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Metering/MeteringOptions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Metering/MeteringOptions.cs index c78b3f76ff0..76b4234fd6f 100644 --- a/src/Libraries/Microsoft.Extensions.Telemetry/Metering/MeteringOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Telemetry/Metering/MeteringOptions.cs @@ -31,9 +31,9 @@ public class MeteringOptions /// /// Gets or sets default meter state to be used for emitting metrics. /// - /// - /// Default set to . - /// + /// + /// The default value is . + /// public MeteringState MeterState { get; set; } = MeteringState.Enabled; /// diff --git a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Exceptions/DatabaseClientException.cs b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Exceptions/DatabaseClientException.cs index 5bffb5912a8..1fcdbba0ccf 100644 --- a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Exceptions/DatabaseClientException.cs +++ b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Exceptions/DatabaseClientException.cs @@ -6,10 +6,10 @@ namespace System.Cloud.DocumentDb; /// -/// Exception represent the operation is failed w/ a specific reason and should not retry. +/// The exception that's thrown when the operation failed with a specific reason and should not retry. /// /// -/// Please check the log and eliminate this kind of requests. +/// Check the log and eliminate this kind of request. /// Http code 400, 401, 403, 413. /// Covered codes may vary on specific engine requirements. /// diff --git a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Exceptions/DatabaseServerException.cs b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Exceptions/DatabaseServerException.cs index 20ebdfb6031..8982ddc9670 100644 --- a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Exceptions/DatabaseServerException.cs +++ b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Exceptions/DatabaseServerException.cs @@ -6,11 +6,11 @@ namespace System.Cloud.DocumentDb; /// -/// Exception represent the operation is failed w/o a specific reason. +/// The exception that's thrown when the operation failed without a specific reason. /// /// /// It might due to some failures on server side. -/// Please ask engineer to investigate on this case and escalate if necessary. +/// Ask the engineer to investigate this case and escalate if necessary. /// Http code 500. /// public class DatabaseServerException : DatabaseException diff --git a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/DatabaseOptions.cs b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/DatabaseOptions.cs index 89cc4387591..c79190769b2 100644 --- a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/DatabaseOptions.cs +++ b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/DatabaseOptions.cs @@ -72,9 +72,9 @@ public class DatabaseOptions /// /// /// The default is . - /// The throughput is in database defined units. - /// e.g. Cosmos DB throughput measured in RUs (Request Units) per second: - /// Azure Cosmos DB service quotas. + /// The throughput is in database defined units, + /// for example, Cosmos DB throughput measured in RUs (request units) per second: + /// Azure Cosmos DB service quotas. /// public Throughput Throughput { get; set; } = Throughput.Unlimited; @@ -91,9 +91,9 @@ public class DatabaseOptions /// /// Gets or sets a list of preferred regions used for SDK to define failover order for global database. /// - /// - /// Default set to empty . - /// + /// + /// The default value is empty . + /// [SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "Options pattern.")] public IList FailoverRegions { get; set; } @@ -102,9 +102,9 @@ public class DatabaseOptions /// /// Gets or sets a list of region specific configurations for the database. /// - /// - /// Default set to empty . - /// + /// + /// The default value is empty . + /// [SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "Options pattern.")] public IDictionary RegionalDatabaseOptions { get; set; } diff --git a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/FetchMode.cs b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/FetchMode.cs index 3fc7286fdf9..0805131ebc9 100644 --- a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/FetchMode.cs +++ b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/FetchMode.cs @@ -30,13 +30,13 @@ public enum FetchMode /// /// /// This parameter should only being served on cross partition query. - /// For instance, if you set the to 50. + /// For instance, if you set the to 50. /// On in partition query, it will return you exactly 50 items if there is that much. /// But for cross partition query, it might return you only 30 items on a single fetch. /// In a case of only 30 items will be returned with a continuation token to /// let you fetch forward. /// In a case of , another round of single fetch query will be requested with same - /// , which means 80 items at maximum can be returned. + /// , which means 80 items at maximum can be returned. /// FetchMaxResults, } diff --git a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/QueryRequestOptions.cs b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/QueryRequestOptions.cs index 1fc1013dbf7..4396cdf965f 100644 --- a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/QueryRequestOptions.cs +++ b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/QueryRequestOptions.cs @@ -53,10 +53,10 @@ public class QueryRequestOptions : RequestOptions /// Gets or sets the maximum number of items that can be buffered client side during parallel query execution. /// /// - /// Default is . + /// The default is . /// A positive property value limits the number of buffered items to the set value. /// If this is set to , the system automatically decides the number of items to buffer. - /// This is only suggestive and cannot be abide by in certain cases. + /// This is only suggestive and cannot be abided by in certain cases. /// [Range(1, MaxBufferedCount)] public int? MaxBufferedItemCount { get; set; } diff --git a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/RegionalDatabaseOptions.cs b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/RegionalDatabaseOptions.cs index 15b4f67d873..db661058ae9 100644 --- a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/RegionalDatabaseOptions.cs +++ b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/RegionalDatabaseOptions.cs @@ -42,9 +42,9 @@ public class RegionalDatabaseOptions /// /// Gets or sets a list of preferred regions used for SDK to define failover order for regional database. /// - /// - /// Default set to empty . - /// + /// + /// The default value is empty . + /// [SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "Options pattern.")] public IList FailoverRegions { get; set; } diff --git a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/RequestOptions.cs b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/RequestOptions.cs index 48e9223d545..39d2f2ee25a 100644 --- a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/RequestOptions.cs +++ b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/RequestOptions.cs @@ -39,11 +39,13 @@ public class RequestOptions /// /// Gets or sets a value indicating whether written object should be returned back after write operations. /// + /// + /// The default value is . + /// /// - /// Indicating whether written object should be returned back after write operations like Create, Upsert, Patch and Replace. - /// Setting the option to false will cause the response to have a null item. + /// Indicates whether written object should be returned back after write operations like Create, Upsert, Patch, and Replace. + /// Setting the option to false causes the response to have a item. /// This reduces networking and CPU load by not sending the resource back over the network and serializing it on the client. - /// Default is . /// public bool ContentResponseOnWrite { get; set; } diff --git a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/Throughput.cs b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/Throughput.cs index 72ea6ecda25..a281cce12d8 100644 --- a/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/Throughput.cs +++ b/src/Libraries/System.Cloud.DocumentDb.Abstractions/Model/Throughput.cs @@ -19,9 +19,9 @@ public readonly struct Throughput /// Gets throughput value. /// /// - /// The throughput is in database defined units. - /// e.g. Cosmos DB throughput measured in RUs (Request Units) per second: - /// Azure Cosmos DB service quotas. + /// The throughput is in database defined units, + /// for example, Cosmos DB throughput measured in RUs (request units) per second: + /// Azure Cosmos DB service quotas. /// public int? Value { get; } diff --git a/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/MessagePostponeFeatureExtensions.cs b/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/MessagePostponeFeatureExtensions.cs index 4a3a01d7b58..7c400eb4919 100644 --- a/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/MessagePostponeFeatureExtensions.cs +++ b/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/MessagePostponeFeatureExtensions.cs @@ -23,9 +23,9 @@ public static class MessagePostponeFeatureExtensions /// The message context. /// The time by which the message processing is to be postponed. /// The cancellation token for the postpone operation. - /// . - /// If any of the parameters is null. - /// If there is no added to . + /// To be added. + /// Any of the parameters are . + /// There is no added to . public static ValueTask PostponeAsync(this MessageContext context, TimeSpan delay, CancellationToken cancellationToken) { _ = Throw.IfNullOrMemberNull(context, context?.Features); @@ -41,7 +41,7 @@ public static ValueTask PostponeAsync(this MessageContext context, TimeSpan dela /// /// The message context. /// The feature to postpone message processing. - /// If any of the parameters is null. + /// Any of the parameters are . public static void SetMessagePostponeFeature(this MessageContext context, IMessagePostponeFeature messagePostponeFeature) { _ = Throw.IfNull(context); diff --git a/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/MessageVisibilityDelayFeatureExtensions.cs b/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/MessageVisibilityDelayFeatureExtensions.cs index 99de3b70c0a..264558b775d 100644 --- a/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/MessageVisibilityDelayFeatureExtensions.cs +++ b/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/MessageVisibilityDelayFeatureExtensions.cs @@ -18,7 +18,7 @@ public static class MessageVisibilityDelayFeatureExtensions /// /// The message context. /// The time span representing when the message should be next visible for processing via a different . - /// If is null. + /// is . public static void SetVisibilityDelay(this MessageContext context, TimeSpan visibilityDelay) { _ = Throw.IfNull(context); @@ -26,13 +26,13 @@ public static void SetVisibilityDelay(this MessageContext context, TimeSpan visi } /// - /// Try to get in the provided from the . + /// Tries to get in the provided from the . /// /// The message context. /// The optional feature to delay the message visibility. /// and if , a corresponding . - /// If is null. - /// If no source is added to . + /// is . + /// No source is added to . public static bool TryGetVisibilityDelay(this MessageContext context, [NotNullWhen(true)] out IMessageVisibilityDelayFeature? visibilityDelay) { _ = Throw.IfNull(context); diff --git a/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/SerializedMessagePayloadFeatureExtensions.cs b/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/SerializedMessagePayloadFeatureExtensions.cs index b7e87ad78ea..f652cb46e24 100644 --- a/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/SerializedMessagePayloadFeatureExtensions.cs +++ b/src/Libraries/System.Cloud.Messaging/Abstractions/Extensions/MessageContext/SerializedMessagePayloadFeatureExtensions.cs @@ -21,8 +21,8 @@ public static class SerializedMessagePayloadFeatureExtensions /// Type of the serialized message payload. /// The message context. /// The serialized message payload. - /// If the is null. - /// If no is set in the . + /// is . + /// No is set in the . public static T GetSerializedPayload(this MessageContext context) where T : notnull { @@ -43,7 +43,7 @@ public static T GetSerializedPayload(this MessageContext context) /// Type of the serialized message payload. /// The message context. /// The serialized message payload. - /// If any of the parameters is null. + /// Any of the parameters are . public static void SetSerializedPayload(this MessageContext context, T payload) where T : notnull { @@ -58,7 +58,7 @@ public static void SetSerializedPayload(this MessageContext context, T payloa /// The message context. /// The optional serialized message payload. /// and if , a corresponding representing the serialized message payload. - /// If any of the parameters is null. + /// Any of the parameters are . public static bool TryGetSerializedPayload(this MessageContext context, [NotNullWhen(true)] out T? payload) where T : notnull { diff --git a/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/IMessageMiddleware.cs b/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/IMessageMiddleware.cs index 251c4da9832..d90908da294 100644 --- a/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/IMessageMiddleware.cs +++ b/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/IMessageMiddleware.cs @@ -8,10 +8,10 @@ namespace System.Cloud.Messaging; /// -/// Interface for a middleware which uses and the next in the pipeline to process the message. +/// Interface for a middleware that uses and the next in the pipeline to process the message. /// /// -/// Inspired from ASP.NET Core Middleware which uses HttpContext and the next RequestDelegate in the pipeline. +/// Inspired from ASP.NET Core Middleware, which uses HttpContext and the next RequestDelegate in the pipeline. /// public interface IMessageMiddleware { diff --git a/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageConsumer.cs b/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageConsumer.cs index 0b70f931b6d..f788df973dd 100644 --- a/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageConsumer.cs +++ b/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageConsumer.cs @@ -44,7 +44,7 @@ public abstract class MessageConsumer /// List of middleware in the async processing pipeline. /// Terminal message delegate. /// . - /// If any of the parameters is null. + /// Any of the parameters are . protected MessageConsumer(IMessageSource messageSource, IReadOnlyList messageMiddlewares, MessageDelegate terminalDelegate, ILogger logger) { MessageSource = Throw.IfNull(messageSource); @@ -100,7 +100,7 @@ public async virtual ValueTask ExecuteAsync(CancellationToken cancellationToken) /// /// The cancellation token for retrieving and processing message. /// Swallows any exception during retrieving or processing message and returns a non-faulted . - /// If there is any exception during . + /// An exception is thrown during . [SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = $"Handled by {nameof(Logger)}.")] protected virtual async ValueTask FetchAndProcessMessageAsync(CancellationToken cancellationToken) { diff --git a/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageContext.cs b/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageContext.cs index 2e9938244f8..5d33892d7fc 100644 --- a/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageContext.cs +++ b/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageContext.cs @@ -59,7 +59,7 @@ public abstract class MessageContext /// /// The feature collection. /// The source payload. - /// If any of the arguments is null. + /// Any of the arguments is . protected MessageContext(IFeatureCollection features, ReadOnlyMemory sourcePayload) { Features = Throw.IfNull(features); @@ -72,7 +72,7 @@ protected MessageContext(IFeatureCollection features, ReadOnlyMemory sourc /// /// The type of the feature to be added to the . /// The feature to be added to the . - /// If the is null. + /// is . public void AddFeature(T feature) { _ = Throw.IfNull(feature); @@ -84,7 +84,7 @@ public void AddFeature(T feature) /// /// The type of the feature to be added to the . /// The feature to be added to the . - /// If the is null. + /// is . public void AddSourceFeature(T feature) { _ = Throw.IfNull(feature); @@ -97,7 +97,7 @@ public void AddSourceFeature(T feature) /// /// The type of the feature to be added to the . /// The feature to be added to the . - /// If the is null. + /// is . public void AddDestinationFeature(T feature) { _ = Throw.IfNull(feature); @@ -125,7 +125,7 @@ public string GetUTF8SourcePayloadAsString() /// Sets the payload in the for the message. /// /// The payload for destination message. - /// If the is null. + /// is . public void SetDestinationPayload(ReadOnlyMemory payload) { _ = Throw.IfNull(payload); diff --git a/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageDelegate.cs b/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageDelegate.cs index 93128e8cd60..038a7bd0e33 100644 --- a/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageDelegate.cs +++ b/src/Libraries/System.Cloud.Messaging/Abstractions/Interfaces/MessageDelegate.cs @@ -11,7 +11,7 @@ namespace System.Cloud.Messaging; /// The message delegate called by to continue processing the message in the pipeline chain. /// /// -/// It is inspired from the next delegate in the ASP.NET Core Middleware pipeline. +/// It is inspired from the next delegate in the ASP.NET Core Middleware pipeline. /// /// The message context. /// . diff --git a/src/Libraries/System.Cloud.Messaging/Abstractions/Internal/Delegate/PipelineMessageDelegateStitcher.cs b/src/Libraries/System.Cloud.Messaging/Abstractions/Internal/Delegate/PipelineMessageDelegateStitcher.cs index d7db70672bf..f439bb85612 100644 --- a/src/Libraries/System.Cloud.Messaging/Abstractions/Internal/Delegate/PipelineMessageDelegateStitcher.cs +++ b/src/Libraries/System.Cloud.Messaging/Abstractions/Internal/Delegate/PipelineMessageDelegateStitcher.cs @@ -22,7 +22,7 @@ internal sealed class PipelineMessageDelegateStitcher /// /// . /// . - /// If any of the parameters is null. + /// Any of the parameters are . public PipelineMessageDelegateStitcher(IMessageMiddleware middleware, MessageDelegate nextHandler) { _middleware = Throw.IfNull(middleware); diff --git a/src/Libraries/System.Cloud.Messaging/Abstractions/Internal/Extensions/MessageMiddlewareExtensions.cs b/src/Libraries/System.Cloud.Messaging/Abstractions/Internal/Extensions/MessageMiddlewareExtensions.cs index 54cde63d7b3..4bd80fb4d3e 100644 --- a/src/Libraries/System.Cloud.Messaging/Abstractions/Internal/Extensions/MessageMiddlewareExtensions.cs +++ b/src/Libraries/System.Cloud.Messaging/Abstractions/Internal/Extensions/MessageMiddlewareExtensions.cs @@ -18,7 +18,7 @@ internal static class MessageMiddlewareExtensions /// The middleware. /// The next delegate in the pipeline. /// Composed message handler. - /// If any of the parameters is null. + /// Any of the parameters are . public static MessageDelegate Stitch(this IMessageMiddleware middleware, MessageDelegate nextHandler) { _ = Throw.IfNull(middleware); diff --git a/src/Libraries/System.Cloud.Messaging/DependencyInjection/Extensions/AsyncProcessingPipelineBuilderExtensions.cs b/src/Libraries/System.Cloud.Messaging/DependencyInjection/Extensions/AsyncProcessingPipelineBuilderExtensions.cs index 14397875710..df3a415a471 100644 --- a/src/Libraries/System.Cloud.Messaging/DependencyInjection/Extensions/AsyncProcessingPipelineBuilderExtensions.cs +++ b/src/Libraries/System.Cloud.Messaging/DependencyInjection/Extensions/AsyncProcessingPipelineBuilderExtensions.cs @@ -28,7 +28,7 @@ public static class AsyncProcessingPipelineBuilderExtensions /// Type of singleton. /// The builder for async processing pipeline. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder AddNamedSingleton(this IAsyncProcessingPipelineBuilder pipelineBuilder) where T : class { @@ -45,7 +45,7 @@ public static IAsyncProcessingPipelineBuilder AddNamedSingleton(this IAsyncPr /// The builder for async processing pipeline. /// The implementation factory for the singleton type. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder AddNamedSingleton(this IAsyncProcessingPipelineBuilder pipelineBuilder, Func implementationFactory) where T : class @@ -65,7 +65,7 @@ public static IAsyncProcessingPipelineBuilder AddNamedSingleton(this IAsyncPr /// The name with which the singleton is registered. /// The implementation factory for the singleton type. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder AddNamedSingleton(this IAsyncProcessingPipelineBuilder pipelineBuilder, string name, Func implementationFactory) @@ -88,7 +88,7 @@ public static IAsyncProcessingPipelineBuilder AddNamedSingleton(this IAsyncPr /// Type of implementation. /// The builder for async processing pipeline. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder ConfigureMessageDestination(this IAsyncProcessingPipelineBuilder pipelineBuilder) where TDestination : class, IMessageDestination { @@ -105,7 +105,7 @@ public static IAsyncProcessingPipelineBuilder ConfigureMessageDestinationThe builder for async processing pipeline. /// The implementation factory for . /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder ConfigureMessageDestination(this IAsyncProcessingPipelineBuilder pipelineBuilder, Func implementationFactory) where TDestination : class, IMessageDestination @@ -125,7 +125,7 @@ public static IAsyncProcessingPipelineBuilder ConfigureMessageDestinationThe name with which the is registered with. /// The implementation factory for . /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder ConfigureMessageDestination(this IAsyncProcessingPipelineBuilder pipelineBuilder, string name, Func implementationFactory) @@ -148,7 +148,7 @@ public static IAsyncProcessingPipelineBuilder ConfigureMessageDestinationType of implementation. /// The builder for async processing pipeline. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder ConfigureMessageSource(this IAsyncProcessingPipelineBuilder pipelineBuilder) where TSource : class, IMessageSource { @@ -165,7 +165,7 @@ public static IAsyncProcessingPipelineBuilder ConfigureMessageSource(th /// The builder for async processing pipeline. /// The implementation factory for . /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder ConfigureMessageSource(this IAsyncProcessingPipelineBuilder pipelineBuilder, Func implementationFactory) where TSource : class, IMessageSource @@ -187,7 +187,7 @@ public static IAsyncProcessingPipelineBuilder ConfigureMessageSource(th /// Type of implementation. /// The builder for async processing pipeline. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder AddMessageMiddleware(this IAsyncProcessingPipelineBuilder pipelineBuilder) where TMiddleware : class, IMessageMiddleware { @@ -207,7 +207,7 @@ public static IAsyncProcessingPipelineBuilder AddMessageMiddleware( /// The builder for async processing pipeline. /// The implementation factory for . /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder AddMessageMiddleware(this IAsyncProcessingPipelineBuilder pipelineBuilder, Func implementationFactory) where TMiddleware : class, IMessageMiddleware @@ -229,7 +229,7 @@ public static IAsyncProcessingPipelineBuilder AddMessageMiddleware( /// /// The builder for async processing pipeline. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder ConfigureTerminalMessageDelegate(this IAsyncProcessingPipelineBuilder pipelineBuilder) { _ = Throw.IfNull(pipelineBuilder); @@ -249,7 +249,7 @@ public static IAsyncProcessingPipelineBuilder ConfigureTerminalMessageDelegate(t /// The builder for async processing pipeline. /// The implementation factory for . /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder ConfigureTerminalMessageDelegate(this IAsyncProcessingPipelineBuilder pipelineBuilder, Func implementationFactory) { @@ -269,7 +269,7 @@ public static IAsyncProcessingPipelineBuilder ConfigureTerminalMessageDelegate(t /// Type of implementation. /// The builder for async processing pipeline. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder ConfigureMessageConsumer(this IAsyncProcessingPipelineBuilder pipelineBuilder) where TConsumer : MessageConsumer { @@ -286,7 +286,7 @@ public static IAsyncProcessingPipelineBuilder ConfigureMessageConsumerThe builder for async processing pipeline. /// The implementation factory for . /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder ConfigureMessageConsumer(this IAsyncProcessingPipelineBuilder pipelineBuilder, Func implementationFactory) where TConsumer : MessageConsumer @@ -307,7 +307,7 @@ public static IAsyncProcessingPipelineBuilder ConfigureMessageConsumer. /// /// The builder for async processing pipeline. - /// If any of the parameters is null. + /// Any of the parameters are . public static void RunConsumerAsBackgroundService(this IAsyncProcessingPipelineBuilder pipelineBuilder) { _ = Throw.IfNull(pipelineBuilder); diff --git a/src/Libraries/System.Cloud.Messaging/DependencyInjection/Extensions/ServiceCollectionExtensions.cs b/src/Libraries/System.Cloud.Messaging/DependencyInjection/Extensions/ServiceCollectionExtensions.cs index 98fdb899f60..ddb9de717ff 100644 --- a/src/Libraries/System.Cloud.Messaging/DependencyInjection/Extensions/ServiceCollectionExtensions.cs +++ b/src/Libraries/System.Cloud.Messaging/DependencyInjection/Extensions/ServiceCollectionExtensions.cs @@ -18,7 +18,7 @@ public static class ServiceCollectionExtensions /// The service collection. /// The name of the async processing pipeline. /// The builder for async processing pipeline. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder AddAsyncPipeline(this IServiceCollection services, string pipelineName) { _ = Throw.IfNull(services); diff --git a/src/Libraries/System.Cloud.Messaging/DependencyInjection/Internal/ConsumerBackgroundService.cs b/src/Libraries/System.Cloud.Messaging/DependencyInjection/Internal/ConsumerBackgroundService.cs index 6363ce17e3c..841e36f93d8 100644 --- a/src/Libraries/System.Cloud.Messaging/DependencyInjection/Internal/ConsumerBackgroundService.cs +++ b/src/Libraries/System.Cloud.Messaging/DependencyInjection/Internal/ConsumerBackgroundService.cs @@ -20,7 +20,7 @@ internal sealed class ConsumerBackgroundService : BackgroundService /// Initializes a new instance of the class. /// /// . - /// If any of the parameters is null. + /// Any of the parameters are . public ConsumerBackgroundService(MessageConsumer consumer) { _consumer = Throw.IfNull(consumer); diff --git a/src/Libraries/System.Cloud.Messaging/Middlewares/Extensions/LatencyRecorderMiddlewareExtensions.cs b/src/Libraries/System.Cloud.Messaging/Middlewares/Extensions/LatencyRecorderMiddlewareExtensions.cs index c33de95af75..49a765ed931 100644 --- a/src/Libraries/System.Cloud.Messaging/Middlewares/Extensions/LatencyRecorderMiddlewareExtensions.cs +++ b/src/Libraries/System.Cloud.Messaging/Middlewares/Extensions/LatencyRecorderMiddlewareExtensions.cs @@ -24,7 +24,7 @@ public static class LatencyRecorderMiddlewareExtensions /// /// The builder for async processing pipeline. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder AddLatencyContextMiddleware(this IAsyncProcessingPipelineBuilder pipelineBuilder) { return AddLatencyContextMiddleware(pipelineBuilder, sp => sp.GetRequiredService(), sp => sp.GetServices()); @@ -43,7 +43,7 @@ public static IAsyncProcessingPipelineBuilder AddLatencyContextMiddleware(this I /// The implementation factory. /// The factory for exporting capture latency context. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder AddLatencyContextMiddleware(this IAsyncProcessingPipelineBuilder pipelineBuilder, Func implementationFactory, Func> exporterFactory) @@ -65,7 +65,7 @@ public static IAsyncProcessingPipelineBuilder AddLatencyContextMiddleware(thi /// The builder for async processing pipeline. /// The implementation factory. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder AddLatencyContextMiddleware(this IAsyncProcessingPipelineBuilder pipelineBuilder, Func implementationFactory) where T : class, ILatencyContext @@ -92,7 +92,7 @@ public static IAsyncProcessingPipelineBuilder AddLatencyContextMiddleware(thi /// The success token. /// The failure token. /// to chain additional calls. - /// If any of the parameters is null. + /// Any of the parameters are . public static IAsyncProcessingPipelineBuilder AddLatencyRecorderMessageMiddleware(this IAsyncProcessingPipelineBuilder pipelineBuilder, MeasureToken successMeasureToken, MeasureToken failureMeasureToken) diff --git a/src/Libraries/System.Cloud.Messaging/Middlewares/Extensions/MessageLatencyContextFeatureExtensions.cs b/src/Libraries/System.Cloud.Messaging/Middlewares/Extensions/MessageLatencyContextFeatureExtensions.cs index c662eac4916..b039de3400b 100644 --- a/src/Libraries/System.Cloud.Messaging/Middlewares/Extensions/MessageLatencyContextFeatureExtensions.cs +++ b/src/Libraries/System.Cloud.Messaging/Middlewares/Extensions/MessageLatencyContextFeatureExtensions.cs @@ -21,7 +21,7 @@ public static class MessageLatencyContextFeatureExtensions /// /// The message context. /// The latency context to store fine-grained latency for different processing steps. - /// If any of the parameters is null. + /// Any of the parameters are . public static void SetLatencyContext(this MessageContext context, ILatencyContext latencyContext) { _ = Throw.IfNullOrMemberNull(context, context?.Features); @@ -39,7 +39,7 @@ public static void SetLatencyContext(this MessageContext context, ILatencyContex /// The message context. /// The optional latency context registered with the . /// and if , a corresponding . - /// If the is null. + /// is . public static bool TryGetLatencyContext(this MessageContext context, [NotNullWhen(true)] out ILatencyContext? latencyContext) { _ = Throw.IfNullOrMemberNull(context, context?.Features); diff --git a/src/Shared/Data.Validation/ExclusiveRangeAttribute.cs b/src/Shared/Data.Validation/ExclusiveRangeAttribute.cs index 45d854f7c1a..faab259c09a 100644 --- a/src/Shared/Data.Validation/ExclusiveRangeAttribute.cs +++ b/src/Shared/Data.Validation/ExclusiveRangeAttribute.cs @@ -62,7 +62,7 @@ protected override ValidationResult IsValid(object? value, ValidationContext? va var comparableMin = Minimum as IComparable; var comparableMax = Maximum as IComparable; - // Minimun and Maximum are either of type int or double, so there is no need for + // Minimum and Maximum are either of type int or double, so there is no need for // nullability check here (or later) as both types are IComparable already. if (comparableMin!.CompareTo(Maximum) >= 0) { diff --git a/src/Shared/Data.Validation/LengthAttribute.cs b/src/Shared/Data.Validation/LengthAttribute.cs index 7d598a44e2c..c9e95dcee4d 100644 --- a/src/Shared/Data.Validation/LengthAttribute.cs +++ b/src/Shared/Data.Validation/LengthAttribute.cs @@ -41,9 +41,9 @@ internal sealed class LengthAttribute : ValidationAttribute /// /// Gets or sets a value indicating whether the length validation should exclude the and values. /// - /// - /// By default the property is set to false. - /// + /// + /// The default value is false. + /// public bool Exclusive { get; set; } /// @@ -82,14 +82,14 @@ public LengthAttribute(int minimumLength, int maximumLength) /// Validates that a given value is in range. /// /// - /// This method returns true if the is null. - /// It is assumed the is used if the value may not be null. + /// This method returns true if the is . + /// It is assumed the is used if the value may not be . /// /// The value to validate. /// Additional context for this validation. /// A value indicating success or failure. - /// if is less than zero or if it is greater than . - /// if the validated type is not supported. + /// is less than zero or if it is greater than . + /// The validated type is not supported. [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode", Justification = "The ctor is marked with RequiresUnreferencedCode.")] protected override ValidationResult IsValid(object? value, ValidationContext? validationContext) { diff --git a/src/Shared/Data.Validation/TimeSpanAttribute.cs b/src/Shared/Data.Validation/TimeSpanAttribute.cs index d3926b9db8c..8830a4120e5 100644 --- a/src/Shared/Data.Validation/TimeSpanAttribute.cs +++ b/src/Shared/Data.Validation/TimeSpanAttribute.cs @@ -48,9 +48,9 @@ public TimeSpan? Maximum /// /// Gets or sets a value indicating whether the time span validation should exclude the minimum and maximum values. /// - /// - /// By default the property is set to false. - /// + /// + /// The default value is false. + /// public bool Exclusive { get; set; } private readonly int? _minMs; diff --git a/src/Shared/EmptyCollections/EmptyCollectionExtensions.cs b/src/Shared/EmptyCollections/EmptyCollectionExtensions.cs index cd40b6887df..ed4bdb7e5e9 100644 --- a/src/Shared/EmptyCollections/EmptyCollectionExtensions.cs +++ b/src/Shared/EmptyCollections/EmptyCollectionExtensions.cs @@ -18,11 +18,11 @@ namespace Microsoft.Shared.Collections; internal static class EmptyCollectionExtensions { /// - /// Returns an optimized empty collection if the input is null or empty, otherwise returns the input. + /// Returns an optimized empty collection if the input is or empty, otherwise returns the input. /// /// The type of the collection. - /// The collection to check for null or empty. - /// Returns a static instance of an empty type if the input collection is null or empty, otherwise the collection. + /// The collection to check for or empty. + /// Returns a static instance of an empty type if the input collection is or empty, otherwise the collection. /// /// Substituting a static collection whenever an empty collection is needed helps in two ways. First, /// it allows the original empty collection to be garbage collected, freeing memory. Second, the @@ -33,11 +33,11 @@ public static IReadOnlyCollection EmptyIfNull(this IReadOnlyCollection? => collection == null || collection.Count == 0 ? EmptyReadOnlyList.Instance : collection; /// - /// Returns an optimized empty collection if the input is null or empty, otherwise returns the input. + /// Returns an optimized empty collection if the input is or empty, otherwise returns the input. /// /// The type of the collection. - /// The collection to check for null or empty. - /// Returns a static instance of an empty type if the input collection is null or empty, otherwise the collection. + /// The collection to check for or empty. + /// Returns a static instance of an empty type if the input collection is or empty, otherwise the collection. /// /// Substituting a static collection whenever an empty collection is needed helps in two ways. First, /// it allows the original empty collection to be garbage collected, freeing memory. Second, the @@ -48,11 +48,11 @@ public static IEnumerable EmptyIfNull(this ICollection? collection) => collection == null || collection.Count == 0 ? EmptyReadOnlyList.Instance : collection; /// - /// Returns an optimized empty collection if the input is null or empty, otherwise returns the input. + /// Returns an optimized empty collection if the input is or empty, otherwise returns the input. /// /// The type of the collection. - /// The collection to check for null or empty. - /// Returns a static instance of an empty type if the input collection is null or empty, otherwise the collection. + /// The collection to check for or empty. + /// Returns a static instance of an empty type if the input collection is or empty, otherwise the collection. /// /// Substituting a static collection whenever an empty collection is needed helps in two ways. First, /// it allows the original empty collection to be garbage collected, freeing memory. Second, the @@ -63,11 +63,11 @@ public static IReadOnlyList EmptyIfNull(this IReadOnlyList? list) => list == null || list.Count == 0 ? EmptyReadOnlyList.Instance : list; /// - /// Returns an optimized empty list if the input is null or empty, otherwise returns the input. + /// Returns an optimized empty list if the input is or empty, otherwise returns the input. /// /// The type of the collection. - /// The list to check for null or empty. - /// Returns a static instance of an empty type if the input collection is null or empty, otherwise the collection. + /// The list to check for or empty. + /// Returns a static instance of an empty type if the input collection is or empty, otherwise the collection. /// /// Substituting a static list whenever an empty collection is needed helps in two ways. First, /// it allows the original empty collection to be garbage collected, freeing memory. Second, the @@ -78,22 +78,22 @@ public static IEnumerable EmptyIfNull(this IList? list) => list == null || list.Count == 0 ? EmptyReadOnlyList.Instance : list; /// - /// Returns an optimized empty array if the input is null or empty, otherwise returns the input. + /// Returns an optimized empty array if the input is or empty, otherwise returns the input. /// /// The type of the array. - /// The array to check for null or empty. - /// Returns a static instance of an empty array if the input array is null or empty, otherwise the array. + /// The array to check for or empty. + /// Returns a static instance of an empty array if the input array is or empty, otherwise the array. public static T[] EmptyIfNull(this T[]? array) => array == null || array.Length == 0 ? Array.Empty() : array; /// - /// Returns an optimized empty collection if the input is null or can be determined to be empty, otherwise returns the input. + /// Returns an optimized empty collection if the input is or can be determined to be empty, otherwise returns the input. /// /// The type of the collection. - /// The collection to check for null or empty. - /// Returns a static instance of an empty type if the input collection is null or empty, otherwise the collection. + /// The collection to check for or empty. + /// Returns a static instance of an empty type if the input collection is or empty, otherwise the collection. /// - /// Note that this method does not enumerate the colleciton. + /// This method does not enumerate the collection. /// public static IEnumerable EmptyIfNull(this IEnumerable? enumerable) { @@ -118,12 +118,12 @@ public static IEnumerable EmptyIfNull(this IEnumerable? enumerable) } /// - /// Returns an optimized empty dictionary if the input is null or can be determined to be empty, otherwise returns the input. + /// Returns an optimized empty dictionary if the input is or can be determined to be empty, otherwise returns the input. /// /// The key type of the dictionary. /// The value type of the dictionary. - /// The dictionary to check for null or empty. - /// Returns a static instance of an empty type if the input dictionary is null or empty, otherwise the dictionary. + /// The dictionary to check for or empty. + /// Returns a static instance of an empty type if the input dictionary is or empty, otherwise the dictionary. /// /// Note that this method does not enumerate the dictionary. /// diff --git a/src/Shared/Text.Formatting/CompositeFormat.cs b/src/Shared/Text.Formatting/CompositeFormat.cs index aa40d6da288..2031fd88eea 100644 --- a/src/Shared/Text.Formatting/CompositeFormat.cs +++ b/src/Shared/Text.Formatting/CompositeFormat.cs @@ -49,7 +49,7 @@ internal readonly struct CompositeFormat /// /// Parses a composite format string into an efficient form for later use. /// - /// When the format string is malformed. + /// The format string is malformed. public static CompositeFormat Parse([StringSyntaxAttribute(StringSyntaxAttribute.CompositeFormat)] ReadOnlySpan format) { if (!TryParse(format, out var cf, out var error)) @@ -67,7 +67,7 @@ public static CompositeFormat Parse([StringSyntaxAttribute(StringSyntaxAttribute /// /// Parses a composite format string into an efficient form for later use. /// - /// When the format string is malformed. + /// The format string is malformed. public static CompositeFormat Parse([StringSyntaxAttribute(StringSyntaxAttribute.CompositeFormat)] string format) => Parse(format.AsSpan()); @@ -79,7 +79,7 @@ public static CompositeFormat Parse([StringSyntaxAttribute(StringSyntaxAttribute /// /// Parses a composite format string into an efficient form for later use. /// - /// When the format string is malformed. + /// The format string is malformed. public static CompositeFormat Parse([StringSyntaxAttribute(StringSyntaxAttribute.CompositeFormat)] ReadOnlySpan format, out IList templates) { var l = new List(); diff --git a/src/ToBeMoved/DependencyInjection.Pools/DependencyInjectionExtensions.cs b/src/ToBeMoved/DependencyInjection.Pools/DependencyInjectionExtensions.cs index 337dac0bea4..cd870efee85 100644 --- a/src/ToBeMoved/DependencyInjection.Pools/DependencyInjectionExtensions.cs +++ b/src/ToBeMoved/DependencyInjection.Pools/DependencyInjectionExtensions.cs @@ -26,7 +26,7 @@ public static class DependencyInjectionExtensions /// The action used to configure the options of the pool. /// The type of objects to pool. /// Provided service collection. - /// When is . + /// is . /// /// The default capacity is 1024. /// The pooled type instances are obtainable the same way like any other type instances from the DI container. @@ -45,7 +45,7 @@ public static IServiceCollection AddPool(this IServiceCollection se /// The type of objects to pool. /// The type of the implementation to use. /// Provided service collection. - /// When is . + /// is . /// /// The default capacity is 1024. /// The pooled type instances are obtainable the same way like any other type instances from the DI container. diff --git a/src/ToBeMoved/Hosting.StartupInitialization/StartupInitializationOptions.cs b/src/ToBeMoved/Hosting.StartupInitialization/StartupInitializationOptions.cs index 5c501f7ae0e..b61e3f7cf06 100644 --- a/src/ToBeMoved/Hosting.StartupInitialization/StartupInitializationOptions.cs +++ b/src/ToBeMoved/Hosting.StartupInitialization/StartupInitializationOptions.cs @@ -14,9 +14,9 @@ public class StartupInitializationOptions /// /// Gets or sets maximum time allowed for initialization logic. /// - /// - /// Default set to 30 seconds. - /// + /// + /// The default value is 30 seconds. + /// [TimeSpan("00:00:05", "01:00:00")] public TimeSpan Timeout { get; set; } = TimeSpan.FromSeconds(30); } diff --git a/src/ToBeMoved/HttpClient.SocketHandling/SocketsHttpHandlerOptions.cs b/src/ToBeMoved/HttpClient.SocketHandling/SocketsHttpHandlerOptions.cs index 84c6d228c17..e0542359020 100644 --- a/src/ToBeMoved/HttpClient.SocketHandling/SocketsHttpHandlerOptions.cs +++ b/src/ToBeMoved/HttpClient.SocketHandling/SocketsHttpHandlerOptions.cs @@ -24,60 +24,60 @@ public class SocketsHttpHandlerOptions /// /// Gets or sets a value indicating whether to automatically follow redirection responses. /// - /// - /// Default set to false. - /// + /// + /// The default value is . + /// public bool AllowAutoRedirect { get; set; } /// /// Gets or sets a value indicating whether to use cookies when sending requests. /// - /// - /// Default set to false. - /// + /// + /// The default value is . + /// public bool UseCookies { get; set; } /// /// Gets or sets the maximum number of concurrent connections (per server endpoint) allowed when making requests. /// - /// - /// Default set to `100000`. - /// + /// + /// The default value is `100000`. + /// [Range(1, MaxConnectionsPerServerUpperLimit)] public int MaxConnectionsPerServer { get; set; } = MaxConnectionsPerServerUpperLimit; /// /// Gets or sets the type of decompression method used by the handler for automatic decompression of the HTTP content response. /// - /// - /// Default set to `All`. - /// + /// + /// The default value is `All`. + /// public DecompressionMethods AutomaticDecompression { get; set; } = DecompressionMethods.All; /// /// Gets or sets the length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. /// - /// - /// Default set to 10 seconds. 100 minutes is the max timeout value in Azure SLB. - /// + /// + /// The default value is 10 seconds. 100 minutes is the max timeout value in Azure SLB. + /// [TimeSpan("00:00:05", "00:05:00")] public TimeSpan ConnectTimeout { get; set; } = _defaultConnectTimeout; /// /// Gets or sets how long a connection can be in the pool to be considered reusable. /// - /// - /// Default set to 5 minutes. - /// + /// + /// The default value is 5 minutes. + /// [TimeSpan("00:00:01", "00:15:00")] public TimeSpan PooledConnectionLifetime { get; set; } = _defaultConnectionLifetime; /// /// Gets or sets how long a connection can be idle in the pool to be considered reusable. /// - /// - /// Default set to 3 minutes. - /// + /// + /// The default value is 3 minutes. + /// [TimeSpan("00:00:01", "01:40:00")] public TimeSpan PooledConnectionIdleTimeout { get; set; } = _defaultConnectionIdleTimeout; @@ -85,18 +85,18 @@ public class SocketsHttpHandlerOptions /// /// Gets or sets the keep alive ping delay. /// - /// - /// Default set to 1 minute. - /// + /// + /// The default value is 1 minute. + /// [TimeSpan("00:00:01", "01:00:00")] public TimeSpan KeepAlivePingDelay { get; set; } = _defaultKeepAlivePingDelay; /// /// Gets or sets the keep alive ping timeout. /// - /// - /// Default set to 30 seconds. - /// + /// + /// The default value is 30 seconds. + /// [TimeSpan("00:00:01", "00:05:00")] public TimeSpan KeepAlivePingTimeout { get; set; } = _defaultKeepAlivePingTimeout; #endif From 76be9e4dd741f3e6ebf86aaad193ff952e810e50 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Mon, 12 Jun 2023 16:32:56 -0700 Subject: [PATCH 2/3] respond to feedback --- .../Logging/LoggingOptions.cs | 4 +++- .../Tracing/HttpTracingOptions.cs | 18 +++++++++--------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/LoggingOptions.cs b/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/LoggingOptions.cs index 526ec25985b..9eb5339d5c9 100644 --- a/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/LoggingOptions.cs +++ b/src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/LoggingOptions.cs @@ -85,9 +85,11 @@ public class LoggingOptions /// /// Gets or sets the maximum number of bytes of the request/response body to be read. /// + /// + /// The default is ≈ 32K. + /// /// /// The number should ideally be below 85K to not be allocated on the large object heap. - /// The default is set to ≈ 32K. /// [Range(1, MaxBodyReadSize)] public int BodySizeLimit { get; set; } = DefaultBodyReadSizeLimit; diff --git a/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs b/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs index d23128360b6..db55f72bdc6 100644 --- a/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs +++ b/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs @@ -21,7 +21,7 @@ public class HttpTracingOptions /// Gets or sets a map between HTTP request parameters and their data classification. /// /// - /// The default value is . + /// The default is an empty . /// /// /// If a parameter in requestUrl is not found in this map, it will be redacted as if it was . @@ -35,19 +35,19 @@ public class HttpTracingOptions /// /// Gets or sets a value indicating whether to include path with redacted parameters. /// - /// - /// When false, the exported traces will contain the route template. - /// When true, the request path will be recreated using the redacted parameter and included in the exported traces. - /// The default value is false. - /// + /// + /// if the request path is recreated using the redacted parameter and included in the exported traces; if the exported traces contain the route template. The default is . + /// public bool IncludePath { get; set; } /// /// Gets or sets a value indicating how the HTTP path parameter should be redacted. /// + /// + /// The default is . + /// /// - /// The default is set to . - /// It is applicable when option is enabled. + /// This property is applicable when the option is enabled. /// [Experimental] public HttpRouteParameterRedactionMode RequestPathParameterRedactionMode { get; set; } = DefaultPathParameterRedactionMode; @@ -56,7 +56,7 @@ public class HttpTracingOptions /// Gets or sets a list of paths to exclude when auto collecting traces. /// /// - /// Traces for requests matching the exclusion list will not be exported. + /// Traces for requests matching the exclusion list are not exported. /// [SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "Options pattern.")] [Required] From 1769318eefe0da048f797c7e394a5db12d45fd7f Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Mon, 12 Jun 2023 20:25:37 -0700 Subject: [PATCH 3/3] shorten long lines --- .../Tracing/HttpTracingOptions.cs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs b/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs index db55f72bdc6..baf648ebaf6 100644 --- a/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs +++ b/src/Libraries/Microsoft.AspNetCore.Telemetry/Tracing/HttpTracingOptions.cs @@ -36,7 +36,9 @@ public class HttpTracingOptions /// Gets or sets a value indicating whether to include path with redacted parameters. /// /// - /// if the request path is recreated using the redacted parameter and included in the exported traces; if the exported traces contain the route template. The default is . + /// if the request path is recreated using the redacted parameter and included in the + /// exported traces; if the exported traces contain the route template. + /// The default is . /// public bool IncludePath { get; set; }