index.JsDocBlock.md

api-typescript-generator / Modules / index / JsDocBlock

Interface: JsDocBlock

index.JsDocBlock

JsDoc block to be rendered.

Table of contents

Properties

• description
• tags
• title

Properties

description

• Optional description: string

The description of the JsDoc block. Follows the title, separated by a blank line.

---

tags

• tags: JsDocBlockTag[]

JsDoc tags.

---

title

• Optional title: string

The first line of the JsDoc block.