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

build(aio): add github links to API doc members (#24000)

Browse Source 
This change adds Github edit and view links to methods
and decorator options.

It is possible to add these to properties also but the
UI is rather tight as these are displayed in a table.

PR Close #24000
This commit is contained in:
Pete Bacon Darwin
2018-05-23 22:56:05 +01:00
committed by Miško Hevery
parent 8daadf360c
commit 39af314e29
8 changed files with 51 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
aio/tools/transforms/templates/api/lib/memberHelpers.html
View File

@ -1,3 +1,4 @@
{% import "lib/githubLinks.html" as github -%}
{% import "lib/paramList.html" as params -%}
{%- macro renderHeritage(exportDoc) -%}
@ -69,15 +70,18 @@
{%- endif %}
{%- endmacro -%}
{%- macro renderMethodDetail(method, cssClass) -%}
{%- macro renderMethodDetail(versionInfo, method, cssClass) -%}
<a id="{$ method.anchor $}"></a>
<table class="is-full-width method-table {$ cssClass $}">
{% if method.name !== 'constructor' %}<thead><tr><th><h3>
{% if method.isCallMember %}<i>call signature</i>
{% elseif method.isNewMember %}<i>construct signature</i>
{% else %}{$ method.name $}()
{% endif %}
</h3></th></tr></thead>{% endif %}
{% if method.name !== 'constructor' %}<thead><tr><th>
<h3>
{% if method.isCallMember %}<i>call signature</i>
{% elseif method.isNewMember %}<i>construct signature</i>
{% else %}{$ method.name $}()
{% endif %}
</h3>
{$ github.githubLinks(method, versionInfo) $}
</th></tr></thead>{% endif %}
<tbody>
{% if method.shortDescription %}<tr>
<td class="short-description">
@ -133,13 +137,13 @@
</table>
{% endmacro -%}
{%- macro renderMethodDetails(methods, containerClass, itemClass, headingText) -%}
{%- macro renderMethodDetails(versionInfo, methods, containerClass, itemClass, headingText) -%}
{% set nonInternalMethods = methods | filterByPropertyValue('internal', undefined) %}
{% if nonInternalMethods.length %}
<section class="{$ containerClass $}">
<h2>{$ headingText $}</h2>
{% for member in nonInternalMethods %}
{$ renderMethodDetail(member, itemClass) $}
{$ renderMethodDetail(versionInfo, member, itemClass) $}
{% endfor %}
</section>
{% endif %}