From 25a43041d27dba11c22875226d88240177acfc01 Mon Sep 17 00:00:00 2001 From: Pete Bacon Darwin Date: Sun, 25 Feb 2018 10:40:21 +0000 Subject: [PATCH] build(aio): group API members by type in overview (#22438) Now the overview groups the members in the following order: * static properties * static methods * constructor * instance properties * instance members Closes #22132 PR Close #22438 --- .../templates/api/includes/class-overview.html | 7 +------ .../api/includes/interface-overview.html | 3 +-- .../templates/api/lib/memberHelpers.html | 18 ++++++++++++++---- 3 files changed, 16 insertions(+), 12 deletions(-) diff --git a/aio/tools/transforms/templates/api/includes/class-overview.html b/aio/tools/transforms/templates/api/includes/class-overview.html index dd5ad7ccdc..9d9fb6d368 100644 --- a/aio/tools/transforms/templates/api/includes/class-overview.html +++ b/aio/tools/transforms/templates/api/includes/class-overview.html @@ -9,12 +9,7 @@ {% endif %} -{$ doc.docType $} {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} { -{%- if doc.constructorDoc %}{% if not doc.constructorDoc.internal %} - {$ memberHelper.renderMemberSyntax(doc.constructorDoc, 1) $}{% endif %}{% endif -%} -{%- if doc.statics.length %}{% for member in doc.statics %}{% if not member.internal %} - {$ memberHelper.renderMemberSyntax(member, 1) $}{% endif %}{% endfor %}{% endif -%} -{$ memberHelper.renderMembers(doc) $} +{$ doc.docType $} {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} {{$ memberHelper.renderMembers(doc) $} }
diff --git a/aio/tools/transforms/templates/api/includes/interface-overview.html b/aio/tools/transforms/templates/api/includes/interface-overview.html index 0c0ead536f..f4de07c3f2 100644 --- a/aio/tools/transforms/templates/api/includes/interface-overview.html +++ b/aio/tools/transforms/templates/api/includes/interface-overview.html @@ -8,8 +8,7 @@ {% include "includes/see-also.html" %}
-interface {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} { {% if doc.members.length %}{% for member in doc.members %}{% if not member.internal %} - {$ memberHelper.renderMemberSyntax(member, 1) $}{% endif %}{% endfor %}{% endif %} +interface {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} {{$ memberHelper.renderMembers(doc) $} } \ No newline at end of file diff --git a/aio/tools/transforms/templates/api/lib/memberHelpers.html b/aio/tools/transforms/templates/api/lib/memberHelpers.html index 0235484eba..8ff0c4d5cf 100644 --- a/aio/tools/transforms/templates/api/lib/memberHelpers.html +++ b/aio/tools/transforms/templates/api/lib/memberHelpers.html @@ -10,10 +10,20 @@ {%- endmacro -%} {%- macro renderMembers(doc) -%} -{%- if doc.members.length %}{% for member in doc.members %}{% if not member.internal %} - {$ renderMemberSyntax(member, 1) $}{% endif %}{% endfor %}{% endif %} -{%- for ancestor in doc.extendsClauses %}{% if ancestor.doc %} - // inherited from {$ ancestor.doc.id $}{$ renderMembers(ancestor.doc) $}{% endif %}{% endfor %} + {%- for member in doc.staticProperties %}{% if not member.internal %} + {$ renderMemberSyntax(member, 1) $}{% endif %}{% endfor -%} + {% for member in doc.staticMethods %}{% if not member.internal %} + {$ renderMemberSyntax(member, 1) $}{% endif %}{% endfor -%} + {% if doc.constructorDoc and not doc.constructorDoc.internal %} + {$ renderMemberSyntax(doc.constructorDoc, 1) $}{% endif -%} + {% for member in doc.properties %}{% if not member.internal %} + {$ renderMemberSyntax(member, 1) $}{% endif %}{% endfor -%} + {% for member in doc.methods %}{% if not member.internal %} + {$ renderMemberSyntax(member, 1) $}{% endif %}{% endfor -%} + + {%- for ancestor in doc.extendsClauses %}{% if ancestor.doc %} + + // inherited from {$ ancestor.doc.id $}{$ renderMembers(ancestor.doc) $}{% endif %}{% endfor -%} {%- endmacro -%} {%- macro renderMemberSyntax(member, truncateLines) -%}