From bd39b07bb5f062dcb07405dc58e6ae1c7bd2f1a7 Mon Sep 17 00:00:00 2001 From: Liam Newman Date: Wed, 30 Dec 2020 14:07:37 -0800 Subject: [PATCH] Fix javadoc issues --- src/main/java/org/kohsuke/github/CredentialProvider.java | 3 +++ .../java/org/kohsuke/github/ImmutableCredentialProvider.java | 3 +++ .../org/kohsuke/github/OrgInstallationCredentialProvider.java | 3 +++ 3 files changed, 9 insertions(+) diff --git a/src/main/java/org/kohsuke/github/CredentialProvider.java b/src/main/java/org/kohsuke/github/CredentialProvider.java index 6cc5fb4e8..ea29f3e9b 100644 --- a/src/main/java/org/kohsuke/github/CredentialProvider.java +++ b/src/main/java/org/kohsuke/github/CredentialProvider.java @@ -34,7 +34,10 @@ public interface CredentialProvider { /** * Binds this credential provider to a github instance. * + * Only needs to be implemented by dynamic credentials providers that use a github instance in order to refresh. + * * @param github + * The github instance to be used for refreshing dynamic credentials */ default void bind(GitHub github) { } diff --git a/src/main/java/org/kohsuke/github/ImmutableCredentialProvider.java b/src/main/java/org/kohsuke/github/ImmutableCredentialProvider.java index e0cdc54cb..d7f5815f9 100644 --- a/src/main/java/org/kohsuke/github/ImmutableCredentialProvider.java +++ b/src/main/java/org/kohsuke/github/ImmutableCredentialProvider.java @@ -34,6 +34,9 @@ public class ImmutableCredentialProvider implements CredentialProvider { * * @param oauthAccessToken * The token + * @param login + * The login for this token + * * @return a correctly configured {@link CredentialProvider} that will always return the same provided * oauthAccessToken */ diff --git a/src/main/java/org/kohsuke/github/OrgInstallationCredentialProvider.java b/src/main/java/org/kohsuke/github/OrgInstallationCredentialProvider.java index 56f8bcd0c..f4a3bc7c1 100644 --- a/src/main/java/org/kohsuke/github/OrgInstallationCredentialProvider.java +++ b/src/main/java/org/kohsuke/github/OrgInstallationCredentialProvider.java @@ -29,6 +29,9 @@ public class OrgInstallationCredentialProvider implements CredentialProvider { * * @param organizationName * The name of the organization where the application is installed + * @param credentialProvider + * A credential provider that returns a JWT token that can be used to refresh the App Installation token + * from GitHub. */ @BetaApi @Deprecated