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

build(aio): update doc-gen templates

Browse Source
This commit is contained in:
Peter Bacon Darwin
2017-06-29 22:23:27 +01:00
parent aa39449ce4
commit 50e79ace12
18 changed files with 98 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

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

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

@ -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 %}

11
aio/tools/transforms/templates/api/includes/inputs.html
View File

@ -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 %}

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

@ -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 %}
<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="#{$ 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 %}
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="#{$ member.anchor $}">{$ memberHelper.renderMember(member) $}</a>{% endif %}{% endfor %}{% endif %}
}
</code-example>
</section>

29
aio/tools/transforms/templates/api/includes/members.html
View File

@ -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 %}

2
aio/tools/transforms/templates/api/includes/metadata.html
View File

@ -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 %}

11
aio/tools/transforms/templates/api/includes/outputs.html
View File

@ -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 %}

4
aio/tools/transforms/templates/api/includes/selectors.html
View File

@ -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>

19
aio/tools/transforms/templates/api/includes/statics.html
View File

@ -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 %}