doc: add some doc comments

lumeland · Jun 5, 2023 · 29db4a3 · 29db4a3
1 parent 8e1a830
commit 29db4a3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/core/fs.ts b/core/fs.ts
@@ -12,11 +12,17 @@ export interface Options {
 export type Loader = (path: string) => Promise<Data>;
 
 export class Entry {
+  /** The name of the file/dir. */
   name: string;
+  /** The normalized path of the file/dir. */
   path: string;
+  /** The type of the entry. */
   type: EntryType;
+  /** The absolute file path. */
   src: string;
+  /** The children of the entry. */
   children = new Map<string, Entry>();
+  /** Temporary flags that are cleared when a file is modified. */
   flags = new Set<string>();
   #content = new Map<Loader, Promise<Data> | Data>();
   #info?: Deno.FileInfo;

diff --git a/core/writer.ts b/core/writer.ts
@@ -112,6 +112,7 @@ export default class Writer {
 
   /**
    * Copy the static files in the dest folder
+   * Returns the static files that have been successfully copied
    */
   async copyFiles(files: StaticFile[]): Promise<StaticFile[]> {
     const copyFiles: StaticFile[] = [];