1
rated 0 times
[
6]
[
5]
/ answers: 1 / hits: 27973
/ 9 Years ago, sun, may 3, 2015, 12:00:00
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');
More From » jsdoc