pantoken / plugins/typedoc/demo/src / rewriteComment

Συνάρτηση: rewriteComment() ​

rewriteComment(comment): void

Βήτα

Μετακινήστε κάθε @demo block tag σε ένα σχόλιο μέσα σε demo fences που προστίθενται στη σύνοψή του, με τη σειρά. Το περιεχόμενο του block-tag επαναπερικλείεται από το θέμα markdown, γι' αυτό το fence πρέπει να βρίσκεται στο κείμενο της σύνοψης που εκπέμπεται κυριολεκτικά.

Παράμετροι ​

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