Clarify KeyClientBuilderExtension methods params

Fixes Azure#14695
heaths · Sep 1, 2020 · 9d2353e · 9d2353e
1 parent b92a616
commit 9d2353e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/sdk/keyvault/Azure.Security.KeyVault.Keys/CHANGELOG.md b/sdk/keyvault/Azure.Security.KeyVault.Keys/CHANGELOG.md
@@ -7,6 +7,10 @@
 - Added `KeyVaultKeyIdentifier` to parse key URIs.
 - Added `LocalCryptographyClient` to do cryptography operations locally using a `JsonWebKey`.
 
+### Changed
+
+- Clarified documentation for `KeyClientBuilderExtensions` methods.
+
 ## 4.1.0 (2020-08-11)
 
 ### Added

diff --git a/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientBuilderExtensions.cs b/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientBuilderExtensions.cs
@@ -34,6 +34,10 @@ public static IAzureClientBuilder<KeyClient, KeyClientOptions> AddKeyClient<TBui
         /// <summary>
         /// Registers a <see cref="KeyClient"/> instance with the provided <paramref name="vaultUri"/>
         /// </summary>
+        /// <typeparam name="TBuilder">Type of builder to extend.</typeparam>
+        /// <param name="builder">The builder to extend.</param>
+        /// <param name="vaultUri">The URI to a specific key in an Azure Key Vault.</param>
+        /// <returns>An Azure client builder.</returns>
         public static IAzureClientBuilder<CryptographyClient, CryptographyClientOptions> AddCryptographyClient<TBuilder>(this TBuilder builder, Uri vaultUri)
             where TBuilder : IAzureClientFactoryBuilderWithCredential
         {
@@ -43,6 +47,11 @@ public static IAzureClientBuilder<CryptographyClient, CryptographyClientOptions>
         /// <summary>
         /// Registers a <see cref="KeyClient"/> instance with connection options loaded from the provided <paramref name="configuration"/> instance.
         /// </summary>
+        /// <typeparam name="TBuilder">Type of builder to extend.</typeparam>
+        /// <typeparam name="TConfiguration">The type of configuration to use for the client builder.</typeparam>
+        /// <param name="builder">The builder to extend.</param>
+        /// <param name="configuration">The configuration to use for the client builder.</param>
+        /// <returns>An Azure client builder.</returns>
         public static IAzureClientBuilder<CryptographyClient, CryptographyClientOptions> AddCryptographyClient<TBuilder, TConfiguration>(this TBuilder builder, TConfiguration configuration)
             where TBuilder : IAzureClientFactoryBuilderWithConfiguration<TConfiguration>
         {