solidity-docgen/dist/common/properties.d.ts

Documentation generator for Solidity smart contracts.

import { EnumDefinition, ErrorDefinition, EventDefinition, FunctionDefinition, ModifierDefinition, StructDefinition, UserDefinedValueTypeDefinition, VariableDeclaration } from 'solidity-ast';
import { NatSpec } from '../utils/natspec';
import { DocItemContext } from '../site';
import { DocItem } from '../doc-item';
type TypeDefinition = StructDefinition | EnumDefinition | UserDefinedValueTypeDefinition;
export declare function type({ item }: DocItemContext): string;
export declare function natspec({ item }: DocItemContext): NatSpec;
export declare function name({ item }: DocItemContext, original?: unknown): string;
export declare function fullName({ item, contract }: DocItemContext): string;
export declare function signature({ item }: DocItemContext): string | undefined;
interface Param extends VariableDeclaration {
    type: string;
    natspec?: string;
}
export declare function params({ item }: DocItemContext): Param[] | undefined;
export declare function returns({ item }: DocItemContext): Param[] | undefined;
export declare function items({ item }: DocItemContext): DocItem[] | undefined;
export declare function functions({ item }: DocItemContext): FunctionDefinition[] | undefined;
export declare function events({ item }: DocItemContext): EventDefinition[] | undefined;
export declare function modifiers({ item }: DocItemContext): ModifierDefinition[] | undefined;
export declare function errors({ item }: DocItemContext): ErrorDefinition[] | undefined;
export declare function variables({ item }: DocItemContext): VariableDeclaration[] | undefined;
export declare function types({ item }: DocItemContext): TypeDefinition[] | undefined;
export {};
//# sourceMappingURL=properties.d.ts.map