Files
openzeppelin-contracts/docs/contract.hbs
2019-07-23 15:54:12 -03:00

67 lines
998 B
Handlebars

{{#linkable}}
:{{name}}: pass:normal[xref:#{{anchor}}[`{{name}}`]]
{{/linkable}}
[.contract]
[[{{anchor}}]]
=== `{{name}}`
{{natspec.devdoc}}
{{#if modifiers}}
[.contract-index]
.Modifiers
{{#inheritance}}
{{#ownModifiers}}
* xref:#{{anchor}}[`{{signature}}`]
{{/ownModifiers}}
{{/inheritance}}
{{/if}}
{{#if functions}}
[.contract-index]
.Functions
{{#inheritance}}
{{#ownFunctions}}
* xref:#{{anchor}}[`{{signature}}`]
{{/ownFunctions}}
{{/inheritance}}
{{/if}}
{{#if events}}
[.contract-index]
.Events
{{#inheritance}}
{{#ownEvents}}
* xref:#{{anchor}}[`{{signature}}`]
{{/ownEvents}}
{{/inheritance}}
{{/if}}
{{#ownModifiers}}
[.contract-item]
[[{{anchor}}]]
==== `{{name}}({{args}})`
{{natspec.devdoc}}
{{/ownModifiers}}
{{#ownFunctions}}
[.contract-item]
[[{{anchor}}]]
==== `{{name}}({{args}}){{#if outputs}}{{outputs}}{{/if}}`
{{natspec.devdoc}}
{{/ownFunctions}}
{{#ownEvents}}
[.contract-item]
[[{{anchor}}]]
==== `{{name}}({{args}})`
{{natspec.devdoc}}
{{/ownEvents}}