Skip to content

Commit 424207c

Browse files
committed
Address feedback
1 parent f0134c9 commit 424207c

File tree

2 files changed

+11
-15
lines changed

2 files changed

+11
-15
lines changed

tools/dgeni/processors/categorizer.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface CategorizedClassDoc extends ClassExportDoc {
3232
isDeprecated: boolean;
3333
directiveExportAs?: string | null;
3434
directiveSelectors?: string[];
35-
extendedDocs: ClassLikeExportDoc[];
35+
extendedDoc: ClassLikeExportDoc | null;
3636
}
3737

3838
export interface CategorizedPropertyMemberDoc extends PropertyMemberDoc {
@@ -90,11 +90,10 @@ export class Categorizer implements Processor {
9090
classDoc.methods.sort(sortCategorizedMembers);
9191
classDoc.properties.sort(sortCategorizedMembers);
9292

93-
// Filter the extends clauses for clauses with an associated Dgeni document. Clauses without
94-
// a document are unknown and should not be mentioned in the documentation for this class.
95-
classDoc.extendedDocs = classDoc.extendsClauses
96-
.filter(clause => clause.doc)
97-
.map(clause => clause.doc!);
93+
// Classes can only extend a single class. This means that there can't be multiple extend
94+
// clauses for the Dgeni document. To make the template syntax simpler and more readable,
95+
// store the extended class in a variable.
96+
classDoc.extendedDoc = classDoc.extendsClauses[0] ? classDoc.extendsClauses[0].doc! : null;
9897

9998
// Categorize the current visited classDoc into its Angular type.
10099
if (isDirective(classDoc)) {

tools/dgeni/templates/class.template.html

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11
<h4 class="docs-api-h4 docs-api-class-name">
22
<code>{$ class.name $}</code>
3+
{% if class.extendedDoc %}
4+
<span class="docs-api-class-extends-clauses">
5+
<span class="docs-api-class-extends-label">extends</span>
6+
<span class="docs-api-class-extends-type">{$ class.extendedDoc.name $}</span>
7+
</span>
8+
{% endif %}
39
</h4>
410

511
{%- if class.description -%}
612
<p class="docs-api-class-description">{$ class.description | safe $}</p>
713
{%- endif -%}
814

9-
{% if class.extendedDocs.length %}
10-
<p class="docs-api-class-extends-clauses">
11-
<span class="docs-api-class-extends-label">Extends:</span>
12-
{% for extendedDoc in class.extendedDocs %}
13-
<span class="docs-api-class-extends-type">{$ extendedDoc.name $}</span>
14-
{% endfor %}
15-
</p>
16-
{% endif %}
17-
1815
{%- if class.directiveSelectors -%}
1916
<p class="docs-api-directive-selectors">
2017
<span class="docs-api-class-selector-label">Selector:</span>

0 commit comments

Comments
 (0)