pantoken / plugins/typedoc/demo/src / rewriteComment

Funktion: rewriteComment() ​

rewriteComment(comment): void

Beta

Flytta varje @demo block-tagg i en kommentar till demo-staket som läggs till i dess sammanfattning, i ordning. Block-taggens innehåll får ny inramning av markdown-temat, så staketet måste finnas i sammanfattningens prosa, som återges verbatim.

Parametrar ​

comment ​

Comment

Kommentaren som ska skrivas om på plats.

Returnerar ​

void

Exempel ​

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