build(aio): update doc-gen templates

aio/tools/transforms/templates/api/class.template.html

@@ -1,14 +1,14 @@
+{% import "lib/memberHelpers.html" as memberHelpers -%}
 {% import "lib/paramList.html" as params -%}
 {% extends 'export-base.template.html' -%}
 
 {% block details %}
-
 {% include "includes/class-overview.html" %}
 {% block additional %}{% endblock %}
 {% include "includes/description.html" %}
 {% include "includes/annotations.html" %}
-{% include "includes/statics.html" %}
+{$ memberHelpers.renderMemberDetails(doc.statics, 'static-members', 'static-member', 'Static Members') $}
 {% include "includes/constructor.html" %}
-{% include "includes/members.html" %}
+{$ memberHelpers.renderMemberDetails(doc.members, 'instance-members', 'instance-member', 'Members') $}
 
 {% endblock %}

aio/tools/transforms/templates/api/decorator.template.html

@@ -1,7 +1,9 @@
+{% import "lib/memberHelpers.html" as memberHelper -%}
 {% import "lib/paramList.html" as params -%}
 {% extends 'export-base.template.html' %}
 
 {% block details %}
+  {% include "includes/interface-overview.html" %}
   {% include "includes/description.html" %}
-  {% include "includes/metadata.html" %}
+  {$ memberHelper.renderMemberDetails(doc.members, 'metadata-members', 'metadata-member', 'Metadata Properties') $}
 {% endblock %}

aio/tools/transforms/templates/api/directive.template.html

@@ -1,9 +1,10 @@
+{% import "lib/directiveHelpers.html" as directiveHelper -%}
 {% import "lib/paramList.html" as params -%}
 {% extends 'class.template.html' -%}
 
 {% block additional -%}
   {% include "includes/selectors.html" %}
-  {% include "includes/outputs.html" %}
+  {$ directiveHelper.renderBindings(doc.inputs, 'inputs', 'input', 'Inputs') $}
-  {% include "includes/inputs.html" %}
+  {$ directiveHelper.renderBindings(doc.outputs, 'outputs', 'output', 'Outputs') $}
   {% include "includes/export-as.html" %}
 {% endblock %}

aio/tools/transforms/templates/api/function.template.html

@@ -2,8 +2,21 @@
 {% extends 'export-base.template.html' -%}
 
 {% block details %}
+{% if doc.overloads.length === 1 %}
   <code-example language="ts" hideCopy="true">
-  function {$ doc.name $}{$ params.paramList(doc.parameters) $}: {$ doc.returnType or 'any' $};
+  function {$ doc.overloads[0].name $}{$ params.paramList(doc.overloads[0].parameters) $}
+  {%- if doc.overloads[0].type %}: {$ doc.overloads[0].type | escape $}{% endif %};
   </code-example>
   {% include "includes/description.html" %}
+{% else %}
+  <h2>Overloads</h2>{% for overload in doc.overloads %}
+  <code-example language="ts" hideCopy="true">
+  function {$ overload.name $}{$ params.paramList(overload.parameters) $}
+  {%- if overload.type %}: {$ overload.type | escape $}{% endif %};
+  </code-example>
+  <section class="description">
+    {$ overload.description | trimBlankLines | marked $}
+  </section>
+{% endfor %}
+{% endif %}
 {% endblock %}

aio/tools/transforms/templates/api/includes/class-overview.html

@@ -1,17 +1,13 @@
-{% macro renderMember(member) %}{% if not member.internal -%}
+{% import "lib/memberHelpers.html" as memberHelper -%}
-<a class="code-anchor" href="#{$ member.name $}">{$ member.name $}</a>{$ params.paramList(member.parameters) | indent(4, false) | trim() $}{$ params.returnType(member.returnType) $}
-{%- endif %}{% endmacro -%}
 
-<section class="class-overview">
+<section class="{$ doc.docType $}-overview">
   <h2>Overview</h2>
   <code-example language="ts" hideCopy="true">
