export type DocumentationType = 'function' | 'class' | 'interface' | 'module' | 'api' | 'readme' | 'changelog' | 'architecture' | 'tutorial' | 'other'; export type DocumentationFormat = 'markdown' | 'jsdoc' | 'tsdoc' | 'asciidoc' | 'rst' | 'plain'; export interface DocSuggestion { readonly id: string; readonly type: DocumentationType; readonly format: DocumentationFormat; readonly title: string; readonly content: string; readonly targetFile?: string; readonly targetFunction?: string; readonly targetClass?: string; readonly targetModule?: string; readonly language?: string; readonly examples?: string[]; readonly parameters?: DocParameter[]; readonly returnType?: string; readonly seeAlso?: string[]; readonly metadata?: Record; } export interface DocParameter { readonly name: string; readonly type: string; readonly description: string; readonly required: boolean; readonly defaultValue?: string; } export interface DocSuggestionBuilder { id(id: string): DocSuggestionBuilder; type(type: DocumentationType): DocSuggestionBuilder; format(format: DocumentationFormat): DocSuggestionBuilder; title(title: string): DocSuggestionBuilder; content(content: string): DocSuggestionBuilder; targetFile(targetFile: string): DocSuggestionBuilder; targetFunction(targetFunction: string): DocSuggestionBuilder; targetClass(targetClass: string): DocSuggestionBuilder; targetModule(targetModule: string): DocSuggestionBuilder; language(language: string): DocSuggestionBuilder; addExample(example: string): DocSuggestionBuilder; examples(examples: string[]): DocSuggestionBuilder; addParameter(parameter: DocParameter): DocSuggestionBuilder; parameters(parameters: DocParameter[]): DocSuggestionBuilder; returnType(returnType: string): DocSuggestionBuilder; addSeeAlso(seeAlso: string): DocSuggestionBuilder; seeAlso(seeAlso: string[]): DocSuggestionBuilder; metadata(metadata: Record): DocSuggestionBuilder; build(): DocSuggestion; } export declare class DocSuggestionImpl implements DocSuggestionBuilder { private doc; id(id: string): DocSuggestionBuilder; type(type: DocumentationType): DocSuggestionBuilder; format(format: DocumentationFormat): DocSuggestionBuilder; title(title: string): DocSuggestionBuilder; content(content: string): DocSuggestionBuilder; targetFile(targetFile: string): DocSuggestionBuilder; targetFunction(targetFunction: string): DocSuggestionBuilder; targetClass(targetClass: string): DocSuggestionBuilder; targetModule(targetModule: string): DocSuggestionBuilder; language(language: string): DocSuggestionBuilder; addExample(example: string): DocSuggestionBuilder; examples(examples: string[]): DocSuggestionBuilder; addParameter(parameter: DocParameter): DocSuggestionBuilder; parameters(parameters: DocParameter[]): DocSuggestionBuilder; returnType(returnType: string): DocSuggestionBuilder; addSeeAlso(seeAlso: string): DocSuggestionBuilder; seeAlso(seeAlso: string[]): DocSuggestionBuilder; metadata(metadata: Record): DocSuggestionBuilder; build(): DocSuggestion; } //# sourceMappingURL=DocSuggestion.d.ts.map