From d5ce0860893d7d058b1e5207acf01152aa017d30 Mon Sep 17 00:00:00 2001 From: Peter Bacon Darwin Date: Wed, 31 May 2017 20:46:56 +0300 Subject: [PATCH] build(aio): fix up API doc-gen templates * Remove whitespace before type specifiers * Generate `new` and `call` member info for interfaces * Ensure that there is no double space after class names --- .../api/includes/class-overview.html | 4 +-- .../api/includes/interface-overview.html | 8 +++--- .../templates/api/includes/members.html | 28 +++++++++++++------ .../templates/api/interface.template.html | 1 - .../templates/api/lib/paramList.html | 2 +- 5 files changed, 26 insertions(+), 17 deletions(-) diff --git a/aio/tools/transforms/templates/api/includes/class-overview.html b/aio/tools/transforms/templates/api/includes/class-overview.html index be7a596083..50701159fc 100644 --- a/aio/tools/transforms/templates/api/includes/class-overview.html +++ b/aio/tools/transforms/templates/api/includes/class-overview.html @@ -1,11 +1,11 @@ {% macro renderMember(member) %}{% if not member.internal -%} -{$ member.name $} {$ params.paramList(member.parameters) | indent(4, false) | trim() $}{$ params.returnType(member.returnType) $} +{$ member.name $}{$ params.paramList(member.parameters) | indent(4, false) | trim() $}{$ params.returnType(member.returnType) $} {%- endif %}{% endmacro -%}

Overview

- {$ doc.docType $} {$ doc.name $} {$ doc.heritage $} { + {$ doc.docType $} {$ doc.name $}{$ doc.heritage $} { {%- if doc.statics.length %}{% for member in doc.statics %} static {$ renderMember(member) $}{% endfor %}{% endif %} {%- if doc.constructorDoc %} diff --git a/aio/tools/transforms/templates/api/includes/interface-overview.html b/aio/tools/transforms/templates/api/includes/interface-overview.html index 46cc8a795a..674ce46655 100644 --- a/aio/tools/transforms/templates/api/includes/interface-overview.html +++ b/aio/tools/transforms/templates/api/includes/interface-overview.html @@ -1,10 +1,10 @@

Interface Overview

- interface {$ doc.name $} {$ doc.heritage $} { {% if doc.newMember %} - {$ doc.newMember.name | indent(6, false) | trim $} {$ params.paramList(doc.newMember.parameters) | indent(8, false) | trim $}{$ params.returnType(doc.newMember.returnType) $}{% endif %}{% if doc.callMember %} - {$ doc.callMember.name | indent(6, false) | trim $} {$ params.paramList(doc.callMember.parameters) | indent(8, false) | trim $}{$ params.returnType(doc.callMember.returnType) $}{% endif %}{% if doc.members.length %}{% for member in doc.members %}{% if not member.internal %} - {$ member.name | indent(6, false) | trim $} {$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}{% endif %}{% endfor %}{% endif %} + interface {$ doc.name $}{$ doc.heritage $} { {% if doc.newMember %} + {$ doc.newMember.name | indent(6, false) | trim $}{$ params.paramList(doc.newMember.parameters) | indent(8, false) | trim $}{$ params.returnType(doc.newMember.returnType) $}{% endif %}{% if doc.callMember %} + {$ doc.callMember.name | indent(6, false) | trim $}{$ params.paramList(doc.callMember.parameters) | indent(8, false) | trim $}{$ params.returnType(doc.callMember.returnType) $}{% endif %}{% if doc.members.length %}{% for member in doc.members %}{% if not member.internal %} + {$ member.name | indent(6, false) | trim $}{$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}{% endif %}{% endfor %}{% endif %} }
\ No newline at end of file diff --git a/aio/tools/transforms/templates/api/includes/members.html b/aio/tools/transforms/templates/api/includes/members.html index f3774ab1e1..7ce487b8bc 100644 --- a/aio/tools/transforms/templates/api/includes/members.html +++ b/aio/tools/transforms/templates/api/includes/members.html @@ -1,19 +1,29 @@ -{% if doc.members.length %} +{% if doc.members.length or doc.newMember or doc.callMember %}

Members

+ {% if doc.newMember %} +
+ + {$ doc.newMember.name $}{$ params.paramList(doc.newMember.parameters) | trim $}{$ params.returnType(doc.newMember.returnType) $} + {% if not doc.newMember.notYetDocumented %}{$ doc.newMember.description | marked $}{% endif %} +
+ {% if doc.members.length or doc.callMember %}
{% endif %} + {% endif %} + {% if doc.callMember %} +
+ + {$ doc.callMember.name $}{$ params.paramList(doc.callMember.parameters) | trim $}{$ params.returnType(doc.callMember.returnType) $} + {% if not doc.callMember.notYetDocumented %}{$ doc.callMember.description | marked $}{% endif %} +
+ {% if doc.members.length %}
{% endif %} + {% endif %} {% for member in doc.members %}{% if not member.internal %}
{$ member.name $}{$ params.paramList(member.parameters) | trim $}{$ params.returnType(member.returnType) $} - {%- if not member.notYetDocumented %} - {$ member.description | marked $} - {% endif %} + {% if not member.notYetDocumented %}{$ member.description | marked $}{% endif %}
- - {% if not loop.last %} -
- {% endif %} - + {% if not loop.last %}
{% endif %} {% endif %}{% endfor %}
{% endif %} diff --git a/aio/tools/transforms/templates/api/interface.template.html b/aio/tools/transforms/templates/api/interface.template.html index 486862f885..728d886a9e 100644 --- a/aio/tools/transforms/templates/api/interface.template.html +++ b/aio/tools/transforms/templates/api/interface.template.html @@ -4,6 +4,5 @@ {% block details %} {% include "includes/interface-overview.html" %} {% include "includes/description.html" %} - {% include "includes/members.html" %} {% endblock %} diff --git a/aio/tools/transforms/templates/api/lib/paramList.html b/aio/tools/transforms/templates/api/lib/paramList.html index 24ba12c080..f04063a824 100644 --- a/aio/tools/transforms/templates/api/lib/paramList.html +++ b/aio/tools/transforms/templates/api/lib/paramList.html @@ -8,5 +8,5 @@ {% macro returnType(returnType) -%} - {%- if returnType %} : {$ returnType | escape $}{% endif -%} + {%- if returnType %}: {$ returnType | escape $}{% endif -%} {%- endmacro -%}