Skip to content

Commit

Permalink
Fix some XML docs inaccuracies
Browse files Browse the repository at this point in the history
  • Loading branch information
martintmk committed Sep 15, 2023
1 parent 49726ab commit 0e6735c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ internal AddResiliencePipelineContext(ConfigureBuilderContext<TKey> registryCont
/// You can decide based on the <paramref name="name"/> to listen for changes in global options or named options.
/// If <paramref name="name"/> is <see langword="null"/> then the global options are listened to.
/// <para>
/// You can listen for changes only for single options. If you call this method multiple times, the preceding calls are ignored and only the last one wins.
/// You can listen for changes from multiple options by calling this method with different <typeparamref name="TOptions"/> types.
/// </para>
/// </remarks>
public void EnableReloads<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)] TOptions>(string? name = null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,14 @@ namespace Polly;
public static class PollyServiceCollectionExtensions
{
/// <summary>
/// Adds a generic resilience pipeline to service collection.
/// Adds a resilience pipeline that handles <typeparamref name="TResult"/> to service collection.
/// </summary>
/// <typeparam name="TKey">The type of the key used to identify the resilience pipeline.</typeparam>
/// <typeparam name="TResult">The type of result that the resilience pipeline handles.</typeparam>
/// <param name="services">The <see cref="IServiceCollection"/> to add the resilience pipeline to.</param>
/// <param name="key">The key used to identify the resilience pipeline.</param>
/// <param name="configure">An action that configures the resilience pipeline.</param>
/// <returns>The updated <see cref="IServiceCollection"/> with the registered resilience pipeline.</returns>
/// <exception cref="InvalidOperationException">Thrown if the resilience pipeline builder with the provided key has already been added to the registry.</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="services"/> or <paramref name="configure"/> is <see langword="null"/>.</exception>
/// <remarks>
/// You can retrieve the registered pipeline by resolving the <see cref="ResiliencePipelineProvider{TKey}"/> class from the dependency injection container.
Expand All @@ -45,15 +44,14 @@ public static IServiceCollection AddResiliencePipeline<TKey, TResult>(
}

/// <summary>
/// Adds a generic resilience pipeline to service collection.
/// Adds a resilience pipeline that handles <typeparamref name="TResult"/> to service collection.
/// </summary>
/// <typeparam name="TKey">The type of the key used to identify the resilience pipeline.</typeparam>
/// <typeparam name="TResult">The type of result that the resilience pipeline handles.</typeparam>
/// <param name="services">The <see cref="IServiceCollection"/> to add the resilience pipeline to.</param>
/// <param name="key">The key used to identify the resilience pipeline.</param>
/// <param name="configure">An action that configures the resilience pipeline.</param>
/// <returns>The updated <see cref="IServiceCollection"/> with the registered resilience pipeline.</returns>
/// <exception cref="InvalidOperationException">Thrown if the resilience pipeline builder with the provided key has already been added to the registry.</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="services"/> or <paramref name="configure"/> is <see langword="null"/>.</exception>
/// <remarks>
/// You can retrieve the registered pipeline by resolving the <see cref="ResiliencePipelineProvider{TKey}"/> class from the dependency injection container.
Expand Down Expand Up @@ -94,7 +92,6 @@ public static IServiceCollection AddResiliencePipeline<TKey, TResult>(
/// <param name="key">The key used to identify the resilience pipeline.</param>
/// <param name="configure">An action that configures the resilience pipeline.</param>
/// <returns>The updated <see cref="IServiceCollection"/> with the registered resilience pipeline.</returns>
/// <exception cref="InvalidOperationException">Thrown if the resilience pipeline builder with the provided key has already been added to the registry.</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="services"/> or <paramref name="configure"/> is <see langword="null"/>.</exception>
/// <remarks>
/// You can retrieve the registered pipeline by resolving the <see cref="ResiliencePipelineProvider{TKey}"/> class from the dependency injection container.
Expand Down Expand Up @@ -122,7 +119,6 @@ public static IServiceCollection AddResiliencePipeline<TKey>(
/// <param name="key">The key used to identify the resilience pipeline.</param>
/// <param name="configure">An action that configures the resilience pipeline.</param>
/// <returns>The updated <see cref="IServiceCollection"/> with the registered resilience pipeline.</returns>
/// <exception cref="InvalidOperationException">Thrown if the resilience pipeline builder with the provided key has already been added to the registry.</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="services"/> or <paramref name="configure"/> is <see langword="null"/>.</exception>
/// <remarks>
/// You can retrieve the registered pipeline by resolving the <see cref="ResiliencePipelineProvider{TKey}"/> class from the dependency injection container.
Expand Down Expand Up @@ -157,7 +153,7 @@ public static IServiceCollection AddResiliencePipeline<TKey>(
}

/// <summary>
/// Adds <see cref="ResiliencePipelineRegistry{TKey}"/> and <see cref="ResiliencePipelineProvider{TKey}"/> that allows configuring
/// Adds <see cref="ResiliencePipelineRegistry{TKey}"/> and <see cref="ResiliencePipelineProvider{TKey}"/> to service collection that allows configuring
/// and retrieving resilience pipelines using the <typeparamref name="TKey"/> key.
/// </summary>
/// <typeparam name="TKey">The type of the key used to identify the resilience pipeline.</typeparam>
Expand All @@ -183,7 +179,7 @@ public static IServiceCollection AddResiliencePipelineRegistry<TKey>(
}

/// <summary>
/// Adds <see cref="ResiliencePipelineRegistry{TKey}"/> and <see cref="ResiliencePipelineProvider{TKey}"/> that allows configuring
/// Adds <see cref="ResiliencePipelineRegistry{TKey}"/> and <see cref="ResiliencePipelineProvider{TKey}"/> to service collection that allows configuring
/// and retrieving resilience pipelines using the <typeparamref name="TKey"/> key.
/// </summary>
/// <typeparam name="TKey">The type of the key used to identify the resilience pipeline.</typeparam>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public static class ConfigureBuilderContextExtensions
/// You can decide based on the <paramref name="name"/> to listen for changes in global options or named options.
/// If <paramref name="name"/> is <see langword="null"/> then the global options are listened to.
/// <para>
/// You can listen for changes only for single options. If you call this method multiple times, the preceding calls are ignored and only the last one wins.
/// You can listen for changes from multiple options by calling this method with different <typeparamref name="TOptions"/> types.
/// </para>
/// </remarks>
public static void EnableReloads<TKey, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)] TOptions>(
Expand Down

0 comments on commit 0e6735c

Please sign in to comment.