Merge pull request #1679 from schlusslicht/feat/jsdoc-example-caption

Allow usage of the JSDoc `@example` caption
TypeStrong · Oct 2, 2021 · 830d08c · 830d08c
2 parents 4886e41 + 0a56d05
commit 830d08c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/lib/converter/factories/comment.ts b/src/lib/converter/factories/comment.ts
@@ -224,6 +224,9 @@ export function parseComment(
         if (tagName === "return") {
             tagName = "returns";
         }
+        if (tagName === "example") {
+            line = line.replace(/<\/?caption>/g, "");
+        }
         if (
             tagName === "param" ||
             tagName === "typeparam" ||