Added NatSpec support for enum value definitions #9545
Labels
Cmd-forge-doc
Command: forge doc
first issue
A good way to start contributing
T-feature
Type: feature
Component
Forge
Describe the feature you would like
Currently, solidity doesn't support
@param
for enums (according to the natspec format). So when generating the documentation withforge doc
, there is no way to document each enum variant.The suggestion is to define a
@custom:variant
item to describe each enum variant.Foundry already does something similar with unnamed function params ( see here ).
Additional context
Example of result:
The text was updated successfully, but these errors were encountered: