build(aio): render grouped overloads

(cherry picked from commit be3352a084)
This commit is contained in:
Peter Bacon Darwin
2017-07-12 23:06:02 +01:00
committed by Igor Minar
parent 0558c6f42a
commit c8b4e21a9a
8 changed files with 97 additions and 26 deletions

View File

@ -2,15 +2,14 @@
{% extends 'export-base.template.html' -%}
{% block details %}
{% if doc.overloads.length === 1 %}
<code-example language="ts" hideCopy="true">
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 %}
<code-example language="ts" hideCopy="true" class="no-box api-heading">
function {$ doc.name $}{$ params.paramList(doc.parameters) $}
{%- if doc.type %}: {$ doc.type | escape $}{% endif %};
</code-example>
{% include "includes/description.html" %}
{% if doc.overloads.length %}
<h2>Overloads</h2>{% for overload in doc.overloads %}
<code-example language="ts" hideCopy="true">
<code-example language="ts" hideCopy="true" class="no-box api-heading">
function {$ overload.name $}{$ params.paramList(overload.parameters) $}
{%- if overload.type %}: {$ overload.type | escape $}{% endif %};
</code-example>

View File

@ -2,7 +2,7 @@
<section class="constructor">
<a id="{$ doc.constructorDoc.name $}"></a>
<h2>Constructor</h2>
<code-example hideCopy="true">{$ doc.constructorDoc.name $}{$ params.paramList(doc.constructorDoc.parameters) $}</code-example>
<code-example hideCopy="true" class="no-box api-heading">{$ doc.constructorDoc.name $}{$ params.paramList(doc.constructorDoc.parameters) $}</code-example>
{% if not doc.constructorDoc.notYetDocumented %}{$ doc.constructorDoc.description | marked $}{% endif %}
</section>
{% endif %}

View File

@ -22,7 +22,7 @@
{%- macro renderMemberDetail(member, cssClass) -%}
<div class="{$ cssClass $}">
<a id="{$ member.anchor $}"></a>
<code-example hideCopy="true">{$ renderMember(member) $}</code-example>
<code-example hideCopy="true" class="no-box api-heading">{$ renderMember(member) $}</code-example>
{%- if not member.notYetDocumented %}
{$ member.description | marked $}
{% endif -%}
@ -35,7 +35,17 @@
<h2>{$ titleText $}</h2>
{% for member in members %}{% if not member.internal %}
{$ renderMemberDetail(member, itemClass) $}
{% if not loop.last %}<hr>{% endif %}
{% if member.overloads.length %}
<details class="overloads">
<summary>Overloads</summary>
<div class="detail-contents">
{% for overload in member.overloads %}
{$ renderMemberDetail(overload, itemClass + '-overload') $}
{% endfor %}
</div>
</details>
{% endif %}
{% if not loop.last %}<hr class="hr-margin">{% endif %}
{% endif %}{% endfor %}
</section>
{% endif %}

View File

@ -1,7 +1,7 @@
{% extends 'export-base.template.html' %}
{% block details %}
<code-example language="ts" hideCopy="true">
<code-example language="ts" hideCopy="true" class="no-box api-heading">
const {$ doc.name $}: {$ doc.symbolTypeName or 'any' $};
</code-example>
{% include "includes/description.html" %}