Interface JsdocToken

JSDoc details with some symbol details.

Hierarchy

  • Jsdoc
    • JsdocToken

Properties

description examples full isDefault isExported kind name params returns

Properties

description

description: string

JSDoc description.

examples

examples: string[]

JSDoc examples.

full

full: string

Full JSDoc.

isDefault

isDefault: boolean

Symbol is default?

isExported

isExported: boolean

Symbol is exported?

kind

kind: string

Symbol kind.

name

name: string

Symbol name.

params

params: ParamTag[]

JSDoc params.

returns

returns: ReturnsTag

JSDoc returns.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc