vitepress-jsdoc/dist/commonjs/parsers/comment.d.ts

A bridge between Vitepress and JSDoc-style commented codebases for hassle-free documentation.

import { type FrontMatterResult } from 'front-matter';
import { type DirectoryFile } from '../interfaces.js';
type VitepressAttributes = {
    title?: string;
    headline?: string;
};
/**
 * Parses the content of a file to search for a @vitepress comment block and extracts the frontmatter data.
 *
 * @function
 * @param {string} fileContent - The content of the file to be parsed.
 * @returns {object} - An object containing the extracted frontmatter data and attributes.
 * @throws {Error} - Returns an object with null values if parsing fails.
 */
export declare const parseComment: (fileContent: string) => FrontMatterResult<VitepressAttributes>;
/**
 * Parses the content of a file and constructs a structured markdown header based on the @vitepress comment block.
 *
 * @function
 * @param {string} content - The content of the file.
 * @param {DirectoryFile} file - The file object containing details like name and extension.
 * @returns {string} - A structured markdown header.
 */
export declare const parseVitepressFileHeader: (content: string, file: DirectoryFile) => string;
export {};
//# sourceMappingURL=comment.d.ts.map