Skip to content
This repository has been archived by the owner on Mar 8, 2019. It is now read-only.

@event tag just support one param #17

Closed
chasewoo opened this issue Dec 31, 2017 · 2 comments
Closed

@event tag just support one param #17

chasewoo opened this issue Dec 31, 2017 · 2 comments
Assignees

Comments

@chasewoo
Copy link

Now, the @event tag just support @type tag, and I just set one param.

/**
 * @event click
 * @type {Object}
 */

But, if I want to export two or more params, the vue-styleguidist can't support it.

I suggest to update the @event tag, like:

/**
 * @event click
 * @property {Event} event - DOM Event
 * @property {String} name - some name
 * @property {String} value - some value
 */
this.emit('click', event, 'name', 'value')
@elevatebart
Copy link
Member

Fixed ;)

@chasewoo
Copy link
Author

chasewoo commented Dec 5, 2018

@elevatebart Thank you, it is very cool!

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

No branches or pull requests

2 participants