docs: improve NatSpec documentation for all public functions and structs in core EVM contracts #4377
+194
−71
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…in Implementation.sol
…in Governance.sol
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves and adds NatSpec documentation to all public functions and struct fields in the core EVM (Solidity) contracts of the Wormhole project, as required by issue #3477.
Added and improved NatSpec comments for all public and external functions in the following contracts:
Added NatSpec documentation for all struct fields in:
All comments follow the Solidity NatSpec standard 1.
This PR brings the documentation of the core EVM contracts to a state where forge doc can auto-generate high-quality documentation suitable for publication on docs.wormhole.com, as requested in the issue.
Closes #3477