pantoken / plugins/typedoc/demo/src / rewriteComment

Funkcija: rewriteComment() ​

rewriteComment(comment): void

Beta

Premaknite vsak @demo blok-tag v komentarju v demo ograje, dodane na konec njegovega povzetka, v istem vrstnem redu. Vsebina blok-taga se ponovno obroji po markdown temi, zato mora ograja biti v povzetnem besedilu povzetka, ki se izpiše dobesedno.

Parametri ​

comment ​

Comment

Komentar, ki ga je treba prepisati na mestu.

Vrne ​

void

Primer ​

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