Siklos/libgit2dart
1
0
Fork 0
mirror of https://github.com/SkinnyMind/libgit2dart.git synced 2025-05-05 04:39:07 -04:00
Code Issues Projects Releases Wiki Activity

docs: update docs for bindings and api

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

9
lib/src/repository.dart
View file

@ -18,6 +18,11 @@ class Repository {
/// pointer to repository object in memory.
///
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Note: For internal use. Instead, use one of:
/// - [Repository.init]
/// - [Repository.open]
/// - [Repository.clone]
Repository(this._repoPointer);
/// Creates new git repository at the provided [path].
@ -151,6 +156,8 @@ class Repository {
late final Pointer<git_repository> _repoPointer;
/// Pointer to memory address for allocated repository object.
///
/// Note: For internal use.
Pointer<git_repository> get pointer => _repoPointer;
/// Looks for a git repository and return its path. The lookup start from
@ -686,7 +693,7 @@ class Repository {
dirtySuffix: dirtySuffix,
);
describe_bindings.describeResultFree(describeResult);
describe_bindings.free(describeResult);
return result;
}