@solarity/hardhat-markup/dist/src/parser/Parser.d.ts

Customizable markdown smart contracts documentation

import { BuildInfo } from "hardhat/types";
import { ContractDefinition, EnumDefinition, ErrorDefinition, EventDefinition, FunctionDefinition, ModifierDefinition, ModifierInvocation, SourceLocation, SourceUnit, StructDefinition, VariableDeclaration } from "solidity-ast";
import { Node } from "solidity-ast/node";
import { ContractInfo, DocumentationBlock, NatSpecDocumentation } from "./types";
export declare class Parser {
    private contractBuildInfo;
    private deref;
    constructor(contractBuildInfo: BuildInfo);
    parseContractInfo(source: string, name: string): Promise<ContractInfo>;
    isInternal(node: FunctionDefinition | VariableDeclaration): boolean;
    isPrivateOrInternal(node: FunctionDefinition | VariableDeclaration): boolean;
    isPublicOrExternal(node: FunctionDefinition | VariableDeclaration): boolean;
    parseSelector(node: FunctionDefinition | VariableDeclaration): string;
    applyPrettier(text: string): Promise<string>;
    parseHeader(node: any): string;
    parseFullSign(node: any): Promise<string>;
    parseDocumentation(nodes: Node[], name: string): Promise<DocumentationBlock>;
    removeTypePrefix(typeString: string): string;
    buildParameterString(parameters: VariableDeclaration[], delimiter?: string, beginning?: string, ending?: string): string;
    parseModifiersString(modifiers: ModifierInvocation[]): string;
    parseFullFunctionSign(functionDefinition: FunctionDefinition): Promise<string>;
    parseStringFromSourceCode(src: SourceLocation): string;
    parseFullStateVariableSign(stateVariable: VariableDeclaration): string;
    parseFullEventSign(eventDefinition: EventDefinition): string;
    parseFullErrorSign(errorDefinition: ErrorDefinition): string;
    parseFullStructSign(structDefinition: StructDefinition): string;
    parseFullEnumSign(enumDefinition: EnumDefinition): string;
    parseFullModifierSign(modifierDefinition: ModifierDefinition): string;
    parseFullContractSign(contractDefinition: ContractDefinition): string;
    parseLicense(node: SourceUnit): string;
    deleteCommentSymbols(text: string): string;
    replaceMultipleNewLinesWithOne(text: string): string;
    getValidParentNodeToInheritDocumentation(baseNode: FunctionDefinition | VariableDeclaration): FunctionDefinition | null;
    findFunctionDefinitionByContractName(node: FunctionDefinition | VariableDeclaration, contractName: string): FunctionDefinition | undefined;
    findModifierDefinitionByContractName(node: ModifierDefinition, contractName: string): ModifierDefinition | undefined;
    parseNameAndDescription(text: string): [name: string, description: string];
    joinDescriptionLines(text: string): string;
    parseNatSpecDocumentation(baseNode: any): NatSpecDocumentation;
}
//# sourceMappingURL=Parser.d.ts.map