How to document a function/method with unknown number & type of optional params?

[Bnaya Peretz]

For methods like backbone trigger http://backbonejs.org/#Events-trigger
Its there a structured way of doing that or a common convention ?
I can't find any refrance in http://usejsdoc.org/tags-param.html

Thanks!

[Bnaya Peretz]

My bad, its looks like there is the Variable parameter
{...type}

[Bnaya Peretz]

Its looks like i can't declare it as optional or/and multiple typeable.

I'm getting parse errors with all the combinations i was able to think about

exception from uncaught JavaScript throw: Error: cannot create a doclet for the comment "/**         * lalal         * @param  {String} topic The name of the notification to notify         * @param  {...[Number]} args Arguments to send the notification handlers         */": unable to parse the type expression "...[Number]": Expected "$", "*", "?", "\\", "_", "null", "undefined", Unicode letter number, Unicode lowercase letter, Unicode modifier letter, Unicode other letter, Unicode titlecase letter or Unicode uppercase letter but "[" found.

[Jeff Williams]

Hi Bnaya,

I haven't tested this, but I think {...Number=} will give you what you're looking for.

It'd be nice if {...[Number]} worked as well, though, so I'll file a ticket for that.

- Jeff

--
You received this message because you are subscribed to the Google Groups "JSDoc Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jsdoc-users...@googlegroups.com.
To post to this group, send email to jsdoc...@googlegroups.com.
Visit this group at http://groups.google.com/group/jsdoc-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

[Bnaya Peretz]

Great, thanks!