Skip to content

docs(evm): add meaningful NatSpec documentation to core EVM contracts#4682

Open
awixor wants to merge 9 commits intowormhole-foundation:mainfrom
awixor:improve-evm-contract-natspec-docs
Open

docs(evm): add meaningful NatSpec documentation to core EVM contracts#4682
awixor wants to merge 9 commits intowormhole-foundation:mainfrom
awixor:improve-evm-contract-natspec-docs

Conversation

@awixor
Copy link
Copy Markdown

@awixor awixor commented Feb 20, 2026

Closes #3477

What this PR does

Adds and improves NatSpec documentation across all core EVM contracts so that forge doc can auto-generate developer documentation suitable for docs.wormhole.com.

Contracts updated

  • Structs.sol — documented all struct fields (VAA concept, guardian set lifecycle, ECDSA sig components, Wormhole chain ID distinction)
  • Getters.sol — documented all public getters with Wormhole-specific context
  • Messages.sol — added @notice/@param/@return to all public functions
  • Governance.sol — documented all governance action functions
  • GovernanceStructs.sol — documented all structs and parse functions, including governance action codes (1–5)
  • Implementation.sol — documented publishMessage and initialize
    interfaces/IWormhole.sol — full interface documentation (primary developer-facing entrypoint)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve EVM contract natspec docs

1 participant