Fix missing comments on @enum members

Resolves #1880
TypeStrong · Mar 26, 2022 · d122622 · d122622
1 parent ee292cf
commit d122622
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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");
+    },
 };