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

Funktio: rewriteComment() ​

rewriteComment(comment): void

Beta

Siirrä jokainen @demo lohko-tunniste kommentissa demo-aitauksiksi, jotka lisätään sen yhteenvedon perään järjestyksessä. Lohkotunnisteen sisältö uudelleenkääritään markdown-teeman toimesta, joten aita on oltava yhteenvedon proosassa, joka tulostetaan sellaisenaan.

Parametrit ​

comment ​

Comment

Kommentti, joka kirjoitetaan uudelleen paikan päällä.

Palauttaa ​

void

Esimerkki ​

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