1 | import ts from "typescript";
|
2 | import { Comment, ReflectionKind } from "../../models/index.js";
|
3 | import { type Logger } from "../../utils/index.js";
|
4 | import type { CommentStyle, JsDocCompatibility } from "../../utils/options/declaration.js";
|
5 | import type { FileRegistry } from "../../models/FileRegistry.js";
|
6 | export 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 | }
|
15 | export declare function clearCommentCache(): void;
|
16 | export declare function getComment(symbol: ts.Symbol, kind: ReflectionKind, config: CommentParserConfig, logger: Logger, checker: ts.TypeChecker, files: FileRegistry): Comment | undefined;
|
17 | export declare function getNodeComment(node: ts.Node, moduleComment: boolean, config: CommentParserConfig, logger: Logger, checker: ts.TypeChecker | undefined, files: FileRegistry): Comment | undefined;
|
18 | export declare function getFileComment(file: ts.SourceFile, config: CommentParserConfig, logger: Logger, checker: ts.TypeChecker | undefined, files: FileRegistry): Comment | undefined;
|
19 | export declare function getSignatureComment(declaration: ts.SignatureDeclaration | ts.JSDocSignature, config: CommentParserConfig, logger: Logger, checker: ts.TypeChecker, files: FileRegistry): Comment | undefined;
|
20 | export 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;
|