mirror of
https://github.com/SkinnyMind/libgit2dart.git
synced 2025-05-05 04:39:07 -04:00
docs: improve api documentation
This commit is contained in:
parent
199dce111a
commit
a24070c44c
32 changed files with 1008 additions and 518 deletions
|
@ -1,6 +1,20 @@
|
|||
import 'package:libgit2dart/libgit2dart.dart';
|
||||
|
||||
class Callbacks {
|
||||
/// Callback functions used in various methods of [Remote] and with [Repository.clone].
|
||||
///
|
||||
/// [credentials] is the [Credentials] object used for authentication.
|
||||
///
|
||||
/// [transferProgress] is the callback function that reports transfer progress.
|
||||
///
|
||||
/// [sidebandProgress] is the callback function that reports textual progress from the remote.
|
||||
///
|
||||
/// [updateTips] is the callback function matching the
|
||||
/// `void Function(String refname, Oid old, Oid new)` that report reference updates.
|
||||
///
|
||||
/// [pushUpdateReference] is the callback function matching the
|
||||
/// `void Function(String refname, String message)` used to inform of the update status
|
||||
/// from the remote.
|
||||
const Callbacks({
|
||||
this.credentials,
|
||||
this.transferProgress,
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue