@maniascript/api
Version:
Maniascript API generator
21 lines (20 loc) • 902 B
TypeScript
import type { DescriptionContext, DocumentationContext, LineBriefContext, LineContext, LineDescriptionContext, LineParamContext } from '../antlr/DocCommentParser.js';
interface DocumentationParam {
name: string;
description?: string;
}
interface Documentation {
description?: string;
brief?: string;
params?: DocumentationParam[];
}
declare class DocVisitor {
newLineCount: number;
visitDescription(ctx: DescriptionContext | null): string | undefined;
visitLineBrief(doc: Documentation, ctx: LineBriefContext | null): void;
visitLineParam(doc: Documentation, ctx: LineParamContext | null): void;
visitLineDescription(doc: Documentation, ctx: LineDescriptionContext | null): void;
visitLine(doc: Documentation, ctx: LineContext): void;
visit(ctx: DocumentationContext): Documentation;
}
export { DocVisitor, type DocumentationParam, type Documentation };