pantoken-root / plugins/typedoc/demo/src / rewriteComment

फंक्शन: rewriteComment() ​

rewriteComment(comment): void

बीटा

टिप्पणी पर मौजूद प्रत्येक @demo ब्लॉक टैग को उसकी सार (summary) में क्रमानुसार जोड़े गए demo फेंस में स्थानांतरित करें। ब्लॉक-टैग सामग्री को मार्कडाउन थीम द्वारा पुनः-फेंस किया जाता है, इसलिए फेंस सार पाठ में होना चाहिए, जिसे शब्दशः (verbatim) प्रेषित किया जाता है।

पैरामीटर ​

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