Skip to content

Commit 08c1bea

Browse files
authored
chore: cleanup javadoc warnings (#330)
* chore: cleanup javadoc warnings * docs: update return docs
1 parent 29ed29a commit 08c1bea

File tree

4 files changed

+6
-1
lines changed

4 files changed

+6
-1
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ private IdToken(String tokenValue, JsonWebSignature jsonWebSignature) {
6363
* Creates an IdToken given the encoded Json Web Signature.
6464
*
6565
* @param tokenValue String representation of the ID token.
66+
* @throws IOException if JWT token parsing fails
6667
* @return returns com.google.auth.oauth2.IdToken
6768
*/
6869
public static IdToken create(String tokenValue) throws IOException {
@@ -74,6 +75,7 @@ public static IdToken create(String tokenValue) throws IOException {
7475
*
7576
* @param jsonFactory JsonFactory to use for parsing the provided token.
7677
* @param tokenValue String representation of the ID token.
78+
* @throws IOException if JWT token parsing fails
7779
* @return returns com.google.auth.oauth2.IdToken
7880
*/
7981
public static IdToken create(String tokenValue, JsonFactory jsonFactory) throws IOException {

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ public String getOption() {
8080
* @param options List of Credential specific options for for the token. For example, an IDToken
8181
* for a ComputeEngineCredential can return platform specific claims if
8282
* "ComputeEngineCredentials.ID_TOKEN_FORMAT_FULL" is provided as a list option.
83+
* @throws IOException if token creation fails
8384
* @return IdToken object which includes the raw id_token, expiration and audience.
8485
*/
8586
IdToken idTokenWithAudience(String targetAudience, List<Option> options) throws IOException;

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ public class ImpersonatedCredentials extends GoogleCredentials
123123
* @param lifetime Number of seconds the delegated credential should be valid for (up to 3600).
124124
* @param transportFactory HTTP transport factory, creates the transport used to get access
125125
* tokens.
126+
* @return new credentials
126127
*/
127128
public static ImpersonatedCredentials create(
128129
GoogleCredentials sourceCredentials,
@@ -153,6 +154,7 @@ public static ImpersonatedCredentials create(
153154
* targetPrincipal.
154155
* @param scopes Scopes to request during the authorization grant.
155156
* @param lifetime Number of seconds the delegated credential should be valid for (up to 3600).
157+
* @return new credentials
156158
*/
157159
public static ImpersonatedCredentials create(
158160
GoogleCredentials sourceCredentials,

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public JwtClaims merge(JwtClaims other) {
8989
* ServiceAccountJwtAccessCredentials#jwtWithClaims(JwtClaims)} or {@link
9090
* JwtCredentials#jwtWithClaims(JwtClaims)}.
9191
*
92-
* @return
92+
* @return true if all required fields have been set; false otherwise
9393
*/
9494
public boolean isComplete() {
9595
return getAudience() != null && getIssuer() != null && getSubject() != null;

0 commit comments

Comments
 (0)