docs: update docs for bindings and api

This commit is contained in:
Aleksey Kulikov 2022-04-28 16:04:30 +03:00
parent a3213a88a2
commit 9d61584165
52 changed files with 352 additions and 209 deletions

View file

@ -8,6 +8,10 @@ import 'package:libgit2dart/src/bindings/reference.dart' as reference_bindings;
class Branch {
/// Initializes a new instance of [Branch] class from provided pointer to
/// branch object in memory.
///
/// Note: For internal use. Instead, use one of:
/// - [Branch.create]
/// - [Branch.lookup]
Branch(this._branchPointer) {
_finalizer.attach(this, _branchPointer, detach: this);
}
@ -65,6 +69,8 @@ class Branch {
late final Pointer<git_reference> _branchPointer;
/// Pointer to memory address for allocated branch object.
///
/// Note: For internal use.
Pointer<git_reference> get pointer => _branchPointer;
/// Returns a list of branches that can be found in a [repo]sitory for