25 lines
1.1 KiB
TypeScript
25 lines
1.1 KiB
TypeScript
/******************************************************************************
|
|
* Copyright 2023 TypeFox GmbH
|
|
* This program and the accompanying materials are made available under the
|
|
* terms of the MIT License, which is available in the project root.
|
|
******************************************************************************/
|
|
import type { GrammarConfig } from '../languages/grammar-config.js';
|
|
import type { LangiumCoreServices } from '../services.js';
|
|
import type { AstNode } from '../syntax-tree.js';
|
|
/**
|
|
* Provides comments for AST nodes.
|
|
*/
|
|
export interface CommentProvider {
|
|
/**
|
|
* Returns the comment associated with the specified AST node.
|
|
* @param node The AST node to get the comment for.
|
|
* @returns The comment associated with the specified AST node or `undefined` if there is no comment.
|
|
*/
|
|
getComment(node: AstNode): string | undefined;
|
|
}
|
|
export declare class DefaultCommentProvider implements CommentProvider {
|
|
protected readonly grammarConfig: () => GrammarConfig;
|
|
constructor(services: LangiumCoreServices);
|
|
getComment(node: AstNode): string | undefined;
|
|
}
|
|
//# sourceMappingURL=comment-provider.d.ts.map
|