pantoken / plugins/typedoc/demo/src / rewriteComment

Fonction: rewriteComment() ​

rewriteComment(comment): void

Bêta

Déplacer chaque balise de bloc @demo d'un commentaire dans des délimitations demo ajoutées à la fin de son résumé, dans l'ordre. Le contenu des balises de bloc est re-délimité par le thème markdown, donc la délimitation doit se trouver dans le texte du résumé, qui est émis tel quel.

Paramètres ​

comment ​

Comment

Le commentaire à réécrire sur place.

Renvoie ​

void

Exemple ​

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