-  {$ doc.docType $} {$ doc.name $}{$ doc.heritage $} {
+  {$ doc.docType $} {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} {
-  {%- if doc.statics.length %}{% for member in doc.statics %}
+  {%- if doc.statics.length %}{% for member in doc.statics %}{% if not member.internal %}
-    static {$ renderMember(member) $}{% endfor %}{% endif %}
+    <a class="code-anchor" href="#{$ member.anchor $}">{$ memberHelper.renderMember(member) $}</a>{% endif %}{% endfor %}{% endif %}
-  {%- if doc.constructorDoc %}
+  {%- if doc.members.length %}{% for member in doc.members %}{% if not member.internal %}
-    {$ renderMember(doc.constructorDoc) $}{% endif %}
+    <a class="code-anchor" href="#{$ member.anchor $}">{$ memberHelper.renderMember(member) $}</a>{% endif %}{% endfor %}{% endif %}
-  {%- if doc.members.length %}{% for member in doc.members %}
-    {$ renderMember(member) $}{% endfor %}{% endif %}
   }
   </code-example>
-</section>
+</section>

aio/tools/transforms/templates/api/includes/export-as.html

@@ -1,8 +1,8 @@
-{%- if doc.directiveOptions.exportAs %}
+{%- if doc.exportAs %}
 <section class="export-as">
   <h2>Exported as</h2>
   <div>
-    <code>{$ doc.directiveOptions.exportAs $}</code>
+    <code>{$ doc.exportAs $}</code>
   </div>
 </section>
 {% endif %}

aio/tools/transforms/templates/api/includes/inputs.html

@@ -1,11 +0,0 @@
-{% if doc.inputs %}
-<section class="inputs">
-  <h2>Inputs</h2>
-  {% for binding, property in doc.inputs %}
-  <div class="input">
-    <code>{$ property.bindingName $}</code>&nbsp;bound to&nbsp;<code>{$ property.memberDoc.classDoc.name $}.{$ property.propertyName $}</code>
-    {$ property.memberDoc.description | trimBlankLines | marked $}
-  </div>
-  {% endfor %}
-</section>
-{% endif %}

aio/tools/transforms/templates/api/includes/interface-overview.html

@@ -1,10 +1,10 @@
+{% import "lib/memberHelpers.html" as memberHelper -%}
+
 <section class="interface-overview">
   <h2>Interface Overview</h2>
   <code-example language="ts" hideCopy="true">
-  interface {$ doc.name $}{$ doc.heritage $} { {% if doc.newMember %}
+  interface {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} { {% if doc.members.length %}{% for member in doc.members %}{% if not member.internal %}
-    <a class="code-anchor" href="#{$ doc.newMember.name $}">{$ doc.newMember.name | indent(6, false) | trim $}</a>{$ params.paramList(doc.newMember.parameters) | indent(8, false) | trim $}{$ params.returnType(doc.newMember.returnType) $}{% endif %}{% if doc.callMember %}
+    <a class="code-anchor" href="#{$ member.anchor $}">{$ memberHelper.renderMember(member) $}</a>{% endif %}{% endfor %}{% endif %}
-    <a class="code-anchor" href="#{$ doc.callMember.name $}">{$ doc.callMember.name | indent(6, false) | trim $}</a>{$ 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 %}
-    <a class="code-anchor" href="#{$ member.name $}">{$ member.name | indent(6, false) | trim $}</a>{$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}{% endif %}{% endfor %}{% endif %}
   }
   </code-example>
 </section>

aio/tools/transforms/templates/api/includes/members.html

@@ -1,29 +0,0 @@
-{% if doc.members.length or doc.newMember or doc.callMember %}
-<section class="member-members">
-  <h2>Members</h2>
-  {% if doc.newMember %}
-    <div class="new-member">
-      <a id="{$ doc.newMember.name $}"></a>
-      <code-example hideCopy="true">{$ doc.newMember.name $}{$ params.paramList(doc.newMember.parameters) | trim $}{$ params.returnType(doc.newMember.returnType) $}</code-example>
-      {% if not doc.newMember.notYetDocumented %}{$ doc.newMember.description | marked $}{% endif %}
-    </div>
-    {% if doc.members.length or doc.callMember %}<hr>{% endif %}
-  {% endif %}
-  {% if doc.callMember %}
-    <div class="call-member">
-      <a id="{$ doc.callMember.name $}"></a>
-      <code-example hideCopy="true">{$ doc.callMember.name $}{$ params.paramList(doc.callMember.parameters) | trim $}{$ params.returnType(doc.callMember.returnType) $}</code-example>
-      {% if not doc.callMember.notYetDocumented %}{$ doc.callMember.description | marked $}{% endif %}
-    </div>
-    {% if doc.members.length %}<hr>{% endif %}
-  {% endif %}
-  {% for member in doc.members %}{% if not member.internal %}
-    <div class="instance-member">
-      <a id="{$ member.name $}"></a>
-      <code-example hideCopy="true">{$ member.name $}{$ params.paramList(member.parameters) | trim $}{$ params.returnType(member.returnType) $}</code-example>
-      {% if not member.notYetDocumented %}{$ member.description | marked $}{% endif %}
-    </div>
-    {% if not loop.last %}<hr>{% endif %}
-  {% endif %}{% endfor %}
-</section>
-{% endif %}

aio/tools/transforms/templates/api/includes/metadata.html

@@ -4,7 +4,7 @@
     {% for metadata in doc.members %}{% if not metadata.internal %}
     <div class="metadata-member">
       <a name="{$ metadata.name $}" class="anchor-offset"></a>
-      <code-example hideCopy="true">{$ metadata.name $}{$ params.paramList(metadata.parameters) | trim $}{$ params.returnType(metadata.returnType) $}</code-example>
+      <code-example hideCopy="true">{$ metadata.name $}{$ params.paramList(metadata.parameters) | trim $}{$ params.returnType(metadata.type) $}</code-example>
       {%- if not metadata.notYetDocumented %}{$ metadata.description | marked $}{% endif -%}
     </div>
     {% if not loop.last %}<hr class="hr-margin">{% endif %}

aio/tools/transforms/templates/api/includes/outputs.html

@@ -1,11 +0,0 @@
-{% if doc.outputs %}
-<section class="outputs">
-  <h2>Outputs</h2>
-  {% for binding, property in doc.outputs %}
-  <div class="output">
-    <code>{$ property.bindingName $}</code>&nbsp;bound to&nbsp;<code>{$ property.memberDoc.classDoc.name $}.{$ property.propertyName $}</code>
-    {$ property.memberDoc.description | trimBlankLines | marked $}
-  </div>
-  {% endfor %}
-</section>
-{% endif %}

aio/tools/transforms/templates/api/includes/selectors.html

@@ -1,7 +1,7 @@
-{%- if doc.directiveOptions.selector.split(',').length %}
+{%- if doc.selector %}
 <section class="selectors">
   <h2>Selectors</h2>
-  {% for selector in doc.directiveOptions.selector.split(',') %}
+  {% for selector in doc.selector.split(',') %}
   <div class="selector">
     <code>{$ selector $}</code>
   </div>

aio/tools/transforms/templates/api/includes/statics.html

@@ -1,19 +0,0 @@
-{% if doc.statics.length %}
-<section class="static-members">
-  <h2>Static Members</h2>
-  {% for member in doc.statics %}{% if not member.internal %}
-    <div class="static-member">
-      <a id="{$ member.name $}"></a>
-      <code-example hideCopy="true">{$ member.name $}{$ params.paramList(member.parameters) | trim $}{$ params.returnType(member.returnType) $}</code-example>
-      {%- if not member.notYetDocumented %}
-      {$ member.description | marked $}
-      {% endif %}
-    </div>
-
-    {% if not loop.last %}
-    <hr>
-    {% endif %}
-
-  {% endif %}{% endfor %}
-</section>
-{% endif %}

aio/tools/transforms/templates/api/interface.template.html

@@ -1,8 +1,9 @@
 {% import "lib/paramList.html" as params -%}
+{% import "lib/memberHelpers.html" as memberHelper -%}
 {% extends 'export-base.template.html' -%}
 
 {% block details %}
   {% include "includes/interface-overview.html" %}
   {% include "includes/description.html" %}
-  {% include "includes/members.html" %}
+  {$ memberHelper.renderMemberDetails(doc.members, 'instance-members', 'instance-member', 'Members') $}
 {% endblock %}

aio/tools/transforms/templates/api/lib/directiveHelpers.html

@@ -0,0 +1,13 @@
+{% macro renderBindings(bindings, cssContainerClass, cssItemClass, title) -%}
+{% if bindings.length %}
+<section class="{$ cssContainerClass $}">
+  <h2>{$ title $}</h2>
+  {% for binding in bindings %}
+  <div class="{$ cssItemClass $}">
+    <code>{$ binding.bindingName $}</code>&nbsp;bound to&nbsp;<code>{$ binding.memberDoc.containerDoc.name $}.{$ binding.propertyName $}</code>
+    {#{$ binding.memberDoc.description | trimBlankLines | marked $}#}
+  </div>
+  {% endfor %}
+</section>
+{% endif %}
+{%- endmacro %}

aio/tools/transforms/templates/api/lib/memberHelpers.html

@@ -0,0 +1,42 @@
+{% import "lib/paramList.html" as params -%}
+
+{%- macro renderHeritage(exportDoc) -%}
+  {%- if exportDoc.extendsClauses.length %} extends {% for clause in exportDoc.extendsClauses -%}
+  {$ clause $}{% if not loop.last %}, {% endif -%}
+  {% endfor %}{% endif %}
+  {%- if exportDoc.implementsClauses.length %} implements {% for clause in exportDoc.implementsClauses -%}
+  {$ clause $}{% if not loop.last %}, {% endif -%}
+  {% endfor %}{% endif %}
+{%- endmacro -%}
+
+{%- macro renderMember(member) -%}
+    {%- if member.accessibility !== 'public' %}{$ member.accessibility $} {% endif -%}
+    {%- if member.isGetAccessor %}get {% endif -%}
+    {%- if member.isSetAccessor %}set {% endif -%}
+    {%- if member.isStatic  %}static {% endif -%}
+    {$ member.name $}{$ member.typeParameters | escape $}{$ params.paramList(member.parameters) | trim $}
+    {%- if member.isOptional  %}?{% endif -%}
+    {$ params.returnType(member.type) $}
+{%- endmacro -%}
+
+{%- macro renderMemberDetail(member, cssClass) -%}
+<div class="{$ cssClass $}">
+  <a id="{$ member.anchor $}"></a>
+  <code-example hideCopy="true">{$ renderMember(member) $}</code-example>
+  {%- if not member.notYetDocumented %}
+  {$ member.description | marked $}
+  {% endif -%}
+</div>
+{% endmacro -%}
+
+{% macro renderMemberDetails(members, containerClass, itemClass, titleText) %}
+{% if members.length %}
+<section class="{$ containerClass $}">
+  <h2>{$ titleText $}</h2>
+  {% for member in members %}{% if not member.internal %}
+    {$ renderMemberDetail(member, itemClass) $}
+    {% if not loop.last %}<hr>{% endif %}
+  {% endif %}{% endfor %}
+</section>
+{% endif %}
+{% endmacro %}

aio/tools/transforms/templates/api/type-alias.template.html

@@ -2,7 +2,7 @@
 
 {% block details %}
   <code-example language="ts" hideCopy="true">
-  type {$ doc.name $} = {$ doc.typeDefinition $};
+  type {$ doc.name $}{% if doc.typeDefinition %} = {$ doc.typeDefinition | escape $}{% endif %};
   </code-example>
   {% include "includes/description.html" %}
 {% endblock %}

aio/tools/transforms/templates/includes/_class-overview.html

@@ -1,75 +0,0 @@
-<section class="class-overview api-section">
-  <h2>Properties and Methods</h2>
-  <div class="api-doc-code">
-
-  <table class="api-table">
-      <thead>
-      <tr>
-        <th colspan="2">{$ doc.name $} Properties</th>
-      </tr>
-      </thead>
-      <tbody>
-        
-      <!-- STATISTICS -->
-      {% if doc.statics.length %}
-        {% for member in doc.statics %}{% if not member.internal %}>
-          <tr class="statics">
-            <th>
-              <pre>
-                <code><a class="code-anchor" href="#{$ member.name $}-anchor">{$ member.name $}</a></code>
-              </pre>
-            </th>
-            <td>
-              <pre class="prettyprint">
-                <code>
-                  {$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}
-                </code>
-              </pre>
-            </td>
-          </tr>
-        {% endif %}{% endfor %}
-      {% endif %}
-
-      <!-- CONSTRUCTOR -->
-      {% if doc.constructorDoc.name %}
-        <tr class="constructor">
-          <th>
-            <pre class="prettyprint">
-              <code><a class="code-anchor" href="#constructor">{$ doc.constructorDoc.name $}</a></code>
-            </pre>
-          </th>
-          <td>
-            <pre>
-              <code>{$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}</code>
-            </pre>
-          </td>
-        </tr>
-      {% endif %}
-
-      <!-- MEMBERS -->
-      {% if doc.members.length %}
-        {% for member in doc.members %}{% if not member.internal %}
-          <tr class="members">
-            <th>
-              <pre class="prettyprint">
-                <code>
-                  <a class="code-anchor" href="#{$ member.name $}-anchor">{$ member.name | indent(6, false) | trim $}</a>
-                </code>
-              </pre>
-            </th>
-            <td>
-              <pre>
-                <code>
-                  {$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}
-                </code>
-              </pre>
-            </td>
-          </tr>
-        {% endif %}{% endfor %}
-    {% endif %}
-    </tbody>
-    </table>
-
-  </div>
-
-</section>