Merge pull request #391 from documentationjs/collect-shortcut

Write collect() shortcut for parse

Author: tmcw

lib/parse.js

@@ -10,12 +10,7 @@ var flatteners = {
   'alias': flattenName,
   'arg': synonym('param'),
   'argument': synonym('param'),
-  'augments': function (result, tag) {
-    if (!result.augments) {
-      result.augments = [];
-    }
-    result.augments.push(tag);
-  },
+  'augments': collect('augments'),
   'author': flattenDescription,
   'borrows': todo,
   'callback': flattenDescription,
@@ -103,22 +98,12 @@ var flatteners = {
   'namespace': flattenTypedName,
   'override': flattenBoolean,
   'overview': synonym('file'),
-  'param': function (result, tag) {
-    if (!result.params) {
-      result.params = [];
-    }
-    result.params.push(tag);
-  },
+  'param': collect('params'),
   'private': function (result) {
     result.access = 'private';
   },
   'prop': synonym('property'),
-  'property': function (result, tag) {
-    if (!result.properties) {
-      result.properties = [];
-    }
-    result.properties.push(tag);
-  },
+  'property': collect('properties'),
   'protected': function (result) {
     result.access = 'protected';
   },
@@ -128,36 +113,16 @@ var flatteners = {
   'readonly': flattenBoolean,
   'requires': todo,
   'return': synonym('returns'),
-  'returns': function (result, tag) {
-    if (!result.returns) {
-      result.returns = [];
-    }
-    result.returns.push(tag);
-  },
-  'see': function (result, tag) {
-    if (!result.sees) {
-      result.sees = [];
-    }
-    result.sees.push(tag.description);
-  },
+  'returns': collect('returns'),
+  'see': collect('sees', true),
   'since': flattenDescription,
   'static': function (result) {
     result.scope = 'static';
   },
   'summary': flattenDescription,
   'this': todo,
-  'throws': function (result, tag) {
-    if (!result.throws) {
-      result.throws = [];
-    }
-    result.throws.push(tag);
-  },
-  'todo': function (result, tag) {
-    if (!result.todos) {
-      result.todos = [];
-    }
-    result.todos.push(tag.description);
-  },
+  'throws': collect('throws'),
+  'todo': collect('todos', true),
   'tutorial': todo,
   'type': todo,
   'typedef': flattenTypedName,
@@ -171,6 +136,19 @@ var flatteners = {
 
 function todo() {}
 
+function collect(key, description) {
+  return function (result, tag) {
+    if (!result[key]) {
+      result[key] = [];
+    }
+    if (description) {
+      result[key].push(tag.description);
+    } else {
+      result[key].push(tag);
+    }
+  };
+}
+
 function synonym(key) {
   return function (result, tag) {
     return flatteners[key](result, tag, key);