Added backend TSDoc/JSDoc comments & refactored a tiny bit

1 files changed, 17 insertions, 0 deletions

diff --git a/packages/server/src/git/blob.ts b/packages/server/src/git/blob.ts
index ef9f9ab..eebd2d4 100644
--- a/packages/server/src/git/blob.ts
+++ b/packages/server/src/git/blob.ts
@@ -2,21 +2,38 @@ import { BlobError, createError } from "./error";
 import { Tree } from "./tree";
 import { BlobTreeEntry } from "./tree_entry";
 
+/**
+ * A representation of a blob
+ */
 export class Blob {
 	private _tree_entry: BlobTreeEntry;
 
 	public path;
 
+	/**
+	 * @param entry - A tree entry that's a blob
+	 * @param path - A path
+	 */
 	constructor(entry: BlobTreeEntry, path: string) {
 		this._tree_entry = entry;
 
 		this.path = path;
 	}
 
+	/**
+	 * Returns the blob's content
+	 */
 	public async content(): Promise<string> {
 		return this._tree_entry.content();
 	}
 
+	/**
+	 * Returns a blob from a path in a tree
+	 *
+	 * @param tree - The tree to look in
+	 * @param path - A path to a blob
+	 * @returns An instance of a blob
+	 */
 	public static async fromPath(tree: Tree, path: string): Promise<Blob> {
 		const entry = await tree.find(path);