typedoc/dist/lib/converter/comments/parser.d.ts

Create api documentation for TypeScript projects.

import type { CommentParserConfig } from "./index.js";
import { Comment, type CommentDisplayPart } from "../../models/index.js";
import type { MinimalSourceFile } from "#utils";
import { type Token } from "./lexer.js";
import { FileRegistry } from "../../models/FileRegistry.js";
import { type Logger } from "#utils";
export declare function parseComment(tokens: Generator<Token, undefined, undefined>, config: CommentParserConfig, file: MinimalSourceFile, logger: Logger, files: FileRegistry): Comment;
/**
 * Intended for parsing markdown documents. This only parses code blocks and
 * inline tags outside of code blocks, everything else is text.
 *
 * If you change this, also look at blockContent, as it likely needs similar
 * modifications to ensure parsing is consistent.
 */
export declare function parseCommentString(tokens: Generator<Token, undefined, undefined>, config: CommentParserConfig, file: MinimalSourceFile, logger: Logger, files: FileRegistry): {
    content: CommentDisplayPart[];
    frontmatter: Record<string, unknown>;
};