skills/angular__angular
1
0
Fork 0
mirror of https://github.com/angular/angular.git synced 2026-09-14 13:54:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

build(docs): markdown for api descriptions (#4689)

Browse Source 
* Parses Class, Property and Method descriptions using a markdown filter from Dgeni.

Closes #3924
This commit is contained in:
Paul Gschwendtner
2017-05-22 20:28:59 +02:00
committed by tinayuangao
parent 085b45995a
commit 7f4516a91e
3 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/dgeni/templates/class.template.html
+1 -1
View File
@@ -1,7 +1,7 @@
<h4 class="docs-api-h4 docs-api-class-name">
<code>{$ class.name $}</code>
</h4>
<p class="docs-api-class-description">{$ class.description $}</p>
<p class="docs-api-class-description">{$ class.description | marked | safe $}</p>
{%- if class.directiveSelectors -%}
<div class="docs-api-directive-selectors">
tools/dgeni/templates/method.template.html
+9 -3
View File
@@ -10,7 +10,9 @@
</tr>
</thead>
<tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">{$ method.description $}</td>
<td colspan="2" class="docs-api-method-description-cell">
{$ method.description | marked | safe $}
</td>
</tr>
{%- if method.params.length -%}
@@ -31,7 +33,9 @@
<code class="docs-api-method-parameter-type">{$ parameter.type $}</code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">{$ parameter.description $}</p>
<p class="docs-api-method-parameter-description">
{$ parameter.description | marked | safe $}
</p>
</td>
</tr>
{% endfor %}
@@ -48,7 +52,9 @@
<code class="docs-api-method-returns-type">{$ method.returnType $}</code>
</td>
<td class="docs-api-method-returns-description-cell">
<p class="docs-api-method-returns-description">{$ method.returns.description $}</p>
<p class="docs-api-method-returns-description">
{$ method.returns.description | marked | safe $}
</p>
</td>
</tr>
{%- endif -%}
tools/dgeni/templates/property.template.html
+1 -1
View File
@@ -27,5 +27,5 @@
</p>
<code class="docs-api-property-type">{$ property.type $}</code>
</td>
<td class="docs-api-property-description">{$ property.description $}</td>
<td class="docs-api-property-description">{$ property.description | marked | safe $}</td>
</tr>