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

@ -10,6 +10,10 @@ import 'package:libgit2dart/src/bindings/repository.dart'
class Reference {
/// Initializes a new instance of the [Reference] class.
///
/// Note: For internal use. Instead, use one of:
/// - [Reference.create]
/// - [Reference.lookup]
Reference(this._refPointer) {
_finalizer.attach(this, _refPointer, detach: this);
}
@ -78,6 +82,8 @@ class Reference {
late Pointer<git_reference> _refPointer;
/// Pointer to memory address for allocated reference object.
///
/// Note: For internal use.
Pointer<git_reference> get pointer => _refPointer;
/// Deletes an existing reference with provided [name].