Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

build: expose static methods and properties in docs #22786

Merged
merged 1 commit into from
May 25, 2021
Merged

build: expose static methods and properties in docs #22786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions tools/dgeni/processors/categorizer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,14 @@ export class Categorizer implements Processor {
classDoc.directiveMetadata = getDirectiveMetadata(classDoc);
classDoc.inheritedDocs = getInheritedDocsOfClass(classDoc, this._exportSymbolsToDocsMap);

classDoc.methods.push(...classDoc.statics
.filter(isMethod)
.filter(filterDuplicateMembers) as CategorizedMethodMemberDoc[]);

classDoc.properties.push(...classDoc.statics
.filter(isProperty)
.filter(filterDuplicateMembers) as CategorizedPropertyMemberDoc[]);

// In case the extended document is not public, we don't want to print it in the
// rendered class API doc. This causes confusion and also is not helpful as the
// extended document is not part of the docs and cannot be viewed.
Expand Down
7 changes: 6 additions & 1 deletion tools/dgeni/templates/method.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,13 @@
Deprecated
</div>
{%- endif -%}
{%- if method.isStatic -%}
<div class="docs-api-modifier-method-marker">
static
</div>
{%- endif -%}
{%- if method.isAsync -%}
<div class="docs-api-async-method-marker">
<div class="docs-api-modifier-method-marker">
async
</div>
{%- endif -%}
Expand Down
2 changes: 1 addition & 1 deletion tools/dgeni/templates/property.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
{%- endif -%}

<p class="docs-api-property-name">
<code>{$ property.name $}: {$ property.type $}</code>
<code>{%- if property.isStatic -%}static {%- endif -%}{$ property.name $}: {$ property.type $}</code>
</p>
</td>
<td class="docs-api-property-description">{$ property.description | marked | safe $}</td>
Expand Down