naddison36 / sol2uml

Solidity contract visualisation tool
MIT License
1.16k stars 275 forks source link

New feature to generate documentation using the NatSpec in contract source code #31

Closed naddison36 closed 2 years ago

naddison36 commented 3 years ago

sol2uml already has the logic to pull the verified source code for a contract from Etherscan or get the source code from the local filesystem. This can be used to then generate contract documentation using a Solidity document generator like solidity-docgen.

A new option would be used to do this. -g, --genDocs

Will also need an option to specify the folder the HTML files should be written to.

naddison36 commented 2 years ago

other tools do this so closing