Class JSDocDocumentationProvider

Provides documentation for AST nodes.

Implements

DocumentationProvider

Index

Constructors

Properties

commentProvider indexManager

Methods

documentationLinkRenderer documentationTagRenderer findNameInGlobalScope findNameInLocalSymbols getDocumentation

Constructors

constructor

new JSDocDocumentationProvider(
services: LangiumCoreServices,
): JSDocDocumentationProvider
Parameters
- services: LangiumCoreServices
Returns JSDocDocumentationProvider
- Defined in packages/langium/src/documentation/documentation-provider.ts:32

Properties

`Protected` `Readonly`commentProvider

commentProvider: CommentProvider

`Protected` `Readonly`indexManager

indexManager: IndexManager

Methods

`Protected`documentationLinkRenderer

documentationLinkRenderer(
    node: AstNode,
    name: string,
    display: string,
): undefined | string
Parameters
- node: AstNode
- name: string
- display: string
Returns undefined | string
- Defined in packages/langium/src/documentation/documentation-provider.ts:53

`Protected`documentationTagRenderer

documentationTagRenderer(_node: AstNode, _tag: JSDocTag): undefined | string
Parameters
- _node: AstNode
- _tag: JSDocTag
Returns undefined | string
- Defined in packages/langium/src/documentation/documentation-provider.ts:65

`Protected`findNameInGlobalScope

findNameInGlobalScope(
node: AstNode,
name: string,
): undefined | AstNodeDescription
Parameters
- node: AstNode
- name: string
Returns undefined | AstNodeDescription
- Defined in packages/langium/src/documentation/documentation-provider.ts:89

`Protected`findNameInLocalSymbols

findNameInLocalSymbols(
node: AstNode,
name: string,
): undefined | AstNodeDescription
Parameters
- node: AstNode
- name: string
Returns undefined | AstNodeDescription
- Defined in packages/langium/src/documentation/documentation-provider.ts:70

getDocumentation

getDocumentation(node: AstNode): undefined | string
Returns a markdown documentation string for the specified AST node.

The default implementation JSDocDocumentationProvider will inspect the comment associated with the specified node.
Parameters
- node: AstNode
Returns undefined | string
Implementation of DocumentationProvider.getDocumentation
- Defined in packages/langium/src/documentation/documentation-provider.ts:37