Add very rudimentary support for @typedef

Author: Anand Thakker

package.json

@@ -24,7 +24,7 @@
     "JSONStream": "^0.10.0",
     "ast-types": "^0.7.2",
     "concat-stream": "^1.4.7",
-    "doctrine": "^0.6.4",
+    "doctrine": "constellation/doctrine#da4635ec2e9cbb4b593b2bd49584defc5843abd8",
     "espree": "^1.12.2",
     "extend": "^2.0.0",
     "github-url-from-git": "^1.4.0",

share/html/section.hbs

@@ -51,6 +51,25 @@
     {{/returns}}
   {{/if}}
 
+  {{#if properties}}
+    <p>
+      <table class='table-light overflow-hidden bg-cloudy-light'>
+        <thead>
+          <th class='col-3'>property</th>
+          <th class='col-3'>type</th>
+          <th class='col-6'>description</th>
+        </thead>
+        {{#properties}}
+          <tr>
+            <td>{{name}}</td>
+            <td>{{{format_type type}}}</td>
+            <td>{{{md description}}}</td>
+          </tr>
+        {{/properties}}
+      </table>
+    </p>
+  {{/if}}
+
   {{#if examples}}
     <h4>Examples</h4>
 {{#each examples ~}}<pre>{{{.}}}</pre>{{/each}}

test/fixture/html/nested.output.files

@@ -1505,6 +1505,7 @@ section:target {
 
 
 
+
       <div class='section-indent'>
 <section id='klass/magic-number'class='mt2 mb2 py1 px3 keyline-top'>
   <h3 class='regular'>
@@ -1522,6 +1523,7 @@ section:target {
 
 
 
+
 </section>
       </div>
       <div class='section-indent'>
@@ -1564,6 +1566,7 @@ This is a <a href="doesnot"><code>link to something that does not exist</code></
 
 
 
+
 </section>
       </div>
 
@@ -1588,6 +1591,7 @@ This is a <a href="doesnot"><code>link to something that does not exist</code></
 
       </span>
 
+
     <h4>Examples</h4>
 <pre>foo.getFoo();</pre>
 
@@ -1622,6 +1626,7 @@ like a <a href="klass"><code>klass</code></a></p>
 
 
 
+
 </section>
 
         </div>

test/fixture/typedef.input.js

@@ -0,0 +1,8 @@
+/**
+ * A type definition.
+ * @name MyType
+ * @typedef {Object} MyType
+ * @property {number} prop1 - one property
+ * @property {string} prop2 - another property
+ */
+

test/fixture/typedef.output.custom.md

@@ -0,0 +1,6 @@
+## `MyType`
+
+A type definition.
+
+
+

test/fixture/typedef.output.json

@@ -0,0 +1,78 @@
+[
+  {
+    "description": "A type definition.",
+    "tags": [
+      {
+        "title": "name",
+        "description": null,
+        "name": "MyType"
+      },
+      {
+        "title": "typedef",
+        "description": null,
+        "type": {
+          "type": "NameExpression",
+          "name": "Object"
+        },
+        "name": "MyType"
+      },
+      {
+        "title": "property",
+        "description": "one property",
+        "type": {
+          "type": "NameExpression",
+          "name": "number"
+        },
+        "name": "prop1"
+      },
+      {
+        "title": "property",
+        "description": "another property",
+        "type": {
+          "type": "NameExpression",
+          "name": "string"
+        },
+        "name": "prop2"
+      },
+      {
+        "title": "kind",
+        "kind": "typedef"
+      }
+    ],
+    "context": {
+      "loc": {
+        "start": {
+          "line": 9,
+          "column": 0
+        },
+        "end": {
+          "line": 9,
+          "column": 0
+        }
+      },
+      "file": "fixture/typedef.input.js"
+    },
+    "name": "MyType",
+    "properties": [
+      {
+        "title": "property",
+        "description": "one property",
+        "type": {
+          "type": "NameExpression",
+          "name": "number"
+        },
+        "name": "prop1"
+      },
+      {
+        "title": "property",
+        "description": "another property",
+        "type": {
+          "type": "NameExpression",
+          "name": "string"
+        },
+        "name": "prop2"
+      }
+    ],
+    "kind": "typedef"
+  }
+]

test/fixture/typedef.output.md

@@ -0,0 +1,12 @@
+## `MyType`
+
+A type definition.
+
+
+| name | type | description |
+| ---- | ---- | ----------- |
+| `prop1` | `number` | one property |
+| `prop2` | `string` | another property |
+
+
+