pantoken / plugins/typedoc/demo/src / rewriteComment

Funkcja: rewriteComment() ​

rewriteComment(comment): void

Beta

Przenieś każdy znacznik bloku @demo w komentarzu do fence'ów demo dołączonych do jego podsumowania, w kolejności. Zawartość znacznika bloku jest ponownie opakowywana przez motyw Markdown, więc fence musi znajdować się w prozie podsumowania, która jest emitowana dosłownie.

Parametry ​

comment ​

Comment

Komentarz do przepisania w miejscu.

Zwraca ​

void

Przykład ​

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