-
Notifications
You must be signed in to change notification settings - Fork 120
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
NatSpec @notice, @param and @dev for enums and structs #432
Comments
This is a problem with the Solidity compiler. I might be able to work around it with some effort but it really needs to be fixed upstream. See ethereum/solidity#12295. |
Would really love to have this feature! |
This should work out of the box already for structs and enums as long as Solidity >=0.8.20 is used.
|
I believe this feature should be implemented. |
Came looking for this, would be a perfect addition. |
- Fixed NatSpec problems - Manually edited some solidity-docgen output If the following issues get resolved, we'll be able to correctly run solidity-docgen. - [Uderscores are incorrectly placed](OpenZeppelin/solidity-docgen#432) - [Structs are not documented](OpenZeppelin/solidity-docgen#432)
It would be great if NatSpec
@notice
,@param
and@dev
comments on structs and enums would be available in the documentation.For example, having
and documenting it with
I am aware of #413, but still unsure if this is possible by now or not because of insufficiencies of the solidity compiler.
The text was updated successfully, but these errors were encountered: