-
Notifications
You must be signed in to change notification settings - Fork 97
/
contract.hbs
72 lines (60 loc) · 1.37 KB
/
contract.hbs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# `{{name}}`
{{{natspec.userdoc}}}
{{{natspec.devdoc}}}
{{#if ownModifiers}}
## Modifiers:
{{#ownModifiers}}
- `{{name}}({{args}})`
{{/ownModifiers}}
{{/if}}
{{#if ownFunctions}}
## Functions:
{{#ownFunctions}}
- `{{name}}({{args}}) ({{visibility}})`
{{/ownFunctions}}
{{/if}}
{{#if ownEvents}}
## Events:
{{#ownEvents}}
- `{{name}}({{args}})`
{{/ownEvents}}
{{/if}}
{{#ownModifiers}}
### Modifier `{{name}}({{args}})`
{{#if natspec.userdoc}}{{natspec.userdoc}}{{/if}}
{{#if natspec.devdoc}}{{natspec.devdoc}}{{/if}}
{{#if natspec.params}}
#### Parameters:
{{#natspec.params}}
- `{{param}}`: {{description}}
{{/natspec.params}}
{{/if}}
{{/ownModifiers}}
{{#ownFunctions}}
### Function `{{name}}({{args}}){{#if outputs}} → {{outputs}}{{/if}} {{visibility}}`
{{#if natspec.userdoc}}{{natspec.userdoc}}{{/if}}
{{#if natspec.devdoc}}{{natspec.devdoc}}{{/if}}
{{#if natspec.params}}
#### Parameters:
{{#natspec.params}}
- `{{param}}`: {{description}}
{{/natspec.params}}
{{/if}}
{{#if natspec.returns}}
#### Return Values:
{{#natspec.returns}}
- {{param}} {{description}}
{{/natspec.returns}}
{{/if}}
{{/ownFunctions}}
{{#ownEvents}}
### Event `{{name}}({{args}})`
{{#if natspec.userdoc}}{{natspec.userdoc}}{{/if}}
{{#if natspec.devdoc}}{{natspec.devdoc}}{{/if}}
{{#if natspec.params}}
#### Parameters:
{{#natspec.params}}
- `{{param}}`: {{description}}
{{/natspec.params}}
{{/if}}
{{/ownEvents}}