Interface JSDocTag

interface JSDocTag {
    content: JSDocParagraph;
    inline: boolean;
    name: string;
    range: Range;
    toMarkdown(options?: JSDocRenderOptions): string;
    toString(): string;
}

Hierarchy (view full)

JSDocValue
- JSDocTag

Index

Properties

content inline name range

Methods

toMarkdown toString

Properties

`Readonly`content

content: JSDocParagraph

`Readonly`inline

inline: boolean

`Readonly`name

name: string

`Readonly`range

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

toMarkdown

toMarkdown(options?): string
Renders this JSDoc element to a markdown representation.
Parameters
- Optionaloptions: JSDocRenderOptions
  Rendering options to customize the markdown result.
Returns string
Inherited from JSDocValue.toMarkdown
- Defined in packages/langium/src/documentation/jsdoc.ts:37

toString

toString(): string
Renders this JSDoc element to a plain text representation.

Returns string
Inherited from JSDocValue.toString
- Defined in packages/langium/src/documentation/jsdoc.ts:31

Interface JSDocTag

Hierarchy (view full)

Index

Properties

Methods

Properties

`Readonly`content

`Readonly`inline

`Readonly`name

`Readonly`range

Methods

toMarkdown

Parameters

Returns string

toString

Returns string

Settings

On This Page

Interface JSDocTag

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonlycontent

Readonlyinline

Readonlyname

Readonlyrange

Methods

toMarkdown

Parameters

Returns string

toString

Returns string

Settings

On This Page

`Readonly`content

`Readonly`inline

`Readonly`name

`Readonly`range