fix(js): Pick up doc comments for properties declared within a class'…

…s constructor Resolves #1255
TypeStrong · Jun 1, 2021 · 700d413 · 700d413
1 parent e125484
commit 700d413
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/src/lib/converter/converter.ts b/src/lib/converter/converter.ts
@@ -205,6 +205,7 @@ export class Converter extends ChildableComponent<
                 ts.SyntaxKind.PropertyDeclaration,
                 ts.SyntaxKind.PropertySignature,
                 ts.SyntaxKind.JSDocPropertyTag,
+                ts.SyntaxKind.BinaryExpression,
             ],
             [ReflectionKind.Method]: [
                 ts.SyntaxKind.MethodDeclaration,

diff --git a/src/test/converter2.test.ts b/src/test/converter2.test.ts
@@ -56,6 +56,11 @@ const issueTests: Record<string, (project: ProjectReflection) => void> = {
         equal(refl.signatures?.[0]?.comment?.returns, "Test description.\n");
     },
 
+    gh1255(project) {
+        const foo = query(project, "C.foo");
+        equal(foo.comment?.shortText, "Docs!");
+    },
+
     gh1330(project) {
         const example = query(project, "ExampleParam");
         equal(example?.type?.type, "reference");
@@ -220,7 +225,7 @@ describe("Converter2", () => {
     });
 
     let program: ts.Program;
-    it("Compiles", () => {
+    before("Compiles", () => {
         program = ts.createProgram(
             app.options.getFileNames(),
             app.options.getCompilerOptions()

diff --git a/src/test/converter2/issues/gh1255.js b/src/test/converter2/issues/gh1255.js
@@ -0,0 +1,9 @@
+export class C {
+    constructor() {
+        /**
+         * Docs!
+         * @type {number}
+         */
+        this.foo = 123;
+    }
+}