Skip to content

Commit

Permalink
Design tweaks to documentation template (#1937)
Browse files Browse the repository at this point in the history
* switch index to show arg names

* add index separators

* add classes to style variable type and name

* add class for inherited part of index

* use inheritedItems in contracts template

* refactor template to use explicit if and each
  • Loading branch information
frangio authored Oct 17, 2019
1 parent e557a54 commit 5d6a040
Showing 1 changed file with 51 additions and 26 deletions.
77 changes: 51 additions & 26 deletions docs/contract.hbs
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{{#linkable}}
{{~#*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}}`]]
{{/linkable}}
{{/each}}

[.contract]
[[{{anchor}}]]
Expand All @@ -11,56 +15,77 @@
{{#if modifiers}}
[.contract-index]
.Modifiers
{{#inheritance}}
{{#ownModifiers}}
* xref:#{{anchor}}[`{{signature}}`]
{{/ownModifiers}}
{{/inheritance}}
--
{{#each inheritedItems}}
{{#unless @first}}
[.contract-subindex-inherited]
.{{contract.name}}
{{/unless}}
{{#each modifiers}}
* xref:#{{anchor}}[`{{name}}({{args.names}})`]
{{/each}}

{{/each}}
--
{{/if}}

{{#if functions}}
[.contract-index]
.Functions
{{#inheritance}}
{{#ownFunctions}}
* xref:#{{anchor}}[`{{signature}}`]
{{/ownFunctions}}
{{/inheritance}}
--
{{#each inheritedItems}}
{{#unless @first}}
[.contract-subindex-inherited]
.{{contract.name}}
{{/unless}}
{{#each functions}}
* xref:#{{anchor}}[`{{name}}({{args.names}})`]
{{/each}}

{{/each}}
--
{{/if}}

{{#if events}}
[.contract-index]
.Events
{{#inheritance}}
{{#ownEvents}}
* xref:#{{anchor}}[`{{signature}}`]
{{/ownEvents}}
{{/inheritance}}
--
{{#each inheritedItems}}
{{#unless @first}}
[.contract-subindex-inherited]
.{{contract.name}}
{{/unless}}
{{#each events}}
* xref:#{{anchor}}[`{{name}}({{args.names}})`]
{{/each}}

{{/each}}
--
{{/if}}

{{#ownModifiers}}
{{#each modifiers}}
[.contract-item]
[[{{anchor}}]]
==== `{{name}}({{args}})`
==== `pass:normal[{{name}}({{> typed-variable-array args}})]`

{{natspec.devdoc}}

{{/ownModifiers}}
{{/each}}

{{#ownFunctions}}
{{#each functions}}
[.contract-item]
[[{{anchor}}]]
==== `{{name}}({{args}}){{#if outputs}}{{outputs}}{{/if}}` [.visibility]#{{visibility}}#
==== `pass:normal[{{name}}({{> typed-variable-array args}}){{#if outputs}}{{> typed-variable-array outputs}}{{/if}}]` [.visibility]#{{visibility}}#

{{natspec.devdoc}}

{{/ownFunctions}}
{{/each}}

{{#ownEvents}}
{{#each events}}
[.contract-item]
[[{{anchor}}]]
==== `{{name}}({{args}})`
==== `pass:normal[{{name}}({{> typed-variable-array args}})]`

{{natspec.devdoc}}

{{/ownEvents}}
{{/each}}

0 comments on commit 5d6a040

Please sign in to comment.