diff --git a/lib/src/callbacks.dart b/lib/src/callbacks.dart index 08e33be..bfbebf6 100644 --- a/lib/src/callbacks.dart +++ b/lib/src/callbacks.dart @@ -4,7 +4,11 @@ class Callbacks { /// Callback functions used in various methods of [Remote] and with /// [Repository.clone]. /// - /// [credentials] is the [Credentials] object used for authentication. + /// [credentials] is one of the objects used for authentication: + /// - [UserPass] + /// - [Keypair] + /// - [KeypairFromAgent] + /// - [KeypairFromMemory] /// /// [transferProgress] is the callback function that reports transfer /// progress. @@ -27,7 +31,11 @@ class Callbacks { this.pushUpdateReference, }); - /// Credentials used for authentication. + /// Credentials used for authentication. Could be one of: + /// - [UserPass] + /// - [Keypair] + /// - [KeypairFromAgent] + /// - [KeypairFromMemory] final Credentials? credentials; /// Callback function that reports transfer progress. diff --git a/lib/src/credentials.dart b/lib/src/credentials.dart index d38cb87..d54489f 100644 --- a/lib/src/credentials.dart +++ b/lib/src/credentials.dart @@ -1,5 +1,10 @@ import 'package:libgit2dart/libgit2dart.dart'; +/// Abstract class. Use one of the implementations: +/// - [UserPass] +/// - [Keypair] +/// - [KeypairFromAgent] +/// - [KeypairFromMemory] abstract class Credentials { /// Returns type of authentication method. GitCredential get credentialType;