Merge pull request microsoft#6870 from RyanCavanaugh/fix6825

RyanCavanaugh · RyanCavanaugh · commit 6f261f5b0bab · 2016-02-04T10:17:43.000-08:00
Recognize object literal method JSDoc comments
diff --git a/src/compiler/parser.ts b/src/compiler/parser.ts
@@ -3976,7 +3976,7 @@ namespace ts {
                     shorthandDeclaration.equalsToken = equalsToken;
                     shorthandDeclaration.objectAssignmentInitializer = allowInAnd(parseAssignmentExpressionOrHigher);
                 }
-                return finishNode(shorthandDeclaration);
+                return addJSDocComment(finishNode(shorthandDeclaration));
             }
             else {
                 const propertyAssignment = <PropertyAssignment>createNode(SyntaxKind.PropertyAssignment, fullStart);
@@ -3985,7 +3985,7 @@ namespace ts {
                 propertyAssignment.questionToken = questionToken;
                 parseExpected(SyntaxKind.ColonToken);
                 propertyAssignment.initializer = allowInAnd(parseAssignmentExpressionOrHigher);
-                return finishNode(propertyAssignment);
+                return addJSDocComment(finishNode(propertyAssignment));
             }
         }
 
diff --git a/src/compiler/utilities.ts b/src/compiler/utilities.ts
@@ -1212,13 +1212,19 @@ namespace ts {
             }
 
             // Also recognize when the node is the RHS of an assignment expression
+            const parent = node.parent;
             const isSourceOfAssignmentExpressionStatement =
-                node.parent && node.parent.parent &&
-                node.parent.kind === SyntaxKind.BinaryExpression &&
-                (node.parent as BinaryExpression).operatorToken.kind === SyntaxKind.EqualsToken &&
-                node.parent.parent.kind === SyntaxKind.ExpressionStatement;
+                parent && parent.parent &&
+                parent.kind === SyntaxKind.BinaryExpression &&
+                (parent as BinaryExpression).operatorToken.kind === SyntaxKind.EqualsToken &&
+                parent.parent.kind === SyntaxKind.ExpressionStatement;
             if (isSourceOfAssignmentExpressionStatement) {
-                return node.parent.parent.jsDocComment;
+                return parent.parent.jsDocComment;
+            }
+
+            const isPropertyAssignmentExpression = parent && parent.kind === SyntaxKind.PropertyAssignment;
+            if (isPropertyAssignmentExpression) {
+                return parent.jsDocComment;
             }
         }
 
diff --git a/tests/cases/fourslash/jsDocFunctionSignatures3.ts b/tests/cases/fourslash/jsDocFunctionSignatures3.ts
@@ -0,0 +1,32 @@
+///<reference path="fourslash.ts" />
+
+// @allowNonTsExtensions: true
+// @Filename: Foo.js
+
+//// var someObject = {
+////     /**
+////      * @param {string} param1 Some string param.
+////      * @param {number} parm2  Some number param.
+////      */
+////     someMethod: function(param1, param2) {
+////         console.log(param1/*1*/);
+////         return false;
+////     },
+////     /**
+////      * @param {number} p1  Some number param.
+////      */
+////     otherMethod(p1) {
+////         p1/*2*/
+////     }
+////     
+//// };
+
+goTo.marker('1');
+edit.insert('.');
+verify.memberListContains('substr', undefined, undefined, 'method');
+edit.backspace();
+
+goTo.marker('2');
+edit.insert('.');
+verify.memberListContains('toFixed', undefined, undefined, 'method');
+edit.backspace();

Original file line number	Diff line number	Diff line change
`@@ -3976,7 +3976,7 @@ namespace ts {`
`3976`	`3976`	`shorthandDeclaration.equalsToken = equalsToken;`
`3977`	`3977`	`shorthandDeclaration.objectAssignmentInitializer = allowInAnd(parseAssignmentExpressionOrHigher);`
`3978`	`3978`	`}`
`3979`		`- return finishNode(shorthandDeclaration);`
	`3979`	`+ return addJSDocComment(finishNode(shorthandDeclaration));`
`3980`	`3980`	`}`
`3981`	`3981`	`else {`
`3982`	`3982`	`const propertyAssignment = <PropertyAssignment>createNode(SyntaxKind.PropertyAssignment, fullStart);`
`@@ -3985,7 +3985,7 @@ namespace ts {`
`3985`	`3985`	`propertyAssignment.questionToken = questionToken;`
`3986`	`3986`	`parseExpected(SyntaxKind.ColonToken);`
`3987`	`3987`	`propertyAssignment.initializer = allowInAnd(parseAssignmentExpressionOrHigher);`
`3988`		`- return finishNode(propertyAssignment);`
	`3988`	`+ return addJSDocComment(finishNode(propertyAssignment));`
`3989`	`3989`	`}`
`3990`	`3990`	`}`
`3991`	`3991`