cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

build(aio): render param descriptions for function exports (#22534)

Browse Source 
Closes #22501

PR Close #22534
This commit is contained in:
Pete Bacon Darwin 2018-03-01 20:19:18 +00:00 committed by Alex Eagle
parent 12be311618
commit 1d2bdcb4d0
1 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
aio/tools/transforms/templates/api/function.template.html
View File

@ -1,24 +1,33 @@
{% import "lib/memberHelpers.html" as memberHelpers -%}
{% import "lib/paramList.html" as params -%} {% import "lib/paramList.html" as params -%}
{% extends 'export-base.template.html' -%} {% extends 'export-base.template.html' -%}
{% block overview %} {% block overview %}
<code-example language="ts" hideCopy="true" class="no-box api-heading"> {% if doc.overloads.length > 0 and doc.overloads < 3 -%}
function {$ doc.name $}{$ doc.typeParameters | escape $}{$ params.paramList(doc.parameters) $} {% for overload in doc.overloads -%}
{%- if doc.type %}: {$ doc.type | escape $}{% endif %}; {$ memberHelpers.renderOverloadInfo(overload, 'function-overload', doc) $}
</code-example> {% if not loop.last %}<hr class="hr-margin fullwidth">{% endif %}
{% endfor -%}
{% else %}
{$ memberHelpers.renderOverloadInfo(doc, 'function-overload', doc) $}
{% endif %}
{% endblock %} {% endblock %}
{% block details %} {% block details %}
{% include "includes/description.html" %} {% include "includes/description.html" %}
{% if doc.overloads.length %} {% if doc.overloads.length >= 3 %}
<h2>Overloads</h2>{% for overload in doc.overloads %} <section class="overloads">
<code-example language="ts" hideCopy="true" class="no-box api-heading"> <h2>Overloads</h2>
function {$ overload.name $}{$ doc.typeParameters | escape $}{$ params.paramList(overload.parameters) $} <table>
{%- if overload.type %}: {$ overload.type | escape $}{% endif %}; {% for overload in doc.overloads %}
</code-example> <tr>
<section class="description"> <td>
{$ overload.description | trimBlankLines | marked $} {$ memberHelpers.renderOverloadInfo(overload, 'function-overload', doc) $}
</section> </td>
</tr>
{% endfor %} {% endfor %}
</table>
</section>
{% endif %} {% endif %}
{% endblock %} {% endblock %}