UNPKG

1.7 kBTypeScriptView Raw
1import ts from "typescript";
2import { Comment, ReflectionKind } from "../../models";
3import { type Logger } from "../../utils";
4import type { CommentStyle, JsDocCompatibility } from "../../utils/options/declaration";
5import type { FileRegistry } from "../../models/FileRegistry";
6export interface CommentParserConfig {
7 blockTags: Set<string>;
8 inlineTags: Set<string>;
9 modifierTags: Set<string>;
10 jsDocCompatibility: JsDocCompatibility;
11 suppressCommentWarningsInDeclarationFiles: boolean;
12 useTsLinkResolution: boolean;
13 commentStyle: CommentStyle;
14}
15export declare function clearCommentCache(): void;
16export declare function getComment(symbol: ts.Symbol, kind: ReflectionKind, config: CommentParserConfig, logger: Logger, checker: ts.TypeChecker, files: FileRegistry): Comment | undefined;
17export declare function getNodeComment(node: ts.Node, moduleComment: boolean, config: CommentParserConfig, logger: Logger, checker: ts.TypeChecker | undefined, files: FileRegistry): Comment | undefined;
18export declare function getFileComment(file: ts.SourceFile, config: CommentParserConfig, logger: Logger, checker: ts.TypeChecker | undefined, files: FileRegistry): Comment | undefined;
19export declare function getSignatureComment(declaration: ts.SignatureDeclaration | ts.JSDocSignature, config: CommentParserConfig, logger: Logger, checker: ts.TypeChecker, files: FileRegistry): Comment | undefined;
20export declare function getJsDocComment(declaration: ts.JSDocPropertyLikeTag | ts.JSDocCallbackTag | ts.JSDocTypedefTag | ts.JSDocTemplateTag | ts.JSDocEnumTag, config: CommentParserConfig, logger: Logger, checker: ts.TypeChecker | undefined, files: FileRegistry): Comment | undefined;