Output typedef content in Markdown and HTML. Fixes #359 (#619)

Author: tmcw

default_theme/section._

@@ -19,6 +19,13 @@
 
   <div class='pre p1 fill-light mt0'><%= signature(section) %></div>
 
+  <% if (section.type) { %>
+    <p>
+      Type:
+      <%= formatType(section.type) %>
+    </p>
+  <% } %>
+
   <% if (section.augments) { %>
     <p>
       Extends

lib/output/markdown_ast.js

@@ -43,6 +43,14 @@ function commentsToAST(comments, options, callback) {
    */
   function generate(depth, comment) {
 
+    function typeSection(comment) {
+      return comment.type && u('paragraph', [
+        u('text', 'Type: ')
+      ].concat(
+        formatType(comment.type)
+      ));
+    }
+
     function paramList(params) {
       return u('list', { ordered: false }, params.map(function (param) {
         return u('listItem', [
@@ -176,6 +184,7 @@ function commentsToAST(comments, options, callback) {
     .concat(githubLink(comment))
     .concat(augmentsLink(comment))
     .concat(comment.description ? comment.description.children : [])
+    .concat(typeSection(comment))
     .concat(paramSection(comment))
     .concat(propertySection(comment))
     .concat(examplesSection(comment))

test/fixture/document-exported.output.md

@@ -34,6 +34,8 @@
 
 # T5
 
+Type: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
+
 # y2Default
 
 # y4
@@ -68,10 +70,16 @@ Returns **void**
 
 # T
 
+Type: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
+
 # T2
 
+Type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
+
 # T4
 
+Type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
+
 # f4
 
 **Parameters**

test/fixture/document-exported.output.md.json

@@ -226,6 +226,26 @@
         }
       ]
     },
+    {
+      "type": "paragraph",
+      "children": [
+        {
+          "type": "text",
+          "value": "Type: "
+        },
+        {
+          "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean",
+          "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean",
+          "type": "link",
+          "children": [
+            {
+              "type": "text",
+              "value": "boolean"
+            }
+          ]
+        }
+      ]
+    },
     {
       "depth": 1,
       "type": "heading",
@@ -483,6 +503,26 @@
         }
       ]
     },
+    {
+      "type": "paragraph",
+      "children": [
+        {
+          "type": "text",
+          "value": "Type: "
+        },
+        {
+          "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
+          "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
+          "type": "link",
+          "children": [
+            {
+              "type": "text",
+              "value": "number"
+            }
+          ]
+        }
+      ]
+    },
     {
       "depth": 1,
       "type": "heading",
@@ -493,6 +533,26 @@
         }
       ]
     },
+    {
+      "type": "paragraph",
+      "children": [
+        {
+          "type": "text",
+          "value": "Type: "
+        },
+        {
+          "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
+          "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
+          "type": "link",
+          "children": [
+            {
+              "type": "text",
+              "value": "string"
+            }
+          ]
+        }
+      ]
+    },
     {
       "depth": 1,
       "type": "heading",
@@ -503,6 +563,26 @@
         }
       ]
     },
+    {
+      "type": "paragraph",
+      "children": [
+        {
+          "type": "text",
+          "value": "Type: "
+        },
+        {
+          "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
+          "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
+          "type": "link",
+          "children": [
+            {
+              "type": "text",
+              "value": "string"
+            }
+          ]
+        }
+      ]
+    },
     {
       "depth": 1,
       "type": "heading",

test/fixture/html/nested.config-output.html

@@ -258,6 +258,8 @@ <h3 class='fl m0' id='klass'>
   <div class='pre p1 fill-light mt0'>new Klass(foo: any)</div>
 
 
+
+  
     <p>
       Extends
 
@@ -321,6 +323,8 @@ <h3 class='fl m0' id='klass'>
 
 
 
+
+  
 
 
 
@@ -396,6 +400,8 @@ <h3 class='fl m0' id='klass'>
 
 
 
+
+  
 
 
 
@@ -462,6 +468,8 @@ <h3 class='fl m0' id='klass'>
 
 
 
+
+  
 
 
 
@@ -538,6 +546,8 @@ <h3 class='fl m0' id='klass'>
 
 
 
+
+  
 
 
 
@@ -612,6 +622,8 @@ <h3 class='fl m0' id='klass'>
 
 
 
+
+  
 
 
 
@@ -657,6 +669,8 @@ <h3 class='fl m0' id='klass'>
 
 
 
+
+  
 
 
 
@@ -710,6 +724,8 @@ <h3 class='fl m0' id='klass'>
 
 
 
+
+  
 
 
 
@@ -770,6 +786,8 @@ <h3 class='fl m0' id='klass'>
 
 
 
+
+  
 
 
 
@@ -875,6 +893,8 @@ <h3 class='fl m0' id='customerror'>
 
 
 
+
+  
 
 
 
@@ -949,6 +969,8 @@ <h3 class='fl m0' id='bar'>
 
 
 
+
+  
 
 
 
@@ -1003,6 +1025,8 @@ <h3 class='fl m0' id='bar'>
 
 
 
+
+  
 
 
 
@@ -1072,6 +1096,8 @@ <h3 class='fl m0' id='bar'>
 
 
 
+
+  
 
 
 
@@ -1125,6 +1151,8 @@ <h3 class='fl m0' id='foo'>
 
 
 
+  
+
 
 
 
@@ -1167,6 +1195,8 @@ <h3 class='fl m0' id='foo'>
 
 
 
+
+  
 
 
 
@@ -1220,6 +1250,8 @@ <h3 class='fl m0' id='customstreams'>
 
   <div class='pre p1 fill-light mt0'>customStreams</div>
 
+  
+
 
 
 
@@ -1262,6 +1294,8 @@ <h3 class='fl m0' id='customstreams'>
 
 
 
+
+