Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: xml docs corrections #639

Merged
merged 1 commit into from
Feb 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ public static class FinbuckleMultiTenantBuilderExtensions
}

/// <summary>
/// Adds and configures a HeaderStrategy with tenantKey "__tenant__" to the application.
/// Adds and configures a HeaderStrategy with using HTTP header key "__tenant__" to the application.
/// </summary>
/// <returns>The same MultiTenantBuilder passed into the method.</returns>
public static FinbuckleMultiTenantBuilder<TTenantInfo> WithHeaderStrategy<TTenantInfo>(
Expand All @@ -368,10 +368,10 @@ public static class FinbuckleMultiTenantBuilderExtensions
}

/// <summary>
/// Adds and configures a Header to the application.
/// Adds and configures a HeaderStrategy to the application with a custom HTTP header key.
/// </summary>
/// <param name="builder">MultiTenantBuilder instance.</param>
/// <param name="tenantKey">The template for determining the tenant identifier in the host.</param>
/// <param name="tenantKey">The HTTP header key for determining the tenant identifier in the request.</param>
/// <returns>The same MultiTenantBuilder passed into the method.</returns>
public static FinbuckleMultiTenantBuilder<TTenantInfo> WithHeaderStrategy<TTenantInfo>(
this FinbuckleMultiTenantBuilder<TTenantInfo> builder, string tenantKey)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public FinbuckleMultiTenantBuilder(IServiceCollection services)
// Handles multiplexing cached options.
Services.TryAddSingleton<IOptionsMonitorCache<TOptions>, MultiTenantOptionsCache<TOptions, TTenantInfo>>();

// Necessary to apply tenant named options in between configuration and postconfiguration
// Necessary to apply tenant named options in between configuration and post configuration
Services.AddSingleton<ITenantConfigureNamedOptions<TOptions, TTenantInfo>,
TenantConfigureNamedOptions<TOptions, TTenantInfo>>(sp => new TenantConfigureNamedOptions<TOptions,
TTenantInfo>(name, tenantConfigureNamedOptions));
Expand All @@ -87,7 +87,7 @@ private static MultiTenantOptionsManager<TOptions> BuildOptionsManager<TOptions>
/// Adds and configures a IMultiTenantStore to the application using default dependency injection.
/// </summary>>
/// <param name="lifetime">The service lifetime.</param>
/// <param name="parameters">a paramter list for any constructor paramaters not covered by dependency injection.</param>
/// <param name="parameters">a parameter list for any constructor parameters not covered by dependency injection.</param>
/// <returns>The same MultiTenantBuilder passed into the method.</returns>
public FinbuckleMultiTenantBuilder<TTenantInfo> WithStore<TStore>(ServiceLifetime lifetime,
params object[] parameters)
Expand Down Expand Up @@ -117,10 +117,10 @@ private static MultiTenantOptionsManager<TOptions> BuildOptionsManager<TOptions>
}

/// <summary>
/// Adds and configures a IMultiTenantStrategy to the applicationusing default dependency injection.
/// Adds and configures a IMultiTenantStrategy to the application using default dependency injection.
/// </summary>
/// <param name="lifetime">The service lifetime.</param>
/// <param name="parameters">a paramter list for any constructor paramaters not covered by dependency injection.</param>
/// <param name="parameters">a parameter list for any constructor parameters not covered by dependency injection.</param>
/// <returns>The same MultiTenantBuilder passed into the method.</returns>
public FinbuckleMultiTenantBuilder<TTenantInfo> WithStrategy<TStrategy>(ServiceLifetime lifetime,
params object[] parameters) where TStrategy : IMultiTenantStrategy
Expand Down