[WIP] feat(params): Support inline parameter documentation

lib/extractors/comments.js

@@ -51,7 +51,9 @@ function walkComments(
         );
       }
 
-      (path.node[type] || []).filter(isJSDocComment).forEach(parseComment);
+      if (path.node[type]) {
+        path.node[type].filter(isJSDocComment).forEach(parseComment);
+      }
     }
   });
 

lib/infer/params.js

@@ -8,6 +8,20 @@ const findTarget = require('./finders').findTarget;
 const flowDoctrine = require('../flow_doctrine');
 const util = require('util');
 const debuglog = util.debuglog('documentation');
+const parseJSDoc = require('../parse');
+const isJSDocComment = require('../is_jsdoc_comment');
+
+function getInlineDescription(param) {
+  if (param.trailingComments && isJSDocComment(param.trailingComments[0])) {
+    var parsedInlineComment = parseJSDoc(param.trailingComments[0].value);
+    if (parsedInlineComment && parsedInlineComment.description) {
+      return {
+        description: parsedInlineComment.description
+      };
+    }
+  }
+  return {};
+}
 
 /**
  * Infers param tags by reading function parameter names
@@ -182,9 +196,13 @@ function paramToDoc(
         return paramToDoc(indexedElement, prefix);
       });
     case 'ObjectProperty':
-      return _.assign(paramToDoc(param.value, prefix + '.' + param.key.name), {
-        name: prefix + '.' + param.key.name
-      });
+      return _.assign(
+        paramToDoc(param.value, prefix + '.' + param.key.name),
+        {
+          name: prefix + '.' + param.key.name
+        },
+        getInlineDescription(param)
+      );
     case 'RestProperty': // (a, ...b)
     case 'RestElement':
       let type /*: DoctrineType */ = {
@@ -213,7 +231,7 @@ function paramToDoc(
         newParam.type = flowDoctrine(param.typeAnnotation.typeAnnotation);
       }
 
-      return newParam;
+      return _.assign(newParam, getInlineDescription(param));
   }
 }
 

test/fixture/params.input.js

@@ -15,6 +15,16 @@ function fishesAndFoxes({ fishes, foxes }) {
   return fishes + foxes;
 }
 
+/**
+ * This method has inline documentation for a param
+ * @param {Object} options
+ */
+function fishesAndFoxesInline(
+  { fishes /** number of kinds of fish */, foxes }
+) {
+  return fishes + foxes;
+}
+
 /**
  * This method has a type in the description and a default in the code
  * @param {number} x