How to document a function returned by a function using JSDoc

Question

I am using JSDoc for parameter documentation.

It is clear how to document the parameter types for many_prompts, but what is the right way to document the function it returns?

/**  * @param {Number} - number of times to prompt  * @return {Function(prompt{Number})} - the returned function  */ function many_prompts(count) {   return function(prompt) {     for(var i=0; i < count; i++) alert(prompt);   } }   //Example of use: var y  =many_prompts(3); y('Hello World'); 

Answer 1

You can document the inner function and then reference it like so

/**  * @param {Number} - number of times to prompt  * @return {many_prompts~inner} - the returned function  */ function many_prompts(count){   /**    * My inner function    *    * @param {object} prompt Some parameter    */   var inner = function(prompt){     for(var i=0;i<count;i++) alert(prompt)   };   return inner; }