chore: fix CI errors on javadoc (#1422)

* chore: fix javadoc on doc string checkes * fix lint * address comments * remove unused <p> tag * fix lint
googleapis · Jun 10, 2024 · ecc754a · ecc754a
1 parent f0efe45
commit ecc754a
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 9 deletions.
diff --git a/oauth2_http/java/com/google/auth/oauth2/AwsCredentials.java b/oauth2_http/java/com/google/auth/oauth2/AwsCredentials.java
@@ -268,7 +268,8 @@ public Builder setAwsSecurityCredentialsSupplier(
      * Sets the AWS regional credential verification URL. If set, will override any credential
      * verification URL provided in the credential source. If not set, the credential verification
      * URL will default to
-     * https://sts.{region}.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15"
+     *
+     * <p><a href=https://sts.{region}.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15>
      *
      * @param regionalCredentialVerificationUrlOverride the AWS credential verification url to set.
      * @return this {@code Builder} object

diff --git a/oauth2_http/java/com/google/auth/oauth2/AwsSecurityCredentialsSupplier.java b/oauth2_http/java/com/google/auth/oauth2/AwsSecurityCredentialsSupplier.java
@@ -35,7 +35,7 @@
 import java.io.Serializable;
 
 /**
- * Supplier for retrieving AWS Security credentials for {@Link AwsCredentials} to exchange for GCP
+ * Supplier for retrieving AWS Security credentials for {@link AwsCredentials} to exchange for GCP
  * access tokens.
  */
 public interface AwsSecurityCredentialsSupplier extends Serializable {

diff --git a/oauth2_http/java/com/google/auth/oauth2/FileIdentityPoolSubjectTokenSupplier.java b/oauth2_http/java/com/google/auth/oauth2/FileIdentityPoolSubjectTokenSupplier.java
@@ -47,7 +47,7 @@
 import java.nio.file.Paths;
 
 /**
- * Internal provider for retrieving subject tokens for {@Link IdentityPoolCredentials} to exchange
+ * Internal provider for retrieving subject tokens for {@link IdentityPoolCredentials} to exchange
  * for GCP access tokens via a local file.
  */
 class FileIdentityPoolSubjectTokenSupplier implements IdentityPoolSubjectTokenSupplier {

diff --git a/oauth2_http/java/com/google/auth/oauth2/GoogleCredentials.java b/oauth2_http/java/com/google/auth/oauth2/GoogleCredentials.java
@@ -329,8 +329,8 @@ public GoogleCredentials(AccessToken accessToken) {
   }
 
   /**
-   * Constructor that relies on a {@link GoogleCredential.Builder} to provide all the necessary
-   * field values for initialization.
+   * Constructor that relies on a {@link Builder} to provide all the necessary field values for
+   * initialization.
    *
    * @param builder an instance of a builder
    */

diff --git a/oauth2_http/java/com/google/auth/oauth2/InternalAwsSecurityCredentialsSupplier.java b/oauth2_http/java/com/google/auth/oauth2/InternalAwsSecurityCredentialsSupplier.java
@@ -50,7 +50,7 @@
 import javax.annotation.Nullable;
 
 /**
- * Internal provider for retrieving AWS security credentials for {@Link AwsCredentials} to exchange
+ * Internal provider for retrieving AWS security credentials for {@link AwsCredentials} to exchange
  * for GCP access tokens. The credentials are retrieved either via environment variables or metadata
  * endpoints.
  */

diff --git a/oauth2_http/java/com/google/auth/oauth2/ServiceAccountCredentials.java b/oauth2_http/java/com/google/auth/oauth2/ServiceAccountCredentials.java
@@ -641,7 +641,7 @@ public ServiceAccountCredentials createWithCustomLifetime(int lifetime) {
 
   /**
    * Clones the service account with a new useJwtAccessWithScope value. This flag will be ignored if
-   * universeDomain field is different from {@link Credentials.GOOGLE_DEFAULT_UNIVERSE}.
+   * universeDomain field is different from {@link Credentials#GOOGLE_DEFAULT_UNIVERSE}.
    *
    * @param useJwtAccessWithScope whether self-signed JWT with scopes should be used
    * @return the cloned service account credentials with the given useJwtAccessWithScope
@@ -1119,7 +1119,7 @@ public Builder setLifetime(int lifetime) {
 
     /**
      * Sets the useJwtAccessWithScope flag. This flag will be ignored if universeDomain field is
-     * different from {@link Credentials.GOOGLE_DEFAULT_UNIVERSE}.
+     * different from {@link Credentials#GOOGLE_DEFAULT_UNIVERSE}.
      */
     @CanIgnoreReturnValue
     public Builder setUseJwtAccessWithScope(boolean useJwtAccessWithScope) {

diff --git a/oauth2_http/java/com/google/auth/oauth2/UrlIdentityPoolSubjectTokenSupplier.java b/oauth2_http/java/com/google/auth/oauth2/UrlIdentityPoolSubjectTokenSupplier.java
@@ -42,7 +42,7 @@
 import java.io.IOException;
 
 /**
- * Provider for retrieving subject tokens for {@Link IdentityPoolCredentials} to exchange for GCP
+ * Provider for retrieving subject tokens for {@link IdentityPoolCredentials} to exchange for GCP
  * access tokens. The subject token is retrieved by calling a URL that returns the token.
  */
 class UrlIdentityPoolSubjectTokenSupplier implements IdentityPoolSubjectTokenSupplier {