apidoc

import path from 'path'; import { createDoc } from 'apidoc'; // Resolve paths relative to the current script execution const projectRoot = path.resolve(__dirname, '..'); // Using 'example' folder from a cloned apidoc repository for demonstration const srcPath = path.resolve(projectRoot, 'example'); const destPath = path.resolve(projectRoot, 'docs'); console.log(`Attempting to generate API documentation from: ${srcPath} to: ${destPath}`); const docResult = createDoc({ src: srcPath, dest: destPath, // Set dryRun to true to parse and return data without writing files to disk dryRun: false, // Set silent to true to suppress apidoc's console output during generation silent: false, // Optional: Define custom parsing options or template paths here }); if (typeof docResult !== 'boolean') { console.log('API documentation generated successfully!'); console.log('Parsed API definitions count:', docResult.data.length); console.log('Project information:', docResult.project.name, docResult.project.version); } else { console.error('Failed to generate API documentation. Check logs for detailed errors and ensure source paths are correct and comments are well-formed.'); }