diff --git a/src/Polly/AsyncPolicy.ContextAndKeys.cs b/src/Polly/AsyncPolicy.ContextAndKeys.cs index 7ba44c96a74..6583d758ea1 100644 --- a/src/Polly/AsyncPolicy.ContextAndKeys.cs +++ b/src/Polly/AsyncPolicy.ContextAndKeys.cs @@ -7,6 +7,7 @@ public abstract partial class AsyncPolicy /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . public AsyncPolicy WithPolicyKey(string policyKey) { if (policyKeyInternal != null) @@ -23,6 +24,7 @@ public AsyncPolicy WithPolicyKey(string policyKey) /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . IAsyncPolicy IAsyncPolicy.WithPolicyKey(string policyKey) { if (policyKeyInternal != null) @@ -42,6 +44,7 @@ public abstract partial class AsyncPolicy /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . public AsyncPolicy WithPolicyKey(string policyKey) { if (policyKeyInternal != null) @@ -58,6 +61,7 @@ public AsyncPolicy WithPolicyKey(string policyKey) /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . IAsyncPolicy IAsyncPolicy.WithPolicyKey(string policyKey) { if (policyKeyInternal != null) diff --git a/src/Polly/AsyncPolicy.ExecuteOverloads.cs b/src/Polly/AsyncPolicy.ExecuteOverloads.cs index af804d5d395..232ba2a3a9a 100644 --- a/src/Polly/AsyncPolicy.ExecuteOverloads.cs +++ b/src/Polly/AsyncPolicy.ExecuteOverloads.cs @@ -8,6 +8,7 @@ public abstract partial class AsyncPolicy : PolicyBase, IAsyncPolicy /// Executes the specified asynchronous action within the policy. /// /// The action to perform. + /// A which completes when is registered. [DebuggerStepThrough] public Task ExecuteAsync(Func action) => ExecuteAsync((_, _) => action(), [], DefaultCancellationToken, DefaultContinueOnCapturedContext); @@ -17,6 +18,7 @@ public Task ExecuteAsync(Func action) => /// /// The action to perform. /// Arbitrary data that is passed to the exception policy. + /// A which completes when is registered. [DebuggerStepThrough] public Task ExecuteAsync(Func action, IDictionary contextData) => ExecuteAsync((ctx, _) => action(ctx), new Context(contextData), DefaultCancellationToken, DefaultContinueOnCapturedContext); @@ -26,6 +28,7 @@ public Task ExecuteAsync(Func action, IDictionary /// /// The action to perform. /// Context data that is passed to the exception policy. + /// A which completes when is registered. [DebuggerStepThrough] public Task ExecuteAsync(Func action, Context context) => ExecuteAsync((ctx, _) => action(ctx), context, DefaultCancellationToken, DefaultContinueOnCapturedContext); @@ -35,6 +38,7 @@ public Task ExecuteAsync(Func action, Context context) => /// /// The action to perform. /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. + /// A which completes when is registered. [DebuggerStepThrough] public Task ExecuteAsync(Func action, CancellationToken cancellationToken) => ExecuteAsync((_, ct) => action(ct), [], cancellationToken, DefaultContinueOnCapturedContext); @@ -45,6 +49,7 @@ public Task ExecuteAsync(Func action, CancellationToken /// The action to perform. /// Arbitrary data that is passed to the exception policy. /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. + /// A which completes when is registered. [DebuggerStepThrough] public Task ExecuteAsync(Func action, IDictionary contextData, CancellationToken cancellationToken) => ExecuteAsync(action, new Context(contextData), cancellationToken, DefaultContinueOnCapturedContext); @@ -55,6 +60,7 @@ public Task ExecuteAsync(Func action, IDiction /// The action to perform. /// Context data that is passed to the exception policy. /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. + /// A which completes when is registered. [DebuggerStepThrough] public Task ExecuteAsync(Func action, Context context, CancellationToken cancellationToken) => ExecuteAsync(action, context, cancellationToken, DefaultContinueOnCapturedContext); @@ -66,6 +72,7 @@ public Task ExecuteAsync(Func action, Context /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. /// Whether to continue on a captured synchronization context. /// Please use asynchronous-defined policies when calling asynchronous ExecuteAsync (and similar) methods. + /// A which completes when is registered. [DebuggerStepThrough] public Task ExecuteAsync(Func action, CancellationToken cancellationToken, bool continueOnCapturedContext) => ExecuteAsync((_, ct) => action(ct), [], cancellationToken, continueOnCapturedContext); @@ -78,6 +85,7 @@ public Task ExecuteAsync(Func action, CancellationToken /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. /// Whether to continue on a captured synchronization context. /// Thrown when is . + /// A which completes when is registered. [DebuggerStepThrough] public Task ExecuteAsync(Func action, IDictionary contextData, CancellationToken cancellationToken, bool continueOnCapturedContext) => ExecuteAsync(action, new Context(contextData), cancellationToken, continueOnCapturedContext); @@ -90,6 +98,7 @@ public Task ExecuteAsync(Func action, IDiction /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. /// Whether to continue on a captured synchronization context. /// Please use asynchronous-defined policies when calling asynchronous ExecuteAsync (and similar) methods. + /// A which completes when is registered. [DebuggerStepThrough] public async Task ExecuteAsync(Func action, Context context, CancellationToken cancellationToken, bool continueOnCapturedContext) { @@ -277,6 +286,7 @@ public Task ExecuteAndCaptureAsync(Func action, Con /// /// The action to perform. /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. + /// The captured result. [DebuggerStepThrough] public Task ExecuteAndCaptureAsync(Func action, CancellationToken cancellationToken) => ExecuteAndCaptureAsync((_, ct) => action(ct), [], cancellationToken, DefaultContinueOnCapturedContext); @@ -299,6 +309,7 @@ public Task ExecuteAndCaptureAsync(FuncThe action to perform. /// Context data that is passed to the exception policy. /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. + /// The captured result. [DebuggerStepThrough] public Task ExecuteAndCaptureAsync(Func action, Context context, CancellationToken cancellationToken) => ExecuteAndCaptureAsync(action, context, cancellationToken, DefaultContinueOnCapturedContext); @@ -310,6 +321,7 @@ public Task ExecuteAndCaptureAsync(FuncA cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. /// Whether to continue on a captured synchronization context. /// Please use asynchronous-defined policies when calling asynchronous ExecuteAsync (and similar) methods. + /// The captured result. [DebuggerStepThrough] public Task ExecuteAndCaptureAsync(Func action, CancellationToken cancellationToken, bool continueOnCapturedContext) => ExecuteAndCaptureAsync((_, ct) => action(ct), [], cancellationToken, continueOnCapturedContext); @@ -335,6 +347,7 @@ public Task ExecuteAndCaptureAsync(FuncA cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. /// Whether to continue on a captured synchronization context. /// Please use asynchronous-defined policies when calling asynchronous ExecuteAsync (and similar) methods. + /// The captured result. [DebuggerStepThrough] public async Task ExecuteAndCaptureAsync(Func action, Context context, CancellationToken cancellationToken, bool continueOnCapturedContext) { diff --git a/src/Polly/Context.cs b/src/Polly/Context.cs index e66f3916370..0eff0ca8f45 100644 --- a/src/Polly/Context.cs +++ b/src/Polly/Context.cs @@ -25,24 +25,25 @@ public Context() } /// + /// Gets the wrapped . /// When execution is through a , identifies the PolicyWrap executing the current delegate by returning the of the outermost layer in the PolicyWrap; otherwise, null. /// public string PolicyWrapKey { get; internal set; } /// - /// The of the policy instance executing the current delegate. + /// Gets the of the policy instance executing the current delegate. /// public string PolicyKey { get; internal set; } /// - /// A key unique to the call site of the current execution. + /// Gets a key unique to the call site of the current execution. /// Policy instances are commonly reused across multiple call sites. Set an OperationKey so that logging and metrics can distinguish usages of policy instances at different call sites. /// The value is set by using the constructor taking an operationKey parameter. /// public string OperationKey { get; } /// - /// A Guid guaranteed to be unique to each execution. + /// Gets a GUID guaranteed to be unique to each execution. /// Acts as a correlation id so that events specific to a single execution can be identified in logging and telemetry. /// public Guid CorrelationId diff --git a/src/Polly/DelegateResult.cs b/src/Polly/DelegateResult.cs index 6012b5664db..81541c61d2a 100644 --- a/src/Polly/DelegateResult.cs +++ b/src/Polly/DelegateResult.cs @@ -20,12 +20,12 @@ public DelegateResult(Exception exception) => Exception = exception; /// - /// The result of executing the delegate. Will be default(TResult) if an exception was thrown. + /// Gets the result of executing the delegate. Will be default(TResult) if an exception was thrown. /// public TResult Result { get; } /// - /// Any exception thrown while executing the delegate. Will be null if policy executed without exception. + /// Gets the exception thrown while executing the delegate. Will be null if policy executed without exception. /// public Exception Exception { get; } } diff --git a/src/Polly/IAsyncPolicy.TResult.cs b/src/Polly/IAsyncPolicy.TResult.cs index 51519a248f3..3ac40611abc 100644 --- a/src/Polly/IAsyncPolicy.TResult.cs +++ b/src/Polly/IAsyncPolicy.TResult.cs @@ -11,6 +11,7 @@ public interface IAsyncPolicy : IsPolicy /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . IAsyncPolicy WithPolicyKey(string policyKey); /// diff --git a/src/Polly/IAsyncPolicy.cs b/src/Polly/IAsyncPolicy.cs index 387650d7410..205770a5892 100644 --- a/src/Polly/IAsyncPolicy.cs +++ b/src/Polly/IAsyncPolicy.cs @@ -10,12 +10,14 @@ public interface IAsyncPolicy : IsPolicy /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . IAsyncPolicy WithPolicyKey(string policyKey); /// /// Executes the specified asynchronous action within the policy. /// /// The action to perform. + /// A which completes when is registered. Task ExecuteAsync(Func action); /// @@ -23,6 +25,7 @@ public interface IAsyncPolicy : IsPolicy /// /// The action to perform. /// Arbitrary data that is passed to the exception policy. + /// A which completes when is registered. Task ExecuteAsync(Func action, IDictionary contextData); /// @@ -30,6 +33,7 @@ public interface IAsyncPolicy : IsPolicy /// /// The action to perform. /// Context data that is passed to the exception policy. + /// A which completes when is registered. Task ExecuteAsync(Func action, Context context); /// @@ -37,6 +41,7 @@ public interface IAsyncPolicy : IsPolicy /// /// The action to perform. /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. + /// A which completes when is registered. Task ExecuteAsync(Func action, CancellationToken cancellationToken); /// @@ -45,6 +50,7 @@ public interface IAsyncPolicy : IsPolicy /// The action to perform. /// Arbitrary data that is passed to the exception policy. /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. + /// A which completes when is registered. Task ExecuteAsync(Func action, IDictionary contextData, CancellationToken cancellationToken); /// @@ -53,6 +59,7 @@ public interface IAsyncPolicy : IsPolicy /// The action to perform. /// Context data that is passed to the exception policy. /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. + /// A which completes when is registered. Task ExecuteAsync(Func action, Context context, CancellationToken cancellationToken); /// @@ -62,6 +69,7 @@ public interface IAsyncPolicy : IsPolicy /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. /// Whether to continue on a captured synchronization context. /// Please use asynchronous-defined policies when calling asynchronous ExecuteAsync (and similar) methods. + /// A which completes when is registered. Task ExecuteAsync(Func action, CancellationToken cancellationToken, bool continueOnCapturedContext); /// @@ -72,6 +80,7 @@ public interface IAsyncPolicy : IsPolicy /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. /// Whether to continue on a captured synchronization context. /// Thrown when is . + /// A which completes when is registered. Task ExecuteAsync(Func action, IDictionary contextData, CancellationToken cancellationToken, bool continueOnCapturedContext); /// @@ -82,6 +91,7 @@ public interface IAsyncPolicy : IsPolicy /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. /// Whether to continue on a captured synchronization context. /// Please use asynchronous-defined policies when calling asynchronous ExecuteAsync (and similar) methods. + /// A which completes when is registered. Task ExecuteAsync(Func action, Context context, CancellationToken cancellationToken, bool continueOnCapturedContext); /// @@ -203,6 +213,7 @@ public interface IAsyncPolicy : IsPolicy /// /// The action to perform. /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. + /// The captured result. Task ExecuteAndCaptureAsync(Func action, CancellationToken cancellationToken); /// @@ -221,6 +232,7 @@ public interface IAsyncPolicy : IsPolicy /// The action to perform. /// Context data that is passed to the exception policy. /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. + /// The captured result. Task ExecuteAndCaptureAsync(Func action, Context context, CancellationToken cancellationToken); /// @@ -230,6 +242,7 @@ public interface IAsyncPolicy : IsPolicy /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. /// Whether to continue on a captured synchronization context. /// Please use asynchronous-defined policies when calling asynchronous ExecuteAsync (and similar) methods. + /// An instance of . Task ExecuteAndCaptureAsync(Func action, CancellationToken cancellationToken, bool continueOnCapturedContext); /// @@ -251,6 +264,7 @@ public interface IAsyncPolicy : IsPolicy /// A cancellation token which can be used to cancel the action. When a retry policy in use, also cancels any further retries. /// Whether to continue on a captured synchronization context. /// Please use asynchronous-defined policies when calling asynchronous ExecuteAsync (and similar) methods. + /// The captured result. Task ExecuteAndCaptureAsync(Func action, Context context, CancellationToken cancellationToken, bool continueOnCapturedContext); /// diff --git a/src/Polly/ISyncPolicy.TResult.cs b/src/Polly/ISyncPolicy.TResult.cs index 7d7edc14f41..208c6762ea7 100644 --- a/src/Polly/ISyncPolicy.TResult.cs +++ b/src/Polly/ISyncPolicy.TResult.cs @@ -11,6 +11,7 @@ public interface ISyncPolicy : IsPolicy /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . ISyncPolicy WithPolicyKey(string policyKey); /// diff --git a/src/Polly/ISyncPolicy.cs b/src/Polly/ISyncPolicy.cs index e14f7f5f202..1f72b20a135 100644 --- a/src/Polly/ISyncPolicy.cs +++ b/src/Polly/ISyncPolicy.cs @@ -10,6 +10,7 @@ public interface ISyncPolicy : IsPolicy /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . ISyncPolicy WithPolicyKey(string policyKey); /// diff --git a/src/Polly/IsPolicy.cs b/src/Polly/IsPolicy.cs index 6a03837b5bd..fcdbf7d46ee 100644 --- a/src/Polly/IsPolicy.cs +++ b/src/Polly/IsPolicy.cs @@ -6,7 +6,7 @@ public interface IsPolicy { /// - /// A key intended to be unique to each policy instance, which is passed with executions as the property. + /// Gets a key intended to be unique to each policy instance, which is passed with executions as the property. /// string PolicyKey { get; } } diff --git a/src/Polly/Policy.ContextAndKeys.cs b/src/Polly/Policy.ContextAndKeys.cs index cc68f5768dc..9c9361bb4fb 100644 --- a/src/Polly/Policy.ContextAndKeys.cs +++ b/src/Polly/Policy.ContextAndKeys.cs @@ -7,6 +7,7 @@ public abstract partial class Policy /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . public Policy WithPolicyKey(string policyKey) { if (policyKeyInternal != null) @@ -23,6 +24,7 @@ public Policy WithPolicyKey(string policyKey) /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . ISyncPolicy ISyncPolicy.WithPolicyKey(string policyKey) { if (policyKeyInternal != null) @@ -42,6 +44,7 @@ public abstract partial class Policy /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . public Policy WithPolicyKey(string policyKey) { if (policyKeyInternal != null) @@ -58,6 +61,7 @@ public Policy WithPolicyKey(string policyKey) /// Must be called before the policy is first used. Can only be set once. /// /// The unique, used-definable key to assign to this instance. + /// An instance of . ISyncPolicy ISyncPolicy.WithPolicyKey(string policyKey) { if (policyKeyInternal != null) diff --git a/src/Polly/PolicyBase.ContextAndKeys.cs b/src/Polly/PolicyBase.ContextAndKeys.cs index e9127f8a8c0..6a3f6325b03 100644 --- a/src/Polly/PolicyBase.ContextAndKeys.cs +++ b/src/Polly/PolicyBase.ContextAndKeys.cs @@ -8,7 +8,7 @@ public abstract partial class PolicyBase protected string policyKeyInternal; /// - /// A key intended to be unique to each instance, which is passed with executions as the property. + /// Gets a key intended to be unique to each instance, which is passed with executions as the property. /// public string PolicyKey => policyKeyInternal ?? (policyKeyInternal = GetType().Name + "-" + KeyHelper.GuidPart()); diff --git a/src/Polly/PolicyBase.cs b/src/Polly/PolicyBase.cs index 9451c44b918..11c1d6abe8f 100644 --- a/src/Polly/PolicyBase.cs +++ b/src/Polly/PolicyBase.cs @@ -11,7 +11,7 @@ public abstract partial class PolicyBase internal const bool DefaultContinueOnCapturedContext = false; /// - /// Predicates indicating which exceptions the policy handles. + /// Gets the predicates indicating which exceptions the policy handles. /// protected internal ExceptionPredicates ExceptionPredicates { get; } @@ -53,7 +53,7 @@ protected PolicyBase(PolicyBuilder policyBuilder) public abstract class PolicyBase : PolicyBase { /// - /// Predicates indicating which results the policy handles. + /// Gets the predicates indicating which results the policy handles. /// protected internal ResultPredicates ResultPredicates { get; } diff --git a/src/Polly/PolicyBuilder.cs b/src/Polly/PolicyBuilder.cs index 0169dea8e3c..bc3e2f58c53 100644 --- a/src/Polly/PolicyBuilder.cs +++ b/src/Polly/PolicyBuilder.cs @@ -14,7 +14,7 @@ internal PolicyBuilder(ExceptionPredicate exceptionPredicate) } /// - /// Predicates specifying exceptions that the policy is being configured to handle. + /// Gets the predicates specifying exceptions that the policy is being configured to handle. /// internal ExceptionPredicates ExceptionPredicates { get; } @@ -87,12 +87,12 @@ internal PolicyBuilder(ExceptionPredicates exceptionPredicates) ExceptionPredicates = exceptionPredicates; /// - /// Predicates specifying exceptions that the policy is being configured to handle. + /// Gets the predicates specifying exceptions that the policy is being configured to handle. /// internal ExceptionPredicates ExceptionPredicates { get; } /// - /// Predicates specifying results that the policy is being configured to handle. + /// Gets the predicates specifying results that the policy is being configured to handle. /// internal ResultPredicates ResultPredicates { get; } diff --git a/src/Polly/PolicyResult.cs b/src/Polly/PolicyResult.cs index 7446035b312..25dea3fc83e 100644 --- a/src/Polly/PolicyResult.cs +++ b/src/Polly/PolicyResult.cs @@ -14,22 +14,22 @@ internal PolicyResult(OutcomeType outcome, Exception finalException, ExceptionTy } /// - /// The outcome of executing the policy. + /// Gets the outcome of executing the policy. /// public OutcomeType Outcome { get; } /// - /// The final exception captured. Will be null if policy executed successfully. + /// Gets the final exception captured. Will be null if policy executed successfully. /// public Exception FinalException { get; } /// - /// The exception type of the final exception captured. Will be null if policy executed successfully. + /// Gets the exception type of the final exception captured. Will be null if policy executed successfully. /// public ExceptionType? ExceptionType { get; } /// - /// The context for this execution. + /// Gets the context for this execution. /// public Context Context { get; } @@ -79,37 +79,37 @@ internal PolicyResult(TResult result, OutcomeType outcome, Exception finalExcept } /// - /// The outcome of executing the policy. + /// Gets the outcome of executing the policy. /// public OutcomeType Outcome { get; } /// - /// The final exception captured. Will be null if policy executed without exception. + /// Gets the final exception captured. Will be null if policy executed without exception. /// public Exception FinalException { get; } /// - /// The exception type of the final exception captured. Will be null if policy executed successfully. + /// Gets the exception type of the final exception captured. Will be null if policy executed successfully. /// public ExceptionType? ExceptionType { get; } /// - /// The result of executing the policy. Will be default(TResult) if the policy failed. + /// Gets the result of executing the policy. Will be default(TResult) if the policy failed. /// public TResult Result { get; } /// - /// The final handled result captured. Will be default(TResult) if the policy executed successfully, or terminated with an exception. + /// Gets the final handled result captured. Will be default(TResult) if the policy executed successfully, or terminated with an exception. /// public TResult FinalHandledResult { get; } /// - /// The fault type of the final fault captured. Will be null if policy executed successfully. + /// Gets the fault type of the final fault captured. Will be null if policy executed successfully. /// public FaultType? FaultType { get; } /// - /// The context for this execution. + /// Gets the context for this execution. /// public Context Context { get; } diff --git a/src/Polly/Polly.csproj b/src/Polly/Polly.csproj index 09707cbbe14..b7353686b1c 100644 --- a/src/Polly/Polly.csproj +++ b/src/Polly/Polly.csproj @@ -9,8 +9,8 @@ true $(NoWarn);S3872;SA1414;S3215 $(NoWarn);IDE1006;CA1062;CA1068;S4039;CA1063;CA1031;CA1051 - $(NoWarn);CA2211;S2223;CA1032;CA1815;CA1816;S4457;SA1615;CA1033 - $(NoWarn);CA1010;CA1064;SA1623;SA1118 + $(NoWarn);CA2211;S2223;CA1032;CA1815;CA1816;S4457;CA1033 + $(NoWarn);CA1010;CA1064;SA1118 $(NoWarn);S3971;CA1724;CA1716;SA1108;CA1710;S4049;S3246 $(NoWarn);CA1805 diff --git a/src/Polly/RateLimit/IRateLimiter.cs b/src/Polly/RateLimit/IRateLimiter.cs index edbeef66de7..b977008e49b 100644 --- a/src/Polly/RateLimit/IRateLimiter.cs +++ b/src/Polly/RateLimit/IRateLimiter.cs @@ -11,5 +11,9 @@ internal interface IRateLimiter /// Returns whether the execution is permitted; if not, returns what should be waited before retrying. /// Calling this method consumes an execution permit if one is available: a caller receiving a return value true should make an execution. /// + /// + /// A tuple whose first element is a value indicating whether the execution is permitted, + /// and whose second element is the what should be waited before retrying. + /// (bool PermitExecution, TimeSpan RetryAfter) PermitExecution(); } diff --git a/src/Polly/RateLimit/RateLimitRejectedException.cs b/src/Polly/RateLimit/RateLimitRejectedException.cs index a1524edf270..3a7c9a2f5e1 100644 --- a/src/Polly/RateLimit/RateLimitRejectedException.cs +++ b/src/Polly/RateLimit/RateLimitRejectedException.cs @@ -17,7 +17,7 @@ namespace Polly.RateLimit; public class RateLimitRejectedException : ExecutionRejectedException { /// - /// The timespan after which the operation may be retried. + /// Gets the timespan after which the operation may be retried. /// public TimeSpan RetryAfter { get; private set; } diff --git a/src/Polly/Registry/IReadOnlyPolicyRegistry.cs b/src/Polly/Registry/IReadOnlyPolicyRegistry.cs index 5ef42d3dc8a..b9a551f2b22 100644 --- a/src/Polly/Registry/IReadOnlyPolicyRegistry.cs +++ b/src/Polly/Registry/IReadOnlyPolicyRegistry.cs @@ -41,7 +41,7 @@ bool TryGet(TKey key, out TPolicy policy) where TPolicy : IsPolicy; /// - /// Total number of policies in the registry. + /// Gets the total number of policies in the registry. /// int Count { get; } diff --git a/src/Polly/Registry/PolicyRegistry.cs b/src/Polly/Registry/PolicyRegistry.cs index 34169e35d22..eb33aad8a6c 100644 --- a/src/Polly/Registry/PolicyRegistry.cs +++ b/src/Polly/Registry/PolicyRegistry.cs @@ -39,7 +39,7 @@ private ConcurrentDictionary ThrowIfNotConcurrentImplementatio } /// - /// Total number of policies in the registry. + /// Gets the total number of policies in the registry. /// public int Count => _registry.Count; diff --git a/src/Polly/ResultPredicates.cs b/src/Polly/ResultPredicates.cs index d5007f19e67..cc440c423cc 100644 --- a/src/Polly/ResultPredicates.cs +++ b/src/Polly/ResultPredicates.cs @@ -19,6 +19,7 @@ internal void Add(ResultPredicate predicate) /// Returns a bool indicating whether the passed value matched any predicates. /// /// The value to assess against the predicates. + /// if value matches any predicates. otherwise. public bool AnyMatch(TResult result) { if (_predicates == null) diff --git a/src/Polly/Wrap/AsyncPolicyWrap.cs b/src/Polly/Wrap/AsyncPolicyWrap.cs index c37148196c7..f82adc34b57 100644 --- a/src/Polly/Wrap/AsyncPolicyWrap.cs +++ b/src/Polly/Wrap/AsyncPolicyWrap.cs @@ -9,12 +9,12 @@ public partial class AsyncPolicyWrap : AsyncPolicy, IPolicyWrap private readonly IAsyncPolicy _inner; /// - /// Returns the outer in this . + /// Gets the outer in this . /// public IsPolicy Outer => _outer; /// - /// Returns the next inner in this . + /// Gets the next inner in this . /// public IsPolicy Inner => _inner; @@ -66,12 +66,12 @@ public partial class AsyncPolicyWrap : AsyncPolicy, IPolicyWra private readonly IAsyncPolicy _innerGeneric; /// - /// Returns the outer in this . + /// Gets the outer in this . /// public IsPolicy Outer => (IsPolicy)_outerGeneric ?? _outerNonGeneric; /// - /// Returns the next inner in this . + /// Gets the next inner in this . /// public IsPolicy Inner => (IsPolicy)_innerGeneric ?? _innerNonGeneric; diff --git a/src/Polly/Wrap/IPolicyWrap.cs b/src/Polly/Wrap/IPolicyWrap.cs index b8535ea78bd..071c170edc8 100644 --- a/src/Polly/Wrap/IPolicyWrap.cs +++ b/src/Polly/Wrap/IPolicyWrap.cs @@ -6,12 +6,12 @@ public interface IPolicyWrap : IsPolicy { /// - /// Returns the outer in this . + /// Gets the outer in this . /// IsPolicy Outer { get; } /// - /// Returns the next inner in this . + /// Gets the next inner in this . /// IsPolicy Inner { get; } } diff --git a/src/Polly/Wrap/PolicyWrap.cs b/src/Polly/Wrap/PolicyWrap.cs index 27aebef6127..f6bde0b768a 100644 --- a/src/Polly/Wrap/PolicyWrap.cs +++ b/src/Polly/Wrap/PolicyWrap.cs @@ -9,12 +9,12 @@ public partial class PolicyWrap : Policy, IPolicyWrap private readonly ISyncPolicy _inner; /// - /// Returns the outer in this . + /// Gets the outer in this . /// public IsPolicy Outer => _outer; /// - /// Returns the next inner in this . + /// Gets the next inner in this . /// public IsPolicy Inner => _inner; @@ -59,12 +59,12 @@ public partial class PolicyWrap : Policy, IPolicyWrap private readonly ISyncPolicy _innerGeneric; /// - /// Returns the outer in this . + /// Gets the outer in this . /// public IsPolicy Outer => (IsPolicy)_outerGeneric ?? _outerNonGeneric; /// - /// Returns the next inner in this . + /// Gets the next inner in this . /// public IsPolicy Inner => (IsPolicy)_innerGeneric ?? _innerNonGeneric;