jsdoc: Note that parseFileContent() can only be called once per instance

claremacrae · claremacrae · commit 6b1c2e6ee62f · 2024-12-06T12:18:43.000Z
diff --git a/src/Obsidian/FileParser.ts b/src/Obsidian/FileParser.ts
@@ -41,6 +41,9 @@ export class FileParser {
         this.dateFromFileName = new Lazy(() => DateFallback.fromPath(this.filePath));
     }
 
+    /**
+     * **Warning**: This is designed to only be called **once per {@link FileParser} instance**.
+     */
     public parseFileContent() {
         if (this.listItems === undefined) {
             // When called via Cache, this function would never be called or files without list items.

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,9 @@ export class FileParser {`
`41`	`41`	`this.dateFromFileName = new Lazy(() => DateFallback.fromPath(this.filePath));`
`42`	`42`	`}`
`43`	`43`
	`44`	`+ /**`
	`45`	`+ * Warning: This is designed to only be called once per {@link FileParser} instance.`
	`46`	`+ */`
`44`	`47`	`public parseFileContent() {`
`45`	`48`	`if (this.listItems === undefined) {`
`46`	`49`	`// When called via Cache, this function would never be called or files without list items.`