From d122622f6c3d4bc5f8a0e1da6ab4ffd24d7bb715 Mon Sep 17 00:00:00 2001 From: Gerrit Birkeland Date: Sat, 26 Mar 2022 08:28:35 -0600 Subject: [PATCH] Fix missing comments on `@enum` members Resolves #1880 --- CHANGELOG.md | 4 ++++ src/lib/converter/converter.ts | 1 + src/test/converter2/issues/gh1880.d.ts | 11 +++++++++++ src/test/issueTests.ts | 9 +++++++++ 4 files changed, 25 insertions(+) create mode 100644 src/test/converter2/issues/gh1880.d.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 887c6bf8e..767ff51cd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Unreleased +### Bug Fixes + +- Fixed missing comments on `@enum` style enum members defined in declaration files, #1880. + ## v0.22.13 (2022-03-06) ### Features diff --git a/src/lib/converter/converter.ts b/src/lib/converter/converter.ts index a8c4c7ed9..a847c99cf 100644 --- a/src/lib/converter/converter.ts +++ b/src/lib/converter/converter.ts @@ -187,6 +187,7 @@ export class Converter extends ChildableComponent< [ReflectionKind.EnumMember]: [ ts.SyntaxKind.EnumMember, ts.SyntaxKind.PropertyAssignment, + ts.SyntaxKind.PropertySignature, ], [ReflectionKind.Variable]: [ts.SyntaxKind.VariableDeclaration], [ReflectionKind.Function]: [ diff --git a/src/test/converter2/issues/gh1880.d.ts b/src/test/converter2/issues/gh1880.d.ts new file mode 100644 index 000000000..87dfa5ef7 --- /dev/null +++ b/src/test/converter2/issues/gh1880.d.ts @@ -0,0 +1,11 @@ +/** + * This enumeration defines some values. + * + * @enum + */ +export declare const SomeEnum: { + /** + * This is the auto property. + */ + readonly AUTO: "auto"; +}; diff --git a/src/test/issueTests.ts b/src/test/issueTests.ts index 00687e7ef..ebcabee78 100644 --- a/src/test/issueTests.ts +++ b/src/test/issueTests.ts @@ -335,4 +335,13 @@ export const issueTests: { "Nested\n" ); }, + + gh1880(project) { + const SomeEnum = query(project, "SomeEnum"); + equal(SomeEnum.kind, ReflectionKind.Enum); + ok(SomeEnum.hasComment(), "Missing @enum variable comment"); + + const auto = query(project, "SomeEnum.AUTO"); + ok(auto.hasComment(), "Missing @enum member comment"); + }, };