pantoken / plugins/typedoc/demo/src / rewriteComment

تابع: rewriteComment() ​

rewriteComment(comment): void

بتا

هر تگ بلوک @demo موجود در یک نظر را به نرده‌های demo که به خلاصهٔ آن افزوده شده‌اند منتقل کنید، به همان ترتیب. محتوای تگ بلوک توسط قالب مارک‌داون دوباره درون فنس قرار می‌گیرد، بنابراین فنس باید در متن خلاصه قرار داشته باشد که عیناً خروجی داده می‌شود.

پارامترها ​

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);