pantoken / plugins/typedoc/demo/src / rewriteComment

Feidhm: rewriteComment() ​

rewriteComment(comment): void

Béite

Bog gach lipéad bloc @demo ar thrácht isteach i bhfáltais demo curtha leis lena achoimre, de réir a chéile. Athfhrámaíonn téama markdown ábhar lipéid an bhloc, mar sin caithfidh an fálta a bheith i mhar phrós na hachoimre, a astaítear mar atá.

Paraiméadair ​

comment ​

Comment

An trácht le hathscríobh in áit.

Tuairisceáin ​

void

Sampla ​

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