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

21
lib/src/treebuilder.dart
View file

@ -7,7 +7,7 @@ class TreeBuilder {
/// Initializes a new instance of [TreeBuilder] class from provided
/// [repo]sitory and optional [tree] objects.
///
/// Should be freed to release allocated memory.
/// **IMPORTANT**: Should be freed to release allocated memory.
///
/// Throws a [LibGit2Error] if error occured.
TreeBuilder({required Repository repo, Tree? tree}) {
@ -20,7 +20,7 @@ class TreeBuilder {
/// Pointer to memory address for allocated tree builder object.
late final Pointer<git_treebuilder> _treeBuilderPointer;
/// Returns the number of entries listed in a tree builder.
/// Number of entries listed in a tree builder.
int get length => bindings.entryCount(_treeBuilderPointer);
/// Writes the contents of the tree builder as a tree object.
@ -29,11 +29,12 @@ class TreeBuilder {
/// Clears all the entires in the tree builder.
void clear() => bindings.clear(_treeBuilderPointer);
/// Returns an entry from the tree builder from its filename.
/// Returns an entry from the tree builder with provided [filename].
///
/// The returned entry is owned by the tree builder and should not be freed manually.
/// **IMPORTANT**: the returned entry is owned by the tree builder and
/// should not be freed manually.
///
/// Throws [ArgumentError] if nothing found for provided filename.
/// Throws [ArgumentError] if nothing found for provided [filename].
TreeEntry operator [](String filename) {
return TreeEntry(bindings.getByFilename(
builderPointer: _treeBuilderPointer,
@ -43,12 +44,18 @@ class TreeBuilder {
/// Adds or updates an entry to the tree builder with the given attributes.
///
/// If an entry named filename already exists, its attributes will be updated with
/// If an entry with [filename] already exists, its attributes will be updated with
/// the given ones.
///
/// By default the entry that you are inserting will be checked for validity;
/// that it exists in the object database and is of the correct type.
///
/// [filename] is the filename of the entry.
///
/// [oid] is [Oid] of the entry.
///
/// [filemode] is one of the [GitFilemode] folder attributes of the entry.
///
/// Throws a [LibGit2Error] if error occured.
void add({
required String filename,
@ -63,7 +70,7 @@ class TreeBuilder {
);
}
/// Removes an entry from the tree builder by its filename.
/// Removes an entry from the tree builder by its [filename].
///
/// Throws a [LibGit2Error] if error occured.
void remove(String filename) {