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: improve api documentation

Browse source
This commit is contained in:
Aleksey Kulikov 2021-10-22 14:41:15 +03:00
parent 199dce111a
commit a24070c44c
32 changed files with 1008 additions and 518 deletions
Download patch file Download diff file Expand all files Collapse all files

14
lib/src/refspec.dart
View file

@ -11,26 +11,26 @@ class Refspec {
/// Pointer to memory address for allocated refspec object.
final Pointer<git_refspec> _refspecPointer;
/// Returns the source specifier.
/// Source specifier.
String get source => bindings.source(_refspecPointer);
/// Returns the destination specifier.
/// Destination specifier.
String get destination => bindings.destination(_refspecPointer);
/// Returns the force update setting.
/// Force update setting.
bool get force => bindings.force(_refspecPointer);
/// Returns the refspec's string.
/// Refspec's string.
String get string => bindings.string(_refspecPointer);
/// Returns the refspec's direction (fetch or push).
/// Refspec's direction (fetch or push).
GitDirection get direction {
return bindings.direction(_refspecPointer) == 0
? GitDirection.fetch
: GitDirection.push;
}
/// Checks if a refspec's source descriptor matches a reference.
/// Whether refspec's source descriptor matches a reference.
bool matchesSource(String refname) {
return bindings.matchesSource(
refspecPointer: _refspecPointer,
@ -38,7 +38,7 @@ class Refspec {
);
}
/// Checks if a refspec's destination descriptor matches a reference.
/// Whether refspec's destination descriptor matches a reference.
bool matchesDestination(String refname) {
return bindings.matchesDestination(
refspecPointer: _refspecPointer,