pantoken / plugins/typedoc/demo/src / rewriteComment

Functie: rewriteComment() ​

rewriteComment(comment): void

Bèta

Verplaats elk @demo block-tag in een commentaar naar demo-fences die in volgorde aan de samenvatting worden toegevoegd. De inhoud van de block-tag wordt door het Markdown-thema opnieuw van fences voorzien, dus de fence moet in de samenvattingsproza staan die letterlijk wordt uitgegeven.

Parameters ​

comment ​

Comment

Het commentaar dat ter plaatse herschreven moet worden.

Retourneert ​

void

Voorbeeld ​

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