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

Função: rewriteComment() ​

rewriteComment(comment): void

Beta

Mova cada tag de bloco @demo em um comentário para delimitadores demo anexados ao seu resumo, na ordem. O conteúdo da tag de bloco é re-delimitado pelo tema do markdown, portanto o delimitador deve ficar na prosa do resumo , que é emitida literalmente.

Parâmetros ​

comment ​

Comment

O comentário a ser reescrito no local.

Retorna ​

void

Exemplo ​

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