Skip to content

Commit 25a4304

Browse files
petebacondarwinalexeagle
authored andcommitted
build(aio): group API members by type in overview (angular#22438)
Now the overview groups the members in the following order: * static properties * static methods * constructor * instance properties * instance members Closes angular#22132 PR Close angular#22438
1 parent c593d69 commit 25a4304

File tree

3 files changed

+16
-12
lines changed

3 files changed

+16
-12
lines changed

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

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,7 @@ <h2>Overview</h2>
99
</div>
1010
{% endif %}
1111
<code-example language="ts" hideCopy="true">
12-
{$ doc.docType $} {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} {
13-
{%- if doc.constructorDoc %}{% if not doc.constructorDoc.internal %}
14-
<a class="code-anchor" href="#{$ doc.constructorDoc.anchor | urlencode $}">{$ memberHelper.renderMemberSyntax(doc.constructorDoc, 1) $}</a>{% endif %}{% endif -%}
15-
{%- if doc.statics.length %}{% for member in doc.statics %}{% if not member.internal %}
16-
<a class="code-anchor" href="#{$ member.anchor | urlencode $}">{$ memberHelper.renderMemberSyntax(member, 1) $}</a>{% endif %}{% endfor %}{% endif -%}
17-
{$ memberHelper.renderMembers(doc) $}
12+
{$ doc.docType $} {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} {{$ memberHelper.renderMembers(doc) $}
1813
}
1914
</code-example>
2015
<div class="inline-sidebar">

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ <h2>Interface Overview</h2>
88
{% include "includes/see-also.html" %}
99
</div>
1010
<code-example language="ts" hideCopy="true">
11-
interface {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} { {% if doc.members.length %}{% for member in doc.members %}{% if not member.internal %}
12-
<a class="code-anchor" href="#{$ member.anchor | urlencode $}">{$ memberHelper.renderMemberSyntax(member, 1) $}</a>{% endif %}{% endfor %}{% endif %}
11+
interface {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} {{$ memberHelper.renderMembers(doc) $}
1312
}
1413
</code-example>
1514
</section>

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

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,20 @@
1010
{%- endmacro -%}
1111

1212
{%- macro renderMembers(doc) -%}
13-
{%- if doc.members.length %}{% for member in doc.members %}{% if not member.internal %}
14-
<a class="code-anchor" href="{$ doc.path $}#{$ member.anchor | urlencode $}">{$ renderMemberSyntax(member, 1) $}</a>{% endif %}{% endfor %}{% endif %}
15-
{%- for ancestor in doc.extendsClauses %}{% if ancestor.doc %}
16-
// inherited from <a class="code-anchor" href="{$ ancestor.doc.path $}">{$ ancestor.doc.id $}</a>{$ renderMembers(ancestor.doc) $}{% endif %}{% endfor %}
13+
{%- for member in doc.staticProperties %}{% if not member.internal %}
14+
<a class="code-anchor" href="{$ doc.path $}#{$ member.anchor | urlencode $}">{$ renderMemberSyntax(member, 1) $}</a>{% endif %}{% endfor -%}
15+
{% for member in doc.staticMethods %}{% if not member.internal %}
16+
<a class="code-anchor" href="{$ doc.path $}#{$ member.anchor | urlencode $}">{$ renderMemberSyntax(member, 1) $}</a>{% endif %}{% endfor -%}
17+
{% if doc.constructorDoc and not doc.constructorDoc.internal %}
18+
<a class="code-anchor" href="{$ doc.path $}#{$ doc.constructorDoc.anchor | urlencode $}">{$ renderMemberSyntax(doc.constructorDoc, 1) $}</a>{% endif -%}
19+
{% for member in doc.properties %}{% if not member.internal %}
20+
<a class="code-anchor" href="{$ doc.path $}#{$ member.anchor | urlencode $}">{$ renderMemberSyntax(member, 1) $}</a>{% endif %}{% endfor -%}
21+
{% for member in doc.methods %}{% if not member.internal %}
22+
<a class="code-anchor" href="{$ doc.path $}#{$ member.anchor | urlencode $}">{$ renderMemberSyntax(member, 1) $}</a>{% endif %}{% endfor -%}
23+
24+
{%- for ancestor in doc.extendsClauses %}{% if ancestor.doc %}
25+
26+
// inherited from <a class="code-anchor" href="{$ ancestor.doc.path $}">{$ ancestor.doc.id $}</a>{$ renderMembers(ancestor.doc) $}{% endif %}{% endfor -%}
1727
{%- endmacro -%}
1828

1929
{%- macro renderMemberSyntax(member, truncateLines) -%}

0 commit comments

Comments
 (0)