Update src/main/webapp/app/shared/markdown-editor/extensions/ArtemisT…

…extReplacementPlugin.ts Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
ls1intum · Sep 23, 2024 · faa3137 · faa3137
1 parent cf16fb8
commit faa3137
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/main/webapp/app/shared/markdown-editor/extensions/ArtemisTextReplacementPlugin.ts b/src/main/webapp/app/shared/markdown-editor/extensions/ArtemisTextReplacementPlugin.ts
@@ -18,5 +18,10 @@ export abstract class ArtemisTextReplacementPlugin {
         };
     }
 
+    /**
+     * Performs text replacement on the raw markdown before parsing.
+     * @param text The raw markdown text.
+     * @returns The modified markdown text after replacements.
+     */
     abstract replaceText(text: string): string;
 }