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

Funksjon: rewriteComment() ​

rewriteComment(comment): void

Beta

Flytt kvar @demo blokk-tag på ein kommentar inn i demo-gjerder lagt til i samandraget, i rekkjefølgje. Innhaldet i blokk-tagen blir re-fenca av markdown-temaet, so gjerdet må liggje i samandragsteksten, som blir skrive ut ordrett.

Parametrar ​

comment ​

Comment

Kommentaren som skal omskrivast på staden.

Returnerer ​

void

Døme ​

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