mirror of openzeppelin-contracts
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
openzeppelin-contracts/docs/contract.hbs

91 lines
1.6 KiB

{{~#*inline "typed-variable-array"~}}
{{#each .}}[.var-type]#{{typeName}}#{{#if name}} [.var-name]#{{name}}#{{/if}}{{#unless @last}}, {{/unless}}{{/each}}
{{~/inline~}}
{{#each linkable}}
:{{name}}: pass:normal[xref:#{{anchor}}[`{{name}}`]]
{{/each}}
[.contract]
[[{{anchor}}]]
=== `{{name}}`
{{natspec.devdoc}}
{{#if modifiers}}
[.contract-index]
.Modifiers
--
{{#each inheritedItems}}
{{#unless @first}}
[.contract-subindex-inherited]
.{{contract.name}}
{{/unless}}
{{#each modifiers}}
* {xref-{{slug fullName~}} }[`{{name}}({{args.names}})`]
{{/each}}
{{/each}}
--
{{/if}}
{{#if functions}}
[.contract-index]
.Functions
--
{{#each inheritedItems}}
{{#unless @first}}
[.contract-subindex-inherited]
.{{contract.name}}
{{/unless}}
{{#each functions}}
* {xref-{{slug fullName~}} }[`{{name}}({{args.names}})`]
{{/each}}
{{/each}}
--
{{/if}}
{{#if events}}
[.contract-index]
.Events
--
{{#each inheritedItems}}
{{#unless @first}}
[.contract-subindex-inherited]
.{{contract.name}}
{{/unless}}
{{#each events}}
* {xref-{{slug fullName~}} }[`{{name}}({{args.names}})`]
{{/each}}
{{/each}}
--
{{/if}}
{{#each ownModifiers}}
[.contract-item]
[[{{anchor}}]]
==== `{{name}}({{> typed-variable-array args}})` [.item-kind]#modifier#
{{natspec.devdoc}}
{{/each}}
{{#each ownFunctions}}
[.contract-item]
[[{{anchor}}]]
==== `{{name}}({{> typed-variable-array args}}){{#if outputs}}{{> typed-variable-array outputs}}{{/if}}` [.item-kind]#{{visibility}}#
{{natspec.devdoc}}
{{/each}}
{{#each ownEvents}}
[.contract-item]
[[{{anchor}}]]
==== `{{name}}({{> typed-variable-array args}})` [.item-kind]#event#
{{natspec.devdoc}}
{{/each}}