From 700d4130daabc127a72cf92f0f77a514e340290d Mon Sep 17 00:00:00 2001 From: Gerrit Birkeland Date: Mon, 31 May 2021 21:00:09 -0600 Subject: [PATCH] fix(js): Pick up doc comments for properties declared within a class's constructor Resolves #1255 --- src/lib/converter/converter.ts | 1 + src/test/converter2.test.ts | 7 ++++++- src/test/converter2/issues/gh1255.js | 9 +++++++++ 3 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 src/test/converter2/issues/gh1255.js diff --git a/src/lib/converter/converter.ts b/src/lib/converter/converter.ts index 4aae0dea9..4fa87bcc8 100644 --- 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 index 5ca3d69c8..c1994da95 100644 --- a/src/test/converter2.test.ts +++ b/src/test/converter2.test.ts @@ -56,6 +56,11 @@ const issueTests: Record 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 new file mode 100644 index 000000000..fe03fb59b --- /dev/null +++ b/src/test/converter2/issues/gh1255.js @@ -0,0 +1,9 @@ +export class C { + constructor() { + /** + * Docs! + * @type {number} + */ + this.foo = 123; + } +}