Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support natspec in event/state variable/public state variable #343

Closed
kanej opened this issue Jan 3, 2023 · 0 comments · Fixed by #359
Closed

Support natspec in event/state variable/public state variable #343

kanej opened this issue Jan 3, 2023 · 0 comments · Fixed by #359
Assignees
Labels
status:ready This issue is ready to be worked on type:feature New feature or request

Comments

@kanej
Copy link
Member

kanej commented Jan 3, 2023

Similar to #328, provide a subset of natspec auto-inserts on a /** */ completion before an event, state variable or public state variable.

This should be based on the docs: https://docs.soliditylang.org/en/latest/natspec-format.html#tags.

For events it seems to @dev and @param.

But we should investigate why public state variables have an @return while state variables don't.

@kanej kanej added type:feature New feature or request status:ready This issue is ready to be worked on priority:high labels Jan 3, 2023
@kanej kanej moved this to Todo in hardhat-vscode Jan 3, 2023
@kanej kanej removed their assignment Jan 4, 2023
@kanej kanej moved this from Todo to In Progress in hardhat-vscode Jan 5, 2023
@antico5 antico5 moved this from In Progress to Done in hardhat-vscode Jan 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:ready This issue is ready to be worked on type:feature New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants