/**
 * @file Main entry point for the APIDoc library
 *
 * APIDoc creates documentation from API descriptions in your source code.
 * This is a RESTful web API Documentation Generator with TypeScript support.
 *
 * @package
 * @version 4.0.0
 * @author Href Spa <hola@apidoc.app>
 * @copyright 2025 Href SpA
 * @license MIT
 * @see {@link https://apidocjs.com} Official documentation
 * @see {@link https://github.com/hrefcl/apidoc} GitHub repository
 *
 * This project is a TypeScript refactor inspired by the original apidoc project.
 *
 * @example
 * ```typescript
 * import { createDoc } from '@hrefcl/apidoc';
 *
 * const result = createDoc({
 *   src: ['./src'],
 *   dest: './doc',
 *   name: 'My API'
 * });
 *
 * if (typeof result !== 'boolean') {
 *   console.log('API Documentation generated successfully');
 *   console.log('Data:', result.data);
 *   console.log('Project info:', result.project);
 * }
 * ```
 */
import { ApiDocOptions, ApiDocParseResult } from '../src/types';
/**
 * Creates API documentation from source code comments
 *
 * This is the main entry point for generating API documentation. It processes
 * source files containing API documentation comments and generates HTML output.
 *
 * @param options - Configuration options for documentation generation
 * @param options.src - Source files or directories to process (array or string)
 * @param options.dest - Output directory for generated documentation
 * @param options.name - Name of the API project
 * @param options.version - Version of the API
 * @param options.description - Description of the API project
 * @param options.title - Title for the generated documentation
 * @param options.url - Base URL of the API
 * @param options.sampleUrl - Sample URL for API requests
 * @param options.header - Header configuration object
 * @param options.footer - Footer configuration object
 * @param options.template - Custom template directory
 * @param options.config - Configuration file path
 * @param options.apiprivate - Include private API endpoints
 * @param options.verbose - Enable verbose logging
 * @param options.debug - Enable debug mode
 * @param options.silent - Suppress all output
 * @param options.simulate - Dry run mode (don't write files)
 * @param options.warnError - Treat warnings as errors and exit with error code
 * @param options.markdown - Enable markdown parsing in descriptions
 * @param options.lineEnding - Line ending style (CRLF or LF)
 * @param options.encoding - File encoding (default: utf8)
 *
 * @returns Processing result:
 *   - `ApiDocParseResult` object with `data` and `project` properties if successful
 *   - `true` if there are no files to process
 *   - `false` if an error occurred during processing
 *
 * @throws {Error} Throws error if options are invalid or processing fails
 *
 * @example Basic usage
 * ```typescript
 * import { createDoc } from '@hrefcl/apidoc';
 *
 * const result = createDoc({
 *   src: ['./src/controllers'],
 *   dest: './docs/api'
 * });
 *
 * if (typeof result !== 'boolean') {
 *   console.log('Generated docs for', result.project.name);
 * }
 * ```
 *
 * @example Advanced configuration
 * ```typescript
 * const result = createDoc({
 *   src: ['./src/api', './src/controllers'],
 *   dest: './public/docs',
 *   name: 'My REST API',
 *   version: '1.2.0',
 *   description: 'A comprehensive REST API for managing resources',
 *   url: 'https://api.example.com/v1',
 *   sampleUrl: 'https://api.example.com/v1',
 *   header: {
 *     title: 'Introduction',
 *     filename: './docs/header.md'
 *   },
 *   footer: {
 *     title: 'Additional Info',
 *     filename: './docs/footer.md'
 *   },
 *   verbose: true,
 *   apiprivate: false
 * });
 * ```
 *
 * @example Error handling
 * ```typescript
 * try {
 *   const result = createDoc({
 *     src: ['./nonexistent'],
 *     dest: './docs'
 *   });
 *
 *   if (result === false) {
 *     console.error('Documentation generation failed');
 *   } else if (result === true) {
 *     console.log('No API documentation found');
 *   } else {
 *     console.log('Success:', result.data.length, 'endpoints documented');
 *   }
 * } catch (error) {
 *   console.error('Configuration error:', error.message);
 * }
 * ```
 *
 * @see {@link https://apidocjs.com} Complete documentation
 * @see {@link https://apidocjs.com/example} Live example
 * @since 4.0.0
 * @public
 */
declare function createDoc(options: ApiDocOptions): ApiDocParseResult | boolean;
export { createDoc };
//# sourceMappingURL=index.d.ts.map