Multiple params and line break support for methods and events #70
Conversation
xuzicn
changed the title
|
Hi, It would be awesome to see this go in, when can we expect it? Thanks. |
|
I would also love to see this implemented if possible |
| "events": "<table><thead><tr><th>Event Name</th><th>Description</th><th>Parameters</th><th>Type</th><th>Default</th></tr></thead><tbody><tr><td rowspan=1>click</td><td rowspan=1>Triggered when clicked</td><td rowspan=1>test</td><td rowspan=1>Boolean</td><td rowspan=1>false</td></tr></tbody></table>", | ||
| "methods": "<table><thead><tr><th>Method</th><th>Description</th><th>Parameters</th><th>Type</th><th>Default</th></tr></thead><tbody><tr><td rowspan=1>clear</td><td rowspan=1>Clear form</td><td rowspan=1>test</td><td rowspan=1>Boolean</td><td rowspan=1>false</td></tr></tbody></table>", |
There was a problem hiding this comment.
This was exactly my suggestion in #128 to convert the markdown tables to its html equivalent to format multi-line comments. This PR should resolve my issue as well. Hopefully the author comes back and accepts this, this is a great PR.
|
could you resolve conflicts, and merge current monorepo branch and pass all test ? |
|
I'd love to see this get added and would try to resolve the conflicts for the MIA author (ping @xuzicn) but I couldn't get the repo setup locally to contribute anything |
Recently, i am working on other stuff, after that, i will open another branch finish this feature |
multiple args support for methods and events like JSDoc does. support arg type and default value
support multiple lines in method and event descriptions
methods: {
/**
* @vuese
* descprition first row
* descprition second row
* @arg argA {Boolean} [false] - argA desc
* @arg argB {String} [foo] - argB desc
/
submit(argA, argB) {
/*
* some-event to do something
* @arg argA {Boolean} [false] - argA desc
* @arg argB {String} [foo] - argB desc
*/
this.$emit('some-event', argA, argB)
}
}