Declaration comments for function declarations in .d.ts

Author: sheetalkamat

src/compiler/emitter.ts

@@ -2523,6 +2523,7 @@ module ts {
                 // so no need to verify if the declaration is visible
                 if ((node.kind !== SyntaxKind.FunctionDeclaration || resolver.isDeclarationVisible(node)) &&
                     !resolver.isImplementationOfOverload(node)) {
+                    emitJsDocComments(node);
                     emitDeclarationFlags(node);
                     if (node.kind === SyntaxKind.FunctionDeclaration) {
                         write("function ");

tests/baselines/reference/commentsClass.js

@@ -137,12 +137,14 @@ declare class c2 {
 declare var i2: c2;
 declare var i2_c: typeof c2;
 declare class c3 {
+    /** Constructor comment*/
     constructor();
 }
 declare var i3: c3;
 declare var i3_c: typeof c3;
 /** Class comment*/
 declare class c4 {
+    /** Constructor comment*/
     constructor();
 }
 declare var i4: c4;
@@ -170,6 +172,8 @@ declare var i7_c: typeof c7;
 declare class c8 {
     /** s1 comment */
     static s1: number;
+    /** constructor comment 
+    */
     constructor();
 }
 declare var i8: c8;

tests/baselines/reference/commentsClassMembers.js

@@ -475,19 +475,23 @@ cProperties_i.nc_p2 = cProperties_i.nc_p1;
 declare class c1 {
     /** p1 is property of c1*/
     p1: number;
+    /** sum with property*/
     p2(b: number): number;
     /** getter property*/
     /** setter property*/
     p3: number;
     /** pp1 is property of c1*/
     private pp1;
+    /** sum with property*/
     private pp2(b);
     /** getter property*/
     /** setter property*/
     private pp3;
+    /** Constructor method*/
     constructor();
     /** s1 is static property of c1*/
     static s1: number;
+    /** static sum with property*/
     static s2(b: number): number;
     /** static getter property*/
     /** setter property*/
@@ -512,18 +516,21 @@ declare class c1 {
     static a_s3: number;
     /** p1 is property of c1 */
     b_p1: number;
+    /** sum with property */
     b_p2(b: number): number;
     /** getter property */
     /** setter property */
     b_p3: number;
     /** pp1 is property of c1 */
     private b_pp1;
+    /** sum with property */
     private b_pp2(b);
     /** getter property */
     /** setter property */
     private b_pp3;
     /** s1 is static property of c1 */
     static b_s1: number;
+    /** static sum with property */
     static b_s2(b: number): number;
     /** static getter property 
     */

tests/baselines/reference/commentsCommentParsing.js

@@ -294,25 +294,77 @@ var NoQuickInfoClass = (function () {
 //// [commentsCommentParsing.d.ts]
 declare function simple(): void;
 declare function multiLine(): void;
+/** this is eg of single line jsdoc style comment */
 declare function jsDocSingleLine(): void;
+/** this is multiple line jsdoc stule comment
+*New line1
+*New Line2*/
 declare function jsDocMultiLine(): void;
+/** this is multiple line jsdoc stule comment
+*New line1
+*New Line2*/
+/** Shoul mege this line as well
+* and this too*/ /** Another this one too*/
 declare function jsDocMultiLineMerge(): void;
+/** jsdoc comment */
 declare function jsDocMixedComments1(): void;
+/** jsdoc comment */ /*** another jsDocComment*/
 declare function jsDocMixedComments2(): void;
+/** jsdoc comment */ /*** another jsDocComment*/
 declare function jsDocMixedComments3(): void;
+/** jsdoc comment */ /*** another jsDocComment*/
 declare function jsDocMixedComments4(): void;
+/** jsdoc comment */ /*** another jsDocComment*/
 declare function jsDocMixedComments5(): void;
+/*** another jsDocComment*/
+/** jsdoc comment */
 declare function jsDocMixedComments6(): void;
 declare function noHelpComment1(): void;
 declare function noHelpComment2(): void;
 declare function noHelpComment3(): void;
+/** Adds two integers and returns the result
+  * @param {number} a first number
+  * @param b second number
+  */
 declare function sum(a: number, b: number): number;
+/** This is multiplication function*/
+/** @param */
+/** @param a first number*/
+/** @param b */
+/** @param c {
+ @param d @anotherTag*/
+/** @param e LastParam @anotherTag*/
 declare function multiply(a: number, b: number, c?: number, d?: any, e?: any): void;
+/** fn f1 with number
+* @param { string} b about b
+*/
 declare function f1(a: number): any;
 declare function f1(b: string): any;
+/** This is subtract function
+@param { a
+*@param { number | } b this is about b
+@param { { () => string; } } c this is optional param c
+@param { { () => string; } d this is optional param d
+@param { { () => string; } } e this is optional param e
+@param { { { () => string; } } f this is optional param f
+*/
 declare function subtract(a: number, b: number, c?: () => string, d?: () => string, e?: () => string, f?: () => string): void;
+/** this is square function
+@paramTag { number } a this is input number of paramTag
+@param { number } a this is input number
+@returnType { number } it is return type
+*/
 declare function square(a: number): number;
+/** this is divide function
+@param { number} a this is a
+@paramTag { number } g this is optional param g
+@param { number} b this is b
+*/
 declare function divide(a: number, b: number): void;
+/** this is jsdoc style function with param tag as well as inline parameter help
+*@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 class NoQuickInfoClass {
 }

tests/baselines/reference/commentsExternalModules.js

@@ -150,6 +150,7 @@ export declare module m1 {
         /** i*/
         var i: c;
     }
+    /** exported function*/
     function fooExport(): number;
 }
 /** Module comment */
@@ -165,6 +166,7 @@ export declare module m4 {
         /** i */
         var i: c;
     }
+    /** exported function */
     function fooExport(): number;
 }
 //// [commentsExternalModules_1.d.ts]

tests/baselines/reference/commentsExternalModules2.js

@@ -150,6 +150,7 @@ export declare module m1 {
         /** i*/
         var i: c;
     }
+    /** exported function*/
     function fooExport(): number;
 }
 /** Module comment */
@@ -165,6 +166,7 @@ export declare module m4 {
         /** i */
         var i: c;
     }
+    /** exported function */
     function fooExport(): number;
 }
 //// [commentsExternalModules_1.d.ts]

tests/baselines/reference/commentsFunction.js

@@ -49,7 +49,9 @@ lambddaNoVarComment(10, 20);
 
 
 //// [commentsFunction.d.ts]
+/** This comment should appear for foo*/
 declare function foo(): void;
+/** This is comment for function signature*/
 declare function fooWithParameters(a: string, b: number): void;
 /** fooFunc
  * comment

tests/baselines/reference/commentsInheritance.js

@@ -272,6 +272,7 @@ i2_i = i3_i;
 interface i1 {
     /** i1_p1*/
     i1_p1: number;
+    /** i1_f1*/
     i1_f1(): void;
     /** i1_l1*/
     i1_l1: () => void;
@@ -294,11 +295,13 @@ declare class c1 implements i1 {
     i1_nc_l1: () => void;
     /** c1_p1*/
     p1: number;
+    /** c1_f1*/
     f1(): void;
     /** c1_l1*/
     l1: () => void;
     /** c1_nc_p1*/
     nc_p1: number;
+    /** c1_nc_f1*/
     nc_f1(): void;
     /** c1_nc_l1*/
     nc_l1: () => void;
@@ -308,6 +311,7 @@ declare var c1_i: c1;
 declare class c2 {
     /** c2 c2_p1*/
     c2_p1: number;
+    /** c2 c2_f1*/
     c2_f1(): void;
     /** c2 c2_prop*/
     c2_prop: number;
@@ -316,18 +320,21 @@ declare class c2 {
     c2_nc_prop: number;
     /** c2 p1*/
     p1: number;
+    /** c2 f1*/
     f1(): void;
     /** c2 prop*/
     prop: number;
     nc_p1: number;
     nc_f1(): void;
     nc_prop: number;
+    /** c2 constructor*/
     constructor(a: number);
 }
 declare class c3 extends c2 {
     constructor();
     /** c3 p1*/
     p1: number;
+    /** c3 f1*/
     f1(): void;
     /** c3 prop*/
     prop: number;
@@ -343,6 +350,7 @@ declare var c4_i: c4;
 interface i2 {
     /** i2_p1*/
     i2_p1: number;
+    /** i2_f1*/
     i2_f1(): void;
     /** i2_l1*/
     i2_l1: () => void;
@@ -351,6 +359,7 @@ interface i2 {
     i2_nc_l1: () => void;
     /** i2 p1*/
     p1: number;
+    /** i2 f1*/
     f1(): void;
     /** i2 l1*/
     l1: () => void;
@@ -361,6 +370,9 @@ interface i2 {
 interface i3 extends i2 {
     /** i3 p1 */
     p1: number;
+    /**
+    * i3 f1
+    */
     f1(): void;
     /** i3 l1*/
     l1: () => void;

tests/baselines/reference/commentsInterface.js

@@ -123,6 +123,7 @@ interface i2 {
     nc_foo: (b: number) => string;
     [i: number]: number;
     (a: number, b: number): number;
+    /** this is fnfoo*/
     fnfoo(b: number): string;
     nc_fnfoo(b: number): string;
     nc_y: number;
@@ -145,6 +146,7 @@ declare var i2_i_nc_fnfoo_r: string;
 interface i3 {
     /** Comment i3 x*/
     x: number;
+    /** Function i3 f*/
     f(a: number): string;
     /** i3 l*/
     l: (b: number) => string;

tests/baselines/reference/commentsModules.js

@@ -283,8 +283,12 @@ declare module m1 {
         /** i*/
         var i: c;
     }
+    /** exported function*/
     function fooExport(): number;
     function foo2Export(a: string): void;
+    /** foo3Export
+     * comment
+     */
     function foo3Export(): void;
 }
 declare var myvar: m1.m2.c;