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