Overloads do not emit JSDoc on non-implementation signatures

[bluelovers]

TypeScript Version: 3.2.0-dev.201xxxxx

Search Terms:

Code

.ts file

/**
 * this will lost
 */
function a()
function a() { }

/**
 * this will keep
 */
function b() { }

function c()
/**
 * this will keep, but i don't think this is good way
 */
function c() { }

Expected behavior:

all will keep

/**
 * this will lost
 */
function a() { }
/**
 * this will keep
 */
function b() { }
/**
 * this will keep, but i don't think this is good way
 */
function c() { }

Actual behavior:

a is lost

output .js file

function a() { }
/**
 * this will keep
 */
function b() { }
/**
 * this will keep, but i don't think this is good way
 */
function c() { }

---

and when it at .d.ts

• a will keep
• b will keep too
• but c will lost

Playground Link:
http://www.typescriptlang.org/play/index.html#src=%2F**%0D%0A%20*%20this%20will%20lost%0D%0A%20*%2F%0D%0Afunction%20a()%0D%0Afunction%20a()%20%7B%20%7D%0D%0A%0D%0A%2F**%0D%0A%20*%20this%20will%20keep%0D%0A%20*%2F%0D%0Afunction%20b()%20%7B%20%7D%0D%0A%0D%0Afunction%20c()%0D%0A%2F**%0D%0A%20*%20this%20will%20keep%2C%20but%20i%20don%27t%20think%20this%20is%20good%20way%0D%0A%20*%2F%0D%0Afunction%20c()%20%7B%20%7D

Related Issues:

[RyanCavanaugh]

@sandersn How do you feel about emitting all JS doc comments attached to the first signature + the implementation signature, eliding all intermediates? That should eliminate duplicates without breaking existing emit too badly.

[sandersn]

@bterlson probably has opinions since he was thinking about how to write jsdoc for overloads.

[bluelovers]

Expected behavior:

ts

/**
 * this will keep, because all other overloads didn't have jsdoc
 */
function a()
function a()
function a() { }


function b()
function b()
/**
 * this will keep, because all other overloads didn't have jsdoc
 */
function b() { }

/**
 * desc
 */
function c()
function c()
/**
 * this will lost, because one of overloads have jsdoc
 */
function c() { }

=>

/**
 * this will keep, because all other overloads didn't have jsdoc
 */
declare function a(): any;
/**
 * this will keep, because all other overloads didn't have jsdoc
 */
declare function a(): any;
/**
 * this will keep, because all other overloads didn't have jsdoc
 */
declare function b(): any;
/**
 * this will keep, because all other overloads didn't have jsdoc
 */
declare function b(): any;
/**
 * desc
 */
declare function c(): any;
declare function c(): any;