Find comments on index signatures

Resolves #2414
TypeStrong · Oct 21, 2023 · 9fbeeab · 9fbeeab
1 parent 22fe25c
commit 9fbeeab
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/src/lib/converter/factories/index-signature.ts b/src/lib/converter/factories/index-signature.ts
@@ -29,6 +29,7 @@ export function convertIndexSignature(context: Context, symbol: ts.Symbol) {
             ReflectionKind.IndexSignature,
             context.scope,
         );
+        index.comment = context.getComment(indexSymbol, index.kind);
         index.parameters = [
             new ParameterReflection(
                 param.name.getText(),

diff --git a/src/test/converter2/issues/gh2414.ts b/src/test/converter2/issues/gh2414.ts
@@ -0,0 +1,4 @@
+export interface ObjectWithIndexSignature {
+    /** Index comment. */
+    [x: string]: any;
+}
diff --git a/src/test/issues.c2.test.ts b/src/test/issues.c2.test.ts
@@ -1185,4 +1185,15 @@ describe("Issue Tests", () => {
             "Comment for module",
         );
     });
+
+    it("Includes index signature comments #2414", () => {
+        const project = convert();
+        equal(
+            Comment.combineDisplayParts(
+                query(project, "ObjectWithIndexSignature").indexSignature
+                    ?.comment?.summary,
+            ),
+            "Index comment.",
+        );
+    });
 });