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

Ֆունկցիա: rewriteComment() ​

rewriteComment(comment): void

Բետա

Շարժել յուրաքանչյուր @demo բլոկ-թեգը մեկնաբանության մեջ՝ նրա համառոտագրին հերթով հավելված demo ցանկապատերի մեջ։ Մարկդաուն թեման բլոկ-թեգի պարունակությունը կրկին ցանկապատում է, այդ պատճառով ցանկապատը պետք է տեղավորված լինի համառոտագրի տեքստում, որը արտադրվում է բառացիորեն։

Պարամետրեր ​

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