Feature Request: Show a function's documentation reference when a dev clicks a function's `@inheritdoc` tag

NomicFoundation / hardhat-vscode

Solidity and Hardhat support for Visual Studio Code

https://hardhat.org

MIT License

169 stars 39 forks source link

Feature Request: Show a function's documentation reference when a dev clicks a function's `@inheritdoc` tag #133

Open scorpion9979 opened 2 years ago

scorpion9979 commented 2 years ago

I noticed that the extension currently has no support for the @inheritdoc tag, and I think it would be a very useful feature to be able to display an overridden function's interface documentation in the VSCode references.

Note: code above is from hifi-finance/hifi.

github-actions[bot] commented 2 years ago

This issue is also being tracked on Linear.

We use Linear to manage our development process, but we keep the conversations on Github.

LINEAR-ID: d8ae6723-09f2-4766-b832-3f4d40134b57

kanej commented 2 years ago

Hey @scorpion9979, just to clarify is the idea here that the inheritdoc would become a link of some sort, or that we swap in the documentation inline?

scorpion9979 commented 2 years ago

Hey @scorpion9979, just to clarify is the idea here that the inheritdoc would become a link of some sort, or that we swap in the documentation inline?

Yes, the first part is closer to what I have in mind. I think it would be cool to make the inheritdoc tag link to the smart contract's inline documentation of that particular function.