pantoken / plugins/typedoc/demo/src / rewriteComment

Swyddogaeth: rewriteComment() ​

rewriteComment(comment): void

Bêta

Symudwch bob tag bloc @demo ar sylw i ffensys demo wedi'u hychwanegu at ei grynodeb, yn y drefn honno. Caiff cynnwys tag-bloc ei ail-ffensi gan themâu markdown, felly rhaid i'r ffens fod yn y testun crynodeb, a gaiff ei allyrru’n llythrennol.

Paramedrau ​

comment ​

Comment

Y sylw i'w hailysgrifennu ar y safle.

Yn dychwelyd ​

void

Enghraifft ​

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