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

Función: rewriteComment() ​

rewriteComment(comment): void

Beta

Mueve cada etiqueta de bloque @demo en un comentario dentro de delimitadores demo añadidos al final de su resumen, en orden. El contenido de la etiqueta de bloque se vuelve a enmarcar por el tema de Markdown, por lo que la cerca debe estar en la prosa del resumen, que se emite tal cual.

Parámetros ​

comment ​

Comment

El comentario a reescribir en el lugar.

Devuelve ​

void

Ejemplo ​

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