Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doesn't support parameter object properties #185

Closed
ProLoser opened this issue Sep 28, 2017 · 1 comment
Closed

Doesn't support parameter object properties #185

ProLoser opened this issue Sep 28, 2017 · 1 comment

Comments

@ProLoser
Copy link

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants