Interface JSDocLine

interface JSDocLine {
    range: Range;
    text: string;
    toMarkdown(options?: JSDocRenderOptions): string;
    toString(): string;
}

Hierarchy (view full)

JSDocValue
- JSDocLine

Index

Properties

range text

Methods

toMarkdown toString

Properties

`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.

`Readonly`text

text: string

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 JSDocLine

Hierarchy (view full)

Index

Properties

Methods

Properties

`Readonly`range

`Readonly`text

Methods

toMarkdown

Parameters

Returns string

toString

Returns string

Settings

On This Page

Interface JSDocLine

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonlyrange

Readonlytext

Methods

toMarkdown

Parameters

Returns string

toString

Returns string

Settings

On This Page

`Readonly`range

`Readonly`text