From 9df4f7971e3d05c65d5ccba5cdda03a859f1beb8 Mon Sep 17 00:00:00 2001 From: Francisco Giordano Date: Thu, 17 Oct 2019 18:42:31 -0300 Subject: [PATCH] Design tweaks to documentation template (#1937) * 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 (cherry picked from commit 5d6a040fc37ab49d6cd67164d0edd2a65149dd99) --- docs/contract.hbs | 77 +++++++++++++++++++++++++++++++---------------- 1 file changed, 51 insertions(+), 26 deletions(-) diff --git a/docs/contract.hbs b/docs/contract.hbs index 73aec7291..65eafb910 100644 --- a/docs/contract.hbs +++ b/docs/contract.hbs @@ -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}}]] @@ -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}}