pantoken / plugins/typedoc/demo/src / rewriteComment

Fall: rewriteComment() ​

rewriteComment(comment): void

Beta

Flyttu hvert @demo blokk-merki í athugasemd í demo grindur bættar aftast við samantektina, í röð. Innihald blokk-merkis er endurfært af markdown-þemunni, svo grindurinn verður að vera í samantektartextanum sem er gefinn út bókstaflega.

Færibreytur ​

comment ​

Comment

Athugasemdin sem á að endurskrifa á staðnum.

Skilar ​

void

Dæmi ​

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