From 7f4516a91e4038ab0140cf1b8420c89612704ac3 Mon Sep 17 00:00:00 2001
From: Paul Gschwendtner <paulgschwendtner@gmail.com>
Date: Mon, 22 May 2017 20:28:59 +0200
Subject: [PATCH] build(docs): markdown for api descriptions (#4689)

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

Closes #3924
---
 tools/dgeni/templates/class.template.html    |  2 +-
 tools/dgeni/templates/method.template.html   | 12 +++++++++---
 tools/dgeni/templates/property.template.html |  2 +-
 3 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/tools/dgeni/templates/class.template.html b/tools/dgeni/templates/class.template.html
index c9d03bf8348..4ae4a3e7630 100644
--- a/tools/dgeni/templates/class.template.html
+++ b/tools/dgeni/templates/class.template.html
@@ -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">
diff --git a/tools/dgeni/templates/method.template.html b/tools/dgeni/templates/method.template.html
index eeb7373d085..50b43d1223e 100644
--- a/tools/dgeni/templates/method.template.html
+++ b/tools/dgeni/templates/method.template.html
@@ -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 -%}
diff --git a/tools/dgeni/templates/property.template.html b/tools/dgeni/templates/property.template.html
index 2d17ace86d8..fd539e9ea11 100644
--- a/tools/dgeni/templates/property.template.html
+++ b/tools/dgeni/templates/property.template.html
@@ -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>