Skip to content

Commit

Permalink
Finalizing Azure Key JavaDocs (#9696)
Browse files Browse the repository at this point in the history
* Fixed grammatical mistake in JavaDoc

* Additional documentation updates
  • Loading branch information
alzimmermsft authored Mar 31, 2020
1 parent f2e5a0e commit c164864
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import java.util.Objects;

/**
* Represents a credential that uses a key authenticate to an Azure Service.
* Represents a credential that uses a key to authenticate to an Azure Service.
*/
public final class AzureKeyCredential {
private final ClientLogger logger = new ClientLogger(AzureKeyCredential.class);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@

/**
* Pipeline policy that uses an {@link AzureKeyCredential} to set the authorization key for a request.
*
* <p>
* Requests sent with this pipeline policy are required to use {@code HTTPS}. If the request isn't using {@code HTTPS}
* an exception will be thrown to prevent leaking the key.
Expand All @@ -26,9 +25,9 @@ public final class AzureKeyCredentialPolicy implements HttpPipelinePolicy {
private final AzureKeyCredential credential;

/**
* Creates a policy that uses the passed {@link AzureKeyCredential} to set the specified name.
* Creates a policy that uses the passed {@link AzureKeyCredential} to set the specified header name.
*
* @param name The name of the key header that will be set to the {@link AzureKeyCredential} key value.
* @param name The name of the key header that will be set to {@link AzureKeyCredential#getKey()}.
* @param credential The {@link AzureKeyCredential} containing the authorization key to use.
* @throws NullPointerException If {@code name} or {@code credential} is {@code null}.
* @throws IllegalArgumentException If {@code name} is empty.
Expand Down

0 comments on commit c164864

Please sign in to comment.