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

Defining arbitrary attributes on items #131

Closed
frangio opened this issue Jan 20, 2020 · 3 comments
Closed

Defining arbitrary attributes on items #131

frangio opened this issue Jan 20, 2020 · 3 comments

Comments

@frangio
Copy link
Contributor

frangio commented Jan 20, 2020

I would like to be able to define arbitrary attributes as part of a natspec comment that would be parsed and made available to the handlebars templates.

Potential syntax:

/**
 * @notice Description...
 * !since v2.5.0
 */
contract Foo { ... }

See OpenZeppelin/openzeppelin-contracts#2054 for the original usecase.

@axic
Copy link

axic commented Mar 17, 2021

Heads up, this has been solved with @custom:... in 0.8.2.

@axic
Copy link

axic commented Sep 8, 2021

Is this supported now or is it still outstanding? I think it is supported based on a quick look, so perhaps this issue can be closed?

@frangio
Copy link
Contributor Author

frangio commented Sep 15, 2021

Yes, custom tags like @custom:foo are supported as of 0.5.13 by using {{natspec.custom.foo}} in the Handlebars template.

Thanks for following up on this!

@frangio frangio closed this as completed Sep 15, 2021
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

No branches or pull requests

2 participants