Skip to main content

Module source

Module source 

Source
Expand description

Owned source types. Owned source types extracted from the parse tree for documentation generation.

These types hold only the data needed by the doc writer and preprocessors, avoiding lifetime dependencies on the parser’s arena-allocated AST.

Structs§

BaseInfo
A base contract reference (e.g. is IERC721, Ownable).
ContractSource
Owned contract definition data.
EnumSource
Owned enum definition data.
ErrorSource
Owned error definition data.
EventSource
Owned event definition data.
FunctionSource
Owned function definition data.
ParamInfo
Information about a parameter, struct field, event/error parameter, etc.
StructSource
Owned struct definition data.
TypeSource
Owned type definition data (user-defined value types).
VariableSource
Owned variable definition data.

Enums§

ContractKind
The kind of a contract-like definition.
ParseSource
A wrapper type around owned source data extracted from the parse tree.
VariableAttr
Variable attribute relevant for doc generation.