Skip to content

Commit ecc754a

Browse files
authored
chore: fix CI errors on javadoc (#1422)
* chore: fix javadoc on doc string checkes * fix lint * address comments * remove unused <p> tag * fix lint
1 parent f0efe45 commit ecc754a

7 files changed

Lines changed: 10 additions & 9 deletions

oauth2_http/java/com/google/auth/oauth2/AwsCredentials.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,8 @@ public Builder setAwsSecurityCredentialsSupplier(
268268
* Sets the AWS regional credential verification URL. If set, will override any credential
269269
* verification URL provided in the credential source. If not set, the credential verification
270270
* URL will default to
271-
* https://sts.{region}.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15"
271+
*
272+
* <p><a href=https://sts.{region}.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15>
272273
*
273274
* @param regionalCredentialVerificationUrlOverride the AWS credential verification url to set.
274275
* @return this {@code Builder} object

oauth2_http/java/com/google/auth/oauth2/AwsSecurityCredentialsSupplier.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
import java.io.Serializable;
3636

3737
/**
38-
* Supplier for retrieving AWS Security credentials for {@Link AwsCredentials} to exchange for GCP
38+
* Supplier for retrieving AWS Security credentials for {@link AwsCredentials} to exchange for GCP
3939
* access tokens.
4040
*/
4141
public interface AwsSecurityCredentialsSupplier extends Serializable {

oauth2_http/java/com/google/auth/oauth2/FileIdentityPoolSubjectTokenSupplier.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
import java.nio.file.Paths;
4848

4949
/**
50-
* Internal provider for retrieving subject tokens for {@Link IdentityPoolCredentials} to exchange
50+
* Internal provider for retrieving subject tokens for {@link IdentityPoolCredentials} to exchange
5151
* for GCP access tokens via a local file.
5252
*/
5353
class FileIdentityPoolSubjectTokenSupplier implements IdentityPoolSubjectTokenSupplier {

oauth2_http/java/com/google/auth/oauth2/GoogleCredentials.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,8 +329,8 @@ public GoogleCredentials(AccessToken accessToken) {
329329
}
330330

331331
/**
332-
* Constructor that relies on a {@link GoogleCredential.Builder} to provide all the necessary
333-
* field values for initialization.
332+
* Constructor that relies on a {@link Builder} to provide all the necessary field values for
333+
* initialization.
334334
*
335335
* @param builder an instance of a builder
336336
*/

oauth2_http/java/com/google/auth/oauth2/InternalAwsSecurityCredentialsSupplier.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
import javax.annotation.Nullable;
5151

5252
/**
53-
* Internal provider for retrieving AWS security credentials for {@Link AwsCredentials} to exchange
53+
* Internal provider for retrieving AWS security credentials for {@link AwsCredentials} to exchange
5454
* for GCP access tokens. The credentials are retrieved either via environment variables or metadata
5555
* endpoints.
5656
*/

oauth2_http/java/com/google/auth/oauth2/ServiceAccountCredentials.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@ public ServiceAccountCredentials createWithCustomLifetime(int lifetime) {
641641

642642
/**
643643
* Clones the service account with a new useJwtAccessWithScope value. This flag will be ignored if
644-
* universeDomain field is different from {@link Credentials.GOOGLE_DEFAULT_UNIVERSE}.
644+
* universeDomain field is different from {@link Credentials#GOOGLE_DEFAULT_UNIVERSE}.
645645
*
646646
* @param useJwtAccessWithScope whether self-signed JWT with scopes should be used
647647
* @return the cloned service account credentials with the given useJwtAccessWithScope
@@ -1119,7 +1119,7 @@ public Builder setLifetime(int lifetime) {
11191119

11201120
/**
11211121
* Sets the useJwtAccessWithScope flag. This flag will be ignored if universeDomain field is
1122-
* different from {@link Credentials.GOOGLE_DEFAULT_UNIVERSE}.
1122+
* different from {@link Credentials#GOOGLE_DEFAULT_UNIVERSE}.
11231123
*/
11241124
@CanIgnoreReturnValue
11251125
public Builder setUseJwtAccessWithScope(boolean useJwtAccessWithScope) {

oauth2_http/java/com/google/auth/oauth2/UrlIdentityPoolSubjectTokenSupplier.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
import java.io.IOException;
4343

4444
/**
45-
* Provider for retrieving subject tokens for {@Link IdentityPoolCredentials} to exchange for GCP
45+
* Provider for retrieving subject tokens for {@link IdentityPoolCredentials} to exchange for GCP
4646
* access tokens. The subject token is retrieved by calling a URL that returns the token.
4747
*/
4848
class UrlIdentityPoolSubjectTokenSupplier implements IdentityPoolSubjectTokenSupplier {

0 commit comments

Comments
 (0)