Interface JSDocComment

interface JSDocComment {
    elements: JSDocElement[];
    range: Range;
    getTag(name: string): undefined | JSDocTag;
    getTags(name: string): JSDocTag[];
    toMarkdown(options?: JSDocRenderOptions): string;
    toString(): string;
}

Hierarchy (view full)

Properties

elements range

Methods

getTag getTags toMarkdown toString

Properties

Readonlyelements

elements: JSDocElement[]

Readonlyrange

range: Range

Represents the range that this JSDoc element occupies. If the JSDoc was parsed from a CstNode, the range will represent the location in the source document.

Methods

getTag

getTags

toMarkdown

toString

Settings

Member Visibility

On This Page

Properties
Methods