pantoken / plugins/typedoc/demo/src / rewriteComment

Funktion: rewriteComment() ​

rewriteComment(comment): void

Beta

Verschiebe jedes @demo Block-Tag in einem Kommentar in demo-Fences, die der Reihenfolge entsprechend an seine Zusammenfassung angehängt werden. Der Inhalt des Block-Tags wird vom Markdown-Theme neu eingefasst, daher muss der Fence im Zusammenfassungs- prosa stehen, die unverändert ausgegeben wird.

Parameter ​

comment ​

Comment

Der Kommentar, der an Ort und Stelle umgeschrieben werden soll.

Rückgabe ​

void

Beispiel ​

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