Declaration comments for parameters in .d.ts file

Author: sheetalkamat

src/compiler/emitter.ts

@@ -2647,6 +2647,7 @@ module ts {
             }
 
             function emitParameterDeclaration(node: ParameterDeclaration) {
+                emitJsDocComments(node);
                 if (node.flags & NodeFlags.Rest) {
                     write("...");
                 }

tests/baselines/reference/commentsClassMembers.js

@@ -476,14 +476,14 @@ declare class c1 {
     /** p1 is property of c1*/
     p1: number;
     /** sum with property*/
-    p2(b: number): number;
+    p2(/** number to add*/ b: number): number;
     /** getter property*/
     /** setter property*/
     p3: number;
     /** pp1 is property of c1*/
     private pp1;
     /** sum with property*/
-    private pp2(b);
+    private pp2(/** number to add*/ b);
     /** getter property*/
     /** setter property*/
     private pp3;
@@ -492,7 +492,7 @@ declare class c1 {
     /** s1 is static property of c1*/
     static s1: number;
     /** static sum with property*/
-    static s2(b: number): number;
+    static s2(/** number to add*/ b: number): number;
     /** static getter property*/
     /** setter property*/
     static s3: number;

tests/baselines/reference/commentsCommentParsing.js

@@ -365,6 +365,6 @@ declare function divide(a: number, b: number): void;
 *@param a it is first parameter
 *@param c it is third parameter
 */
-declare function jsDocParamTest(a: number, b: number, c: number, d: number): number;
+declare function jsDocParamTest(/** this is inline comment for a */ a: number, /** this is inline comment for b*/ b: number, c: number, d: number): number;
 declare class NoQuickInfoClass {
 }

tests/baselines/reference/commentsFunction.js

@@ -52,7 +52,8 @@ lambddaNoVarComment(10, 20);
 /** This comment should appear for foo*/
 declare function foo(): void;
 /** This is comment for function signature*/
-declare function fooWithParameters(a: string, b: number): void;
+declare function fooWithParameters(/** this is comment about a*/ a: string, /** this is comment for b*/
+b: number): void;
 /** fooFunc
  * comment
  */

tests/baselines/reference/commentsInterface.js

@@ -118,16 +118,16 @@ interface i2 {
     /** this is foo*/
     foo: (b: number) => string;
     /** this is indexer*/
-    [i: string]: any;
+    [/**string param*/ i: string]: any;
     /**new method*/
-    new (i: i1): any;
+    new (/** param*/ i: i1): any;
     nc_x: number;
     nc_foo: (b: number) => string;
     [i: number]: number;
     /** this is call signature*/
-    (a: number, b: number): number;
+    (/**paramhelp a*/ a: number, /**paramhelp b*/ b: number): number;
     /** this is fnfoo*/
-    fnfoo(b: number): string;
+    fnfoo(/**param help*/ b: number): string;
     nc_fnfoo(b: number): string;
     nc_y: number;
 }
@@ -150,7 +150,7 @@ interface i3 {
     /** Comment i3 x*/
     x: number;
     /** Function i3 f*/
-    f(a: number): string;
+    f(/**number parameter*/ a: number): string;
     /** i3 l*/
     l: (b: number) => string;
     nc_x: number;

tests/baselines/reference/commentsModules.js

@@ -285,7 +285,7 @@ declare module m1 {
     }
     /** exported function*/
     function fooExport(): number;
-    function foo2Export(a: string): void;
+    function foo2Export(/**hm*/ a: string): void;
     /** foo3Export
      * comment
      */

tests/baselines/reference/commentsOverloads.js

@@ -262,20 +262,20 @@ var c5_i_2 = new c5("hello");
 
 //// [commentsOverloads.d.ts]
 /** this is signature 1*/
-declare function f1(a: number): number;
+declare function f1(/**param a*/ a: number): number;
 declare function f1(b: string): number;
 declare function f2(a: number): number;
 /** this is signature 2*/
 declare function f2(b: string): number;
 declare function f3(a: number): number;
 declare function f3(b: string): number;
 /** this is signature 4 - with number parameter*/
-declare function f4(a: number): number;
+declare function f4(/**param a*/ a: number): number;
 /** this is signature 4 - with string parameter*/
 declare function f4(b: string): number;
 interface i1 {
     /**this signature 1*/
-    (a: number): number;
+    (/**param a*/ a: number): number;
     /**this is signature 2*/
     (b: string): number;
     /** foo 1*/

tests/baselines/reference/commentsemitComments.js

@@ -149,7 +149,7 @@ var m1;
 /** Variable comments*/
 declare var myVariable: number;
 /** function comments*/
-declare function foo(p: number): void;
+declare function foo(/** parameter comment*/ p: number): void;
 /** variable with function type comment*/
 declare var fooVar: () => void;
 /**class comment*/

tests/baselines/reference/declFileCallSignatures.js

@@ -76,7 +76,8 @@ export interface ICallSignature {
 }
 export interface ICallSignatureWithParameters {
     /** This is comment for function signature*/
-    (a: string, b: number): void;
+    (/** this is comment about a*/ a: string, /** this is comment for b*/
+    b: number): void;
 }
 export interface ICallSignatureWithRestParameters {
     (a: string, ...rests: string[]): string;
@@ -99,7 +100,8 @@ interface IGlobalCallSignature {
 }
 interface IGlobalCallSignatureWithParameters {
     /** This is comment for function signature*/
-    (a: string, b: number): void;
+    (/** this is comment about a*/ a: string, /** this is comment for b*/
+    b: number): void;
 }
 interface IGlobalCallSignatureWithRestParameters {
     (a: string, ...rests: string[]): string;

tests/baselines/reference/declFileConstructSignatures.js

@@ -76,7 +76,8 @@ export interface IConstructSignature {
 }
 export interface IConstructSignatureWithParameters {
     /** This is comment for function signature*/
-    new (a: string, b: number): any;
+    new (/** this is comment about a*/ a: string, /** this is comment for b*/
+    b: number): any;
 }
 export interface IConstructSignatureWithRestParameters {
     new (a: string, ...rests: string[]): string;
@@ -99,7 +100,8 @@ interface IGlobalConstructSignature {
 }
 interface IGlobalConstructSignatureWithParameters {
     /** This is comment for function signature*/
-    new (a: string, b: number): any;
+    new (/** this is comment about a*/ a: string, /** this is comment for b*/
+    b: number): any;
 }
 interface IGlobalConstructSignatureWithRestParameters {
     new (a: string, ...rests: string[]): string;