docs: improve api documentation

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

View file

@ -35,7 +35,7 @@ class Oid {
}
}
/// Initializes a new instance of [Oid] class from provided raw git_oid.
/// Initializes a new instance of [Oid] class from provided raw git_oid structure.
Oid.fromRaw(git_oid raw) {
_oidPointer = bindings.fromRaw(raw.id);
}
@ -45,7 +45,7 @@ class Oid {
/// Pointer to memory address for allocated oid object.
Pointer<git_oid> get pointer => _oidPointer;
/// Returns hexadecimal SHA string.
/// Hexadecimal SHA string.
String get sha => bindings.toSHA(_oidPointer);
@override