Interface DocumentationProvider

Provides documentation for AST nodes.

interface DocumentationProvider {
getDocumentation(node: AstNode): undefined | string;
}

Implemented by

JSDocDocumentationProvider

Index

Methods

getDocumentation

Methods

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
- Defined in packages/langium/src/documentation/documentation-provider.ts:24