Fix javadoc issues

This commit is contained in:
Liam Newman
2020-12-30 14:07:37 -08:00
parent a9438b6121
commit bd39b07bb5
3 changed files with 9 additions and 0 deletions

View File

@@ -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) {
}

View File

@@ -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
*/

View File

@@ -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