Closed Rantanen closed 9 years ago
your syntax is incorrect, you forgot to specify the type of the variadic args.. should look something like
/**
* Example event
*
* @event Class#event
* @param {...string} arguments - The original event arguments.
*/
in this case we use string
but it could be any valid type expression..
Right. Don't suppose there's a way to omit the type? I'd rather have the output with:
Instead of
*
- ArgumentsThe *
-type doesn't really add any meaning to the documentation.
(And not a big deal. I can always alter the templates myself and make a special case to omit all *
types from the markdown, was just wondering if there was something built-in)
sorry, this is an issue for the jsdoc project.. the error you are seeing is thrown by jsdoc, which means jsdoc-parse (running upstream of jsdoc) fails too..
Oh wait. jsdoc-parse is using jsdoc internally? Thought it was your own parser, in that case I won't feel too bad opening another one... :)
Yes, it does
Results in
http://usejsdoc.org/tags-param.html#multiple-types-and-repeatable-parameters