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

Funksjon: rewriteComment() ​

rewriteComment(comment): void

Beta

Flytt hver @demo blokk-tag på en kommentar inn i demo-gjerder lagt til i sammendraget, i rekkefølge. Innholdet i blokk-taggen blir re-fenced av markdown-temaet, så gjerdet må ligge i sammendragsprosaen, som blir gjengitt verbatim.

Parametere ​

comment ​

Comment

Kommentaren som skal omskrives på stedet.

Returnerer ​

void

Eksempel ​

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