tsdoc-markdown/dist/types/docs.d.ts

Generates markdown documentation from TypeScript source code.

import type { BuildOptions, DocEntry } from './types';
/**
 * Build the documentation entries for the selected sources.
 *
 * @param {inputFiles: string[]; options?: CompilerOptions;} params
 * @param {string[]} params.inputFiles The list of files to scan and for which the documentation should be build.
 * @param {CompilerOptions} params.options Optional compiler options to generate the docs
 *
 * @returns An array of documentation entries
 */
export declare const buildDocumentation: ({ inputFiles, options }: {
    inputFiles: string[];
    options?: BuildOptions | undefined;
}) => DocEntry[];