pantoken / plugins/typedoc/demo/src / rewriteComment

Funzione: rewriteComment() ​

rewriteComment(comment): void

Beta

Spostare ogni tag di blocco @demo presente in un commento dentro delimitatori demo aggiunti al suo sommario, nell'ordine. Il contenuto del tag di blocco viene nuovamente racchiuso dal tema Markdown, quindi il delimitatore deve trovarsi nella prosa del sommario, che viene emessa letteralmente.

Parametri ​

comment ​

Comment

Il commento da riscrivere in loco.

Restituisce ​

void

Esempio ​

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