Restore default values. Fix sort test

Author: tmcw

lib/parse.js

@@ -154,6 +154,10 @@ var flatteners = {
       param.type = tag.type;
     }
 
+    if (tag.default) {
+      param.default = tag.default;
+    }
+
     result.params.push(param);
   },
   'private': function (result) {

lib/sort.js

@@ -11,50 +11,49 @@ function parseMarkdown(string) {
  * Sort two documentation objects, given an optional order object. Returns
  * a numeric sorting value that is compatible with stream-sort.
  *
- * @param {Object} a documentation object
- * @param {Object} b documentation object
+ * @param {Array<Object>} comments all comments
+ * @param {Object} options options from documentation.yml
  * @return {number} sorting value
  * @private
  */
 module.exports = function sortDocs(comments, options) {
-  if (!options.toc) {
+  if (!options || !options.toc) {
     return comments.sort(function (a, b) {
       return a.context.sortKey.localeCompare(b.context.sortKey);
     });
-  } else {
-    var indexes = options.toc.reduce(function (memo, val, i) {
-      if (typeof val === 'object' && val.name) {
-        val.kind = 'note';
-        memo[val.name] = i;
-      } else {
-        memo[val] = i;
-      }
-      return memo;
-    }, {});
-    var fixed = options.toc.filter(function (val) {
-      return typeof val === 'object' && val.name;
-    }).map(function (val) {
-      if (val.description) {
-        val.description = parseMarkdown(val.description);
-      }
-      return val;
-    });
-    var unfixed = [];
-    comments.forEach(function (comment) {
-      if (!comment.memberof && indexes[comment.name] !== undefined) {
-        fixed.push(comment);
-      } else {
-        unfixed.push(comment);
-      }
-    });
-    fixed.sort(function (a, b) {
-      if (indexes[a.name] !== undefined && indexes[b.name] !== undefined) {
-        return indexes[a.name] - indexes[b.name];
-      }
-    });
-    unfixed.sort(function (a, b) {
-      return a.context.sortKey.localeCompare(b.context.sortKey);
-    });
-    return fixed.concat(unfixed);
   }
+  var indexes = options.toc.reduce(function (memo, val, i) {
+    if (typeof val === 'object' && val.name) {
+      val.kind = 'note';
+      memo[val.name] = i;
+    } else {
+      memo[val] = i;
+    }
+    return memo;
+  }, {});
+  var fixed = options.toc.filter(function (val) {
+    return typeof val === 'object' && val.name;
+  }).map(function (val) {
+    if (val.description) {
+      val.description = parseMarkdown(val.description);
+    }
+    return val;
+  });
+  var unfixed = [];
+  comments.forEach(function (comment) {
+    if (!comment.memberof && indexes[comment.name] !== undefined) {
+      fixed.push(comment);
+    } else {
+      unfixed.push(comment);
+    }
+  });
+  fixed.sort(function (a, b) {
+    if (indexes[a.name] !== undefined && indexes[b.name] !== undefined) {
+      return indexes[a.name] - indexes[b.name];
+    }
+  });
+  unfixed.sort(function (a, b) {
+    return a.context.sortKey.localeCompare(b.context.sortKey);
+  });
+  return fixed.concat(unfixed);
 };

test/fixture/html/nested.output.files

@@ -26,10 +26,7 @@
 
                 <li><a
                   href='#Klass'
-                  
-                  class='toggle-sibling'
-                  
-                  >
+                  class=" toggle-sibling">
                   Klass
                   <span class='icon'>▸</span>
                 </a>
@@ -103,8 +100,7 @@
 
                 <li><a
                   href='#bar'
-                  
-                  >
+                  class="">
                   bar
 
                 </a>
@@ -114,8 +110,7 @@
 
                 <li><a
                   href='#bar'
-                  
-                  >
+                  class="">
                   bar
 
                 </a>
@@ -125,8 +120,7 @@
 
                 <li><a
                   href='#bar'
-                  
-                  >
+                  class="">
                   bar
 
                 </a>
@@ -136,10 +130,7 @@
 
                 <li><a
                   href='#Foo'
-                  
-                  class='toggle-sibling'
-                  
-                  >
+                  class=" toggle-sibling">
                   Foo
                   <span class='icon'>▸</span>
                 </a>
@@ -170,7 +161,8 @@
       <div class='fix-margin-3'>
         <div class='px2'>
 
-            <div class='keyline-top-not py2'><section class='py2 clearfix'>
+            
+              <div class='keyline-top-not py2'><section class='py2 clearfix'>
 
   <h3 id='Klass' class='mt0'>
     Klass
@@ -401,7 +393,9 @@ the referenced class type</p>
 
         </li>
 
-        <li><code>size</code> <em>([<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>])</em>: size
+        <li><code>size</code> <em>([<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>]
+          (default <code>0</code>)
+        )</em>: size
 
 
         </li>
@@ -758,8 +752,10 @@ k.isArrayOfBuffers();</pre>
 
 
 </div>
+            
 
-            <div class='keyline-top-not py2'><section class='py2 clearfix'>
+            
+              <div class='keyline-top-not py2'><section class='py2 clearfix'>
 
   <h3 id='bar' class='mt0'>
     bar
@@ -806,8 +802,10 @@ like a <a href="#Klass">klass</a></p>
 
 
 </div>
+            
 
-            <div class='keyline-top-not py2'><section class='py2 clearfix'>
+            
+              <div class='keyline-top-not py2'><section class='py2 clearfix'>
 
   <h3 id='bar' class='mt0'>
     bar
@@ -861,8 +859,10 @@ like a <a href="#Klass">klass</a></p>
 
 
 </div>
+            
 
-            <div class='keyline-top-not py2'><section class='py2 clearfix'>
+            
+              <div class='keyline-top-not py2'><section class='py2 clearfix'>
 
   <h3 id='bar' class='mt0'>
     bar
@@ -909,8 +909,10 @@ like a <a href="#Klass">klass</a>. This needs a <a href="#number">number</a> inp
 
 
 </div>
+            
 
-            <div class='keyline-top-not py2'><section class='py2 clearfix'>
+            
+              <div class='keyline-top-not py2'><section class='py2 clearfix'>
 
   <h3 id='Foo' class='mt0'>
     Foo
@@ -1003,6 +1005,7 @@ like a <a href="#Klass">klass</a>. This needs a <a href="#number">number</a> inp
 
 
 </div>
+            
 
         </div>
       </div>

test/fixture/nest_params.input.js

@@ -2,8 +2,9 @@
  * @param {Object[]} employees - The employees who are responsible for the project.
  * @param {string} employees[].name - The name of an employee.
  * @param {string} employees[].department - The employee's department.
+ * @param {string} [type=minion] - The employee's type.
  */
-function foo(employee) {
+function foo(employee, type) {
 }
 
 /**

test/fixture/nest_params.output.json

@@ -40,6 +40,20 @@
           "name": "string"
         },
         "name": "employees[].department"
+      },
+      {
+        "title": "param",
+        "description": "The employee's type.",
+        "lineNumber": 4,
+        "type": {
+          "type": "OptionalType",
+          "expression": {
+            "type": "NameExpression",
+            "name": "string"
+          }
+        },
+        "name": "type",
+        "default": "minion"
       }
     ],
     "loc": {
@@ -48,22 +62,22 @@
         "column": 0
       },
       "end": {
-        "line": 5,
+        "line": 6,
         "column": 3
       }
     },
     "context": {
       "loc": {
         "start": {
-          "line": 6,
+          "line": 7,
           "column": 0
         },
         "end": {
-          "line": 7,
+          "line": 8,
           "column": 1
         }
       },
-      "code": "/**\n * @param {Object[]} employees - The employees who are responsible for the project.\n * @param {string} employees[].name - The name of an employee.\n * @param {string} employees[].department - The employee's department.\n */\nfunction foo(employee) {\n}\n\n/**\n * @name foo\n * @param {Object} options some options\n * @param {number} options.much how much\n * @param {number} bar something else\n * @property {Object} theTime the current time\n * @property {number} theTime.hours\n * @property {number} theTime.minutes\n * @property {number} theTime.seconds\n * @returns {Object} foo something else\n */\n"
+      "code": "/**\n * @param {Object[]} employees - The employees who are responsible for the project.\n * @param {string} employees[].name - The name of an employee.\n * @param {string} employees[].department - The employee's department.\n * @param {string} [type=minion] - The employee's type.\n */\nfunction foo(employee, type) {\n}\n\n/**\n * @name foo\n * @param {Object} options some options\n * @param {number} options.much how much\n * @param {number} bar something else\n * @property {Object} theTime the current time\n * @property {number} theTime.hours\n * @property {number} theTime.minutes\n * @property {number} theTime.seconds\n * @returns {Object} foo something else\n */\n"
     },
     "errors": [],
     "params": [
@@ -261,7 +275,71 @@
       {
         "title": "param",
         "name": "employee",
-        "lineNumber": 6
+        "lineNumber": 7
+      },
+      {
+        "name": "type",
+        "lineNumber": 4,
+        "description": {
+          "type": "root",
+          "children": [
+            {
+              "type": "paragraph",
+              "children": [
+                {
+                  "type": "text",
+                  "value": "The employee's type.",
+                  "position": {
+                    "start": {
+                      "line": 1,
+                      "column": 1,
+                      "offset": 0
+                    },
+                    "end": {
+                      "line": 1,
+                      "column": 21,
+                      "offset": 20
+                    },
+                    "indent": []
+                  }
+                }
+              ],
+              "position": {
+                "start": {
+                  "line": 1,
+                  "column": 1,
+                  "offset": 0
+                },
+                "end": {
+                  "line": 1,
+                  "column": 21,
+                  "offset": 20
+                },
+                "indent": []
+              }
+            }
+          ],
+          "position": {
+            "start": {
+              "line": 1,
+              "column": 1,
+              "offset": 0
+            },
+            "end": {
+              "line": 1,
+              "column": 21,
+              "offset": 20
+            }
+          }
+        },
+        "type": {
+          "type": "OptionalType",
+          "expression": {
+            "type": "NameExpression",
+            "name": "string"
+          }
+        },
+        "default": "minion"
       }
     ],
     "name": "foo",
@@ -369,22 +447,22 @@
     ],
     "loc": {
       "start": {
-        "line": 9,
+        "line": 10,
         "column": 0
       },
       "end": {
-        "line": 19,
+        "line": 20,
         "column": 3
       }
     },
     "context": {
       "loc": {
         "start": {
-          "line": 6,
+          "line": 7,
           "column": 0
         },
         "end": {
-          "line": 7,
+          "line": 8,
           "column": 1
         }
       }

test/fixture/nest_params.output.md

@@ -6,6 +6,7 @@
     -   `employees[].name` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of an employee.
     -   `employees[].department` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The employee's department.
 -   `employee`  
+-   `type` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The employee's type. (optional, default `minion`)
 
 # foo