pantoken-root / plugins/typedoc/demo/src / rewriteComment

Fonksiyon: rewriteComment() ​

rewriteComment(comment): void

Beta

Bir yorumdaki her @demo blok etiketini, sırayla özetine eklenen demo çitlerine taşı. Blok-etiket içeriği markdown teması tarafından yeniden çitlenir; bu yüzden çit, olduğu gibi gönderilen özet metninde yer almalıdır.

Parametreler ​

comment ​

Comment

Yerinde yeniden yazılacak yorum.

Döndürür ​

void

Örnek ​

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