@solarity/hardhat-markup/dist/src/generator/md-generator/MDGenerator.d.ts

Customizable markdown documentation for smart contracts

import { ContractInfo, Documentation, DocumentationBlock, NatSpecDocumentation } from "../../parser/types.js";
import { MDFactory } from "./MDFactory.js";
export declare class MDGenerator {
    capitalizeFirstLetter(str: string): string;
    generateContractMDStr(contractInfo: ContractInfo): string;
    generateBlockInfo(mdFactory: MDFactory, blockInfos: DocumentationBlock): string | undefined;
    generateBlock(mdFactory: MDFactory, blockInfo: Documentation): void;
    generateDocumentationBlock(mdFactory: MDFactory, documentation: NatSpecDocumentation): void;
    generateElementsBlock(mdFactory: MDFactory, documentation: {
        name?: string;
        type?: string;
        description: string;
    }[]): void;
    generateEnumElementsBlock(mdFactory: MDFactory, documentation: {
        name?: string;
        type?: string;
        description: string;
    }[]): void;
}
//# sourceMappingURL=MDGenerator.d.ts.map