Skip to content

Commit 6209a8e

Browse files
authored
Update XML docs for AddAzureClients and AddAzureClientsCore (Azure#30409)
* Update XML docs for AddAzureClients and AddAzureClientsCore * Edit pass
1 parent 459ab75 commit 6209a8e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

sdk/extensions/Microsoft.Extensions.Azure/src/AzureClientServiceCollectionExtensions.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public static class AzureClientServiceCollectionExtensions
1717
{
1818
/// <summary>
1919
/// Adds the <see cref="IAzureClientFactory{TClient}"/> and related services to the <see cref="IServiceCollection"/>.
20-
/// Azure SDK logging is enabled once the configured client is created.
20+
/// Azure SDK log forwarding to <see cref="ILogger"/> is enabled once the configured client is created.
2121
/// </summary>
2222
/// <param name="collection">The <see cref="IServiceCollection"/>.</param>
2323
/// <param name="configureClients">An <see cref="AzureClientFactoryBuilder"/> that can be used to configure the client.</param>
@@ -29,7 +29,7 @@ public static void AddAzureClients(this IServiceCollection collection, Action<Az
2929

3030
/// <summary>
3131
/// Adds the minimum essential Azure SDK interop services like <see cref="AzureEventSourceLogForwarder"/> and <see cref="AzureComponentFactory"/> to the specified <see cref="IServiceCollection"/> without registering any client types.
32-
/// Azure SDK log forwarding to to <see cref="ILogger"/> will not be enabled by default, but can be enabled by calling the <see cref="AzureEventSourceLogForwarder.Start"/> method.
32+
/// Azure SDK log forwarding to <see cref="ILogger"/> is disabled by default. It can be enabled by calling the <see cref="AzureEventSourceLogForwarder.Start"/> method.
3333
/// Alternatively, you can use the <see cref="AddAzureClientsCore(Microsoft.Extensions.DependencyInjection.IServiceCollection, bool)"/> overload
3434
/// and pass <value>true</value> to enable log forwarding.
3535
/// </summary>
@@ -43,8 +43,8 @@ public static void AddAzureClientsCore(this IServiceCollection collection)
4343
/// Adds the minimum essential Azure SDK interop services like <see cref="AzureEventSourceLogForwarder"/> and <see cref="AzureComponentFactory"/> to the specified <see cref="IServiceCollection"/> without registering any client types.
4444
/// </summary>
4545
/// <param name="collection">The <see cref="IServiceCollection"/>.</param>
46-
/// <param name="enableLogForwarding">Whether or not to enable Azure SDK log forwarding to <see cref="ILogger"/>. Even if this is set to <value>false</value>,
47-
/// log forwarding can be enabled by calling the <see cref="AzureEventSourceLogForwarder.Start"/> method.</param>
46+
/// <param name="enableLogForwarding">Whether to enable Azure SDK log forwarding to <see cref="ILogger"/>. If set to <value>false</value>,
47+
/// log forwarding can still be enabled by calling the <see cref="AzureEventSourceLogForwarder.Start"/> method.</param>
4848
public static void AddAzureClientsCore(this IServiceCollection collection, bool enableLogForwarding)
4949
{
5050
collection.AddOptions();

0 commit comments

Comments
 (0)