/** * Documentation Quality Analyzer * Assesses JSDoc coverage and documentation quality across the codebase * * Migrated from TypeScript Compiler API to tree-sitter AST patterns. */ import { AnalyzerDefinition, AnalyzerResult, AuditOptions, ProgressCallback } from '../types.js'; /** * Configuration for documentation analyzer */ export interface DocumentationAnalyzerConfig { requireFunctionDocs: boolean; requireComponentDocs: boolean; requireFileDocs: boolean; requireParamDocs: boolean; requireReturnDocs: boolean; minDescriptionLength: number; checkExportedOnly: boolean; exemptPatterns: string[]; } export declare const DEFAULT_DOCUMENTATION_CONFIG: DocumentationAnalyzerConfig; /** * Documentation quality metrics for reporting */ export interface DocumentationMetrics { totalFunctions: number; documentedFunctions: number; totalComponents: number; documentedComponents: number; totalFiles: number; filesWithPurpose: number; functionsWithParams: number; paramsDocumented: number; functionsWithReturns: number; returnsDocumented: number; coverageScore: number; wellDocumentedFiles: string[]; poorlyDocumentedFiles: string[]; } /** * Main documentation analyzer function. * Runs across all provided files and aggregates results. */ export declare function analyzeDocumentation(files: string[], config?: Partial, options?: AuditOptions, progressCallback?: ProgressCallback): Promise; /** * Documentation analyzer definition for the registry */ export declare const documentationAnalyzer: AnalyzerDefinition; //# sourceMappingURL=documentationAnalyzer.d.ts.map