pantoken / plugins/typedoc/demo/src / rewriteComment

פונקציה: rewriteComment() ​

rewriteComment(comment): void

בטא

העבר כל תג בלוק @demo שמופיע בהערה אל גדרות demo המתווספות לסיכום שלה, לפי הסדר. תוכן תגי הבלוק יעובד מחדש על ידי התבנית של Markdown, לכן הגדר חייבת להימצא בטקסט הסיכום, שמופק בדיוק כפי שהוא.

פרמטרים ​

comment ​

Comment

ההערה שיש לשכתב במקום.

מחזיר ​

void

דוגמה ​

ts
import { rewriteComment } from "@pantoken/typedoc-plugin-demo";

// Given a comment with `@demo self:button`, appends a ```demo``` fence and drops the tag.
rewriteComment(comment);