Class DefaultCommentProvider

Provides comments for AST nodes.

Implements

CommentProvider

Index

Constructors

Properties

Methods

Constructors

constructor

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

Properties

`Protected` `Readonly`grammarConfig

grammarConfig: () => GrammarConfig

Methods

getComment

getComment(node: AstNode): string | undefined
Returns the comment associated with the specified AST node.
Parameters
- node: AstNode
  The AST node to get the comment for.
Returns string | undefined
The comment associated with the specified AST node or undefined if there is no comment.
Implementation of CommentProvider.getComment
- Defined in packages/langium/src/documentation/comment-provider.ts:30