Pick up shorthand property's variable comments

Resolves #2999

Author: Gerrit0

CHANGELOG.md

@@ -4,6 +4,11 @@ title: Changelog
 
 ## Unreleased
 
+### Features
+
+- Object properties declared with shorthand property assignment will now use the variable's comment
+  if they do not have their own comment, #2999.
+
 ### Bug Fixes
 
 - Fixed link resolution not working correctly in first comment on the file in some cases, #2994.

src/lib/converter/comments/discovery.ts

@@ -525,6 +525,22 @@ function declarationToCommentNodes(
         });
     }
 
+    // #2999 automatically pick up comments from the value symbol for shorthand assignments
+    if (ts.isShorthandPropertyAssignment(node)) {
+        const sourceSymbol = checker.getShorthandAssignmentValueSymbol(node);
+        if (sourceSymbol?.valueDeclaration) {
+            const commentNode = declarationToCommentNodeIgnoringParents(sourceSymbol.valueDeclaration);
+            if (commentNode) {
+                result.push(
+                    {
+                        node: commentNode,
+                        inheritedFromParentDeclaration: true,
+                    },
+                );
+            }
+        }
+    }
+
     // With overloaded functions/methods, TypeScript will use the comment on the first signature
     // declaration
     if (

src/test/converter2/issues/gh2999.ts

@@ -0,0 +1,10 @@
+/**
+ * A test object with property a.
+ */
+const LocalObject = {
+    a: 1,
+};
+
+export const Options = {
+    LocalObject,
+};

src/test/issues.c2.test.ts

@@ -2150,4 +2150,12 @@ describe("Issue Tests", () => {
         const link = project.comment?.summary.find(part => part.kind === "inline-tag");
         ok(link?.target instanceof ReflectionSymbolId);
     });
+
+    it("#2999 picks up parent comments from shorthand property assignments", () => {
+        const project = convert();
+        const opts = query(project, "Options");
+        equal(opts.type?.type, "reflection");
+        const local = opts.type.declaration.getChildByName("LocalObject");
+        equal(Comment.combineDisplayParts(local?.comment?.summary), "A test object with property a.");
+    });
 });