You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update: I see that I should probably have added this to #102.
This is a proposal to extend jsdoc-vuejs with two new annotations:
@vue-slot
@vue-event
I need to document slots and events that are offered by my components. jsdoc does not have a suitable annotation for slots. There is the @emits annotation, but it does not work well for events, as it does not have a way to document the event's parameters (that I know of).
Both slots (scoped) and events (params) have an ability to pass parameters. It would be great if we had a @vue-slot and @vue-event annotation, which would allow us to follow it with @param annotations. @params would then describe the slots and events for us. The result would be a table for slots and a separate table for events.
Update: I see that I should probably have added this to #102.
This is a proposal to extend jsdoc-vuejs with two new annotations:
@vue-slot
@vue-event
I need to document slots and events that are offered by my components. jsdoc does not have a suitable annotation for slots. There is the @emits annotation, but it does not work well for events, as it does not have a way to document the event's parameters (that I know of).
Both slots (scoped) and events (params) have an ability to pass parameters. It would be great if we had a
@vue-slot
and@vue-event
annotation, which would allow us to follow it with @param annotations. @params would then describe the slots and events for us. The result would be a table for slots and a separate table for events.For example
Is this feasible?
The text was updated successfully, but these errors were encountered: