fix(document-exported): Ensure that document-exported does not docume…

…nt constructors separately
documentationjs · Apr 24, 2017 · 96a6d13 · 96a6d13
1 parent 355038d
commit 96a6d13
Show file tree

Hide file tree

Showing 5 changed files with 173 additions and 101 deletions.
diff --git a/lib/extractors/exported.js b/lib/extractors/exported.js
@@ -165,7 +165,11 @@ function traverseExportedSubtree(path, data, addComments, overrideName) {
         path.skip();
       },
       Method(path) {
-        addComments(data, path);
+        // Don't explicitly document constructor methods: their
+        // parameters are output as part of the class itself.
+        if (path.node.kind !== 'constructor') {
+          addComments(data, path);
+        }
         path.skip();
       }
     });

diff --git a/test/fixture/document-exported.input.js b/test/fixture/document-exported.input.js
@@ -1,6 +1,7 @@
 // Options: {"documentExported": true}
 
 export class Class {
+  constructor(a: string) {}
   classMethod() {}
   get classGetter() {}
   set classSetter(v) {}