Skip to content

build: some public API docs missing descriptions #22482

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

Merged
merged 1 commit into from
Apr 19, 2021
Merged

build: some public API docs missing descriptions #22482

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
1 change: 0 additions & 1 deletion tools/dgeni/common/dgeni-definitions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ export interface CategorizedClassDoc extends ClassExportDoc, CategorizedClassLik

/** Extended Dgeni property-member document that includes extracted Angular metadata. */
export interface CategorizedPropertyMemberDoc extends PropertyMemberDoc, DeprecationInfo {
description: string;
isDirectiveInput: boolean;
isDirectiveOutput: boolean;
directiveInputAlias: string;
Expand Down
6 changes: 3 additions & 3 deletions tools/dgeni/templates/method.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@
</th>
</tr>
</thead>
{%- if method.description -%}
{%- if method.content -%}
<tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
{$ method.description | marked | safe $}
{$ method.content | marked | safe $}
</td>
</tr>
{%- endif -%}
Expand All @@ -45,7 +45,7 @@
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
{$ parameter.description | marked | safe $}
{$ parameter.content | marked | safe $}
</p>
</td>
</tr>
Expand Down
4 changes: 2 additions & 2 deletions tools/dgeni/templates/property.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@
<div class="docs-api-deprecated-marker" {$ macros.deprecationTitle(property) $}>
Deprecated
</div>
{%- endif -%}
{%- endif -%}

<p class="docs-api-property-name">
<code>{$ property.name $}: {$ property.type $}</code>
</p>
</td>
<td class="docs-api-property-description">{$ property.description | marked | safe $}</td>
<td class="docs-api-property-description">{$ property.content | marked | safe $}</td>
</tr>