Skip to content

Commit 7393275

Browse files
committed
Update xml documentation
1 parent 45b2c56 commit 7393275

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

extensions/src/AWSSDK.Extensions.NETCore.Setup/ServiceCollectionExtensions.cs

+16-12
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,10 @@ public static IServiceCollection AddAWSService<T>(this IServiceCollection collec
129129
/// <param name="collection"></param>
130130
/// <param name="options">The AWS options used to create the service client overriding the default AWS options added using AddDefaultAWSOptions.</param>
131131
/// <param name="lifetime">The lifetime of the service client created. The default is Singleton.</param>
132-
/// <param name="credentialsFactoryFunc">A func which takes an IServiceProvider and the AWSOptions resolved via the optionsFunc and
133-
/// returns the IAWSCredentialsFactory used to create the service client overriding the default added using AddCredentialsFactory. If none is provided, the registered IAWSCredentialsFactory will be used,
134-
/// and if none has been registered a new instance of DefaultAWSCredentialsFactory will be used.
132+
/// <param name="credentialsFactoryFunc">
133+
/// A func which takes an IServiceProvider and the AWSOptions provided to this call and returns an IAWSCredentialsFactory used to create the service client.
134+
/// Must be provided if options are provided to this call _and_ a custom IAWSCredentialsFactory is registered via [Try]AddCredentialsFactory; otherwise the
135+
/// default will be used.
135136
/// </param>
136137
/// <returns>Returns back the IServiceCollection to continue the fluent system of IServiceCollection.</returns>
137138
public static IServiceCollection AddAWSService<T>(this IServiceCollection collection, AWSOptions options, ServiceLifetime lifetime = ServiceLifetime.Singleton, Func<IServiceProvider, AWSOptions, IAWSCredentialsFactory> credentialsFactoryFunc = null) where T : IAmazonService
@@ -147,9 +148,10 @@ public static IServiceCollection AddAWSService<T>(this IServiceCollection collec
147148
/// <typeparam name="T">The AWS service interface, like IAmazonS3.</typeparam>
148149
/// <param name="collection"></param>
149150
/// <param name="optionsFunc">A func which returns the AWS options used to create the service client overriding the default AWS options added using AddDefaultAWSOptions.</param>
150-
/// <param name="credentialsFactoryFunc">A func which takes an IServiceProvider and the AWSOptions resolved via the optionsFunc and
151-
/// returns the IAWSCredentialsFactory used to create the service client overriding the default added using AddCredentialsFactory. If none is provided, the registered IAWSCredentialsFactory will be used,
152-
/// and if none has been registered a new instance of DefaultAWSCredentialsFactory will be used.
151+
/// <param name="credentialsFactoryFunc">
152+
/// A func which takes an IServiceProvider and the AWSOptions resolved by optionsFunc and returns an IAWSCredentialsFactory used to create the service client.
153+
/// Must be provided if options are provided to this call _and_ a custom IAWSCredentialsFactory is registered via [Try]AddCredentialsFactory; otherwise the
154+
/// default will be used.
153155
/// </param>
154156
/// <param name="lifetime">The lifetime of the service client created. The default is Singleton.</param>
155157
/// <returns>Returns back the IServiceCollection to continue the fluent system of IServiceCollection.</returns>
@@ -186,9 +188,10 @@ public static IServiceCollection TryAddAWSService<T>(this IServiceCollection col
186188
/// <param name="collection"></param>
187189
/// <param name="options">The AWS options used to create the service client overriding the default AWS options added using AddDefaultAWSOptions.</param>
188190
/// <param name="lifetime">The lifetime of the service client created. The default is Singleton.</param>
189-
/// /// <param name="credentialsFactoryFunc">A func which takes an IServiceProvider and the AWSOptions resolved via the optionsFunc and
190-
/// returns the IAWSCredentialsFactory used to create the service client overriding the default added using AddCredentialsFactory. If none is provided, the registered IAWSCredentialsFactory will be used,
191-
/// and if none has been registered a new instance of DefaultAWSCredentialsFactory will be used.
191+
/// <param name="credentialsFactoryFunc">
192+
/// A func which takes an IServiceProvider and the AWSOptions resolved by optionsFunc and returns an IAWSCredentialsFactory used to create the service client.
193+
/// Must be provided if options are provided to this call _and_ a custom IAWSCredentialsFactory is registered via [Try]AddCredentialsFactory; otherwise the
194+
/// default will be used.
192195
/// </param>
193196
/// <returns>Returns back the IServiceCollection to continue the fluent system of IServiceCollection.</returns>
194197
public static IServiceCollection TryAddAWSService<T>(this IServiceCollection collection, AWSOptions options, ServiceLifetime lifetime = ServiceLifetime.Singleton, Func<IServiceProvider, AWSOptions, IAWSCredentialsFactory> credentialsFactoryFunc = null) where T : IAmazonService
@@ -204,9 +207,10 @@ public static IServiceCollection TryAddAWSService<T>(this IServiceCollection col
204207
/// <typeparam name="T">The AWS service interface, like IAmazonS3.</typeparam>
205208
/// <param name="collection"></param>
206209
/// <param name="optionsFunc">A func which returns the AWS options used to create the service client overriding the default AWS options added using AddDefaultAWSOptions.</param>
207-
/// <param name="credentialsFactoryFunc">A func which takes an IServiceProvider and the AWSOptions resolved via the optionsFunc and
208-
/// returns the IAWSCredentialsFactory used to create the service client overriding the default added using AddCredentialsFactory. If none is provided, the registered IAWSCredentialsFactory will be used,
209-
/// and if none has been registered a new instance of DefaultAWSCredentialsFactory will be used.
210+
/// <param name="credentialsFactoryFunc">
211+
/// A func which takes an IServiceProvider and the AWSOptions resolved by optionsFunc and returns an IAWSCredentialsFactory used to create the service client.
212+
/// Must be provided if options are provided to this call _and_ a custom IAWSCredentialsFactory is registered via [Try]AddCredentialsFactory; otherwise the
213+
/// default will be used.
210214
/// </param>
211215
/// <param name="lifetime">The lifetime of the service client created. The default is Singleton.</param>
212216
/// <returns>Returns back the IServiceCollection to continue the fluent system of IServiceCollection.</returns>

0 commit comments

Comments
 (0)