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

Функція: rewriteComment() ​

rewriteComment(comment): void

Бета

Перемістити кожен блок-тег @demo у коментарі в огорожі demo, додані до його резюме, у порядку. Вміст блок-тегів повторно огороджується темою Markdown, тому огорожа має бути в прозі резюме, яка виводиться дослівно.

Параметри ​

comment ​

Comment

Коментар, який потрібно перезаписати на місці.

Повертає ​

void

Приклад ​

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