TypeChain icon indicating copy to clipboard operation
TypeChain copied to clipboard

Feature request: generate TypeDoc comments from Solidity's Natspec Format

Open ebeloded opened this issue 4 years ago • 4 comments

Solidity documents can be documented with Natspec Format.

It would be super helpful if these comments were added to the generated TypeScript code (in TypeDoc format)

ebeloded avatar Oct 31 '21 21:10 ebeloded

Have you tried it already? some support for natspec is already done: https://github.com/dethcrypto/TypeChain#natspec-support

krzkaczor avatar Oct 31 '21 21:10 krzkaczor

Great that it's already supported! Sorry missed the docs.

I did try it thought. I used zero-config @typechain/hardhat plugin, which apparently doesn't do what the NatSpec support requires.

ebeloded avatar Nov 01 '21 03:11 ebeloded

Is there something simple in hardhat plugin configuration that I need to do to make it work?

ebeloded avatar Nov 01 '21 03:11 ebeloded

I think it might not work with hardhat plugin at the moment. I am gonna reopen this.

krzkaczor avatar Nov 01 '21 08:11 krzkaczor