hegemonic / jsdoc-baseline

An experimental, extensible template for JSDoc.
Other
61 stars 32 forks source link

Doesn't support parameter object properties #185

Closed ProLoser closed 6 years ago

ProLoser commented 7 years ago

If a function parameter is an object, you can document the properties of the object, but baseline does not render this documentation. Example:

/**
 * @param {object} [options]
 * @param {boolean} [options.foo]
 * @param {string} [options.bar]
 */
foobar(options) {}

Which could be called like this:

foobar({ foo: true, bar: 'hello' });
mercmobily commented 6 years ago

I discovered this too. To me, that's a total show-stopper. Is this repository getting much love?