Closed vrde closed 1 year ago
Both questions relate to the default template:
@dev
tag contents in italics (therefore the underscores).You can change both of these by creating a directory docgen-templates
and adding to your Hardhat config: docgen: { templates: 'docgen-templates' }
, then copying the default common.hbs
into that directory and making some changes to it. For example, you can change {{h}} {{name}}
(the title) into:
{{#if natspec.title}}
{{h}} {{natspec.title}}
{{#else}}
{{h}} {{name}}
{{/if}}
And you can remove the underscores around {{{natspec.dev}}}
if you want to get rid of them.
Let me know how this goes.
:wave: hey I'm quite new to this library. I have a couple of issues, one with
@title
and the other one with@dev
, they are both summarized by the following example:Input:
Output:
First: where is
@title
rendered?Second: how do I create a
@dev
comment that spreads across multiple lines without using_
? The@dev
tag works correctly (multilines are maintained, great!) but the parser adds_
at the beginning and at the end of the multiline string. Am I using@dev
incorrectly?