vue-docgen-api/dist/utils/handleComponentJSDoc.d.ts

Toolbox to extract information from Vue component files for documentation generation purposes.

import { NodePath } from 'ast-types/lib/node-path';
import Documentation from '../Documentation';
/**
 * Reads the data from a JSDoc block of a component
 * and adds it to the documentation object
 * @param componentCommentedPath the AST path of the component
 * @param documentation the documentation object to modify
 * @returns
 */
export default function handleComponentJSDoc(componentCommentedPath: NodePath, documentation: Documentation): Promise<void>;