feat: add support for class param declarations at the constructor (#1013

)
documentationjs · Feb 10, 2018 · 05c5279 · 05c5279
1 parent 647fdf4
commit 05c5279
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/src/infer/params.js b/src/infer/params.js
@@ -52,7 +52,11 @@ function inferParams(comment: Comment) {
 
 function inferAndCombineParams(params, comment) {
   const inferredParams = params.map((param, i) => paramToDoc(param, '', i));
-  const mergedParamsAndErrors = mergeTrees(inferredParams, comment.params);
+  const paramsToMerge = comment.params;
+  if (comment.constructorComment) {
+    paramsToMerge.push.apply(paramsToMerge, comment.constructorComment.params);
+  }
+  const mergedParamsAndErrors = mergeTrees(inferredParams, paramsToMerge);
 
   // Then merge the trees. This is the hard part.
   return Object.assign(comment, {

diff --git a/src/parsers/javascript.js b/src/parsers/javascript.js
@@ -103,7 +103,7 @@ function _addComment(
 
       if (t.isClassMethod(path) && path.node.kind === 'constructor') {
         // #689
-        if (!comment.hideconstructor) {
+        if (comment.tags.some(tag => tag.title !== 'param' && tag.title !== 'hideconstructor')) {
           debuglog(
             'A constructor was documented explicitly: document along with the class instead'
           );