Fix nullable type support. Fixes #245

Author: tmcw

lib/html_helpers.js

@@ -92,6 +92,7 @@ function formatType(type, paths) {
   case 'RestType':
     return '...' + formatType(type.expression, paths);
   case 'OptionalType':
+  case 'NullableType':
     return '<code>[' + formatType(type.expression, paths) + ']</code>';
   case 'TypeApplication':
     return formatType(type.expression, paths) + '<' +

lib/markdown_format_type.js

@@ -12,6 +12,7 @@ function formatType(type) {
   case 'AllLiteral':
     return 'Any';
   case 'OptionalType':
+  case 'NullableType':
     return '[' + formatType(type.expression) + ']';
   case 'RestType':
     return '...' + formatType(type.expression);

test/fixture/html/nested.input.js

@@ -23,8 +23,9 @@ Klass.prototype.getFoo = function () {
  * @param {Object} options
  * @param {string} options.foo
  * @param {number} options.bar
+ * @param {?number} otherOptions
  */
-Klass.prototype.withOptions = function (options) {
+Klass.prototype.withOptions = function (options, otherOptions) {
 };
 
 /**

test/fixture/html/nested.output.files

@@ -1651,7 +1651,7 @@ the referenced class type</p>
         <div class='collapsible' id='Klass.withOptions'>
           <a href='#Klass.withOptions'>
             <code>
-              #withOptions<span class='gray'>(options)</span>
+              #withOptions<span class='gray'>(options, otherOptions)</span>
             </code>
             <span class='force-inline'>
               <p>A function with an options parameter</p>
@@ -1661,7 +1661,7 @@ the referenced class type</p>
           <div class='collapser border px2'>
             <section class='py2 clearfix'>
               <h2 id='Klass.withOptions' class='mt0'>
-                withOptions<span class='gray'>(options)</span>
+                withOptions<span class='gray'>(options, otherOptions)</span>
               </h2>
               <p>A function with an options parameter</p>
 
@@ -1679,6 +1679,12 @@ the referenced class type</p>
                           <li><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code> options.bar
                             </li>
                       </ul>
+                    <li><code>[<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code>]</code> <strong>otherOptions</strong>
+                      :
+                      <span class='force-inline'>
+                        
+                      </span>
+                    </li>
                 </ul>
             </section>
           </div>

test/fixture/optional.input.js

@@ -3,6 +3,7 @@
  * @class Address6
  * @param {string} address - An IPv6 address string
  * @param {number} [groups=8] - How many octets to parse
+ * @param {?number} third - A third argument
  * @example
  * var address = new Address6('2001::/32');
  */

test/fixture/optional.output.custom.md

@@ -6,6 +6,7 @@ Represents an IPv6 address
 
 -   `address` **string** An IPv6 address string
 -   `groups` **[number]** How many octets to parse (optional, default `8`)
+-   `third` **[number]** A third argument
 
 **Examples**
 

test/fixture/optional.output.json

@@ -33,10 +33,24 @@
         "name": "groups",
         "default": "8"
       },
+      {
+        "title": "param",
+        "description": "A third argument",
+        "lineNumber": 5,
+        "type": {
+          "type": "NullableType",
+          "expression": {
+            "type": "NameExpression",
+            "name": "number"
+          },
+          "prefix": true
+        },
+        "name": "third"
+      },
       {
         "title": "example",
         "description": "var address = new Address6('2001::/32');",
-        "lineNumber": 5
+        "lineNumber": 6
       }
     ],
     "loc": {
@@ -45,7 +59,7 @@
         "column": 0
       },
       "end": {
-        "line": 8,
+        "line": 9,
         "column": 3
       }
     },
@@ -56,7 +70,7 @@
           "column": 0
         },
         "end": {
-          "line": 9,
+          "line": 10,
           "column": 0
         }
       }
@@ -89,6 +103,20 @@
         },
         "name": "groups",
         "default": "8"
+      },
+      {
+        "title": "param",
+        "description": "A third argument",
+        "lineNumber": 5,
+        "type": {
+          "type": "NullableType",
+          "expression": {
+            "type": "NameExpression",
+            "name": "number"
+          },
+          "prefix": true
+        },
+        "name": "third"
       }
     ],
     "examples": [

test/fixture/optional.output.md

@@ -6,6 +6,7 @@ Represents an IPv6 address
 
 -   `address` **string** An IPv6 address string
 -   `groups` **[number]** How many octets to parse (optional, default `8`)
+-   `third` **[number]** A third argument
 
 **Examples**
 

test/fixture/optional.output.md.json

@@ -195,6 +195,68 @@
               ]
             }
           ]
+        },
+        {
+          "type": "listItem",
+          "children": [
+            {
+              "type": "paragraph",
+              "children": [
+                {
+                  "type": "inlineCode",
+                  "value": "third"
+                },
+                {
+                  "type": "text",
+                  "value": " "
+                },
+                {
+                  "type": "strong",
+                  "children": [
+                    {
+                      "type": "text",
+                      "value": "[number]"
+                    }
+                  ]
+                },
+                {
+                  "type": "text",
+                  "value": " "
+                },
+                {
+                  "type": "paragraph",
+                  "children": [
+                    {
+                      "type": "text",
+                      "value": "A third argument",
+                      "position": {
+                        "start": {
+                          "line": 1,
+                          "column": 1
+                        },
+                        "end": {
+                          "line": 1,
+                          "column": 17
+                        },
+                        "indent": []
+                      }
+                    }
+                  ],
+                  "position": {
+                    "start": {
+                      "line": 1,
+                      "column": 1
+                    },
+                    "end": {
+                      "line": 1,
+                      "column": 17
+                    },
+                    "indent": []
+                  }
+                }
+              ]
+            }
+          ]
         }
       ]
     },