pantoken / plugins/typedoc/demo/src / rewriteComment
Függvény: rewriteComment()
rewriteComment(
comment):void
Béta
Helyezd át a megjegyzés minden @demo blokkjelölőjét az annak összefoglalásához hozzáfűzött demo kerítésekbe, sorrendben. A blokk-tag tartalmát a markdown téma újra kerítezi, így a kerítésnek az összefoglalás prózájában kell lennie, amely szó szerinti módon kerül kibocsátásra.
Paraméterek
comment
Comment
A megjegyzés, amely helyén átírható.
Visszatérés
void
Példa
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);