JSDoc question/suggestion on optional parameters
Hi, Webstorm keeps giving me warnings on the 'redirect' method, because the JSDoc specified two input parameters, both required. There is a JSDoc standard for optional parameters. What is your view on using these in KOA documentation? http://usejsdoc.org/tags-param.html#optional-parameters-and-default-values closes #661
This commit is contained in:
parent
97c34d1905
commit
229641127a
1 changed files with 1 additions and 1 deletions
|
@ -247,7 +247,7 @@ module.exports = {
|
|||
* this.redirect('http://google.com');
|
||||
*
|
||||
* @param {String} url
|
||||
* @param {String} alt
|
||||
* @param {String} [alt]
|
||||
* @api public
|
||||
*/
|
||||
|
||||
|
|
Loading…
Reference in a new issue