Correct way to document open-ended argument functions in JSDoc

Question

Let\'s say you have something like the following:

var someFunc = function() {
    // do something here with arguments
}

How would you corre

Answer 1

From the JSDoc users group:

There isn't any official way, but one possible solution is this:

/**
 * @param [...] Zero or more child nodes. If zero then ... otherwise ....
 */

The square brackets indicate an optional parameter, and the ... would (to me) indicate "some arbitrary number."

Another possibility is this...

/**
 * @param [arguments] The child nodes.
 */

Either way should communicate what you mean.

It's a bit dated, though (2007), but I'm not aware of anything more current.

If you need to document the param type as 'mixed', use {*}, as in @param {*} [arguments].