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
In the example you have a jsdoc block over a helper function (not a vuejs event). Is that documentation supposed to be generated? The only thing generated for me is what is marked as a @vue-event but I often have functions in methods: that I wouldn't classify as an event.
Here are the jsdoc package versions I have installed.
@Kocal Thank you. Therein lies my problem. Inside of .vue files the only thing parsed and added to the documentation are @vue-* tags. No other documentation is generated (e.g. a normal jsdoc method).
brandoncordell
changed the title
Helper functions with jsdoc blocks are not outputted in the documentation
Helper functions with jsdoc blocks are not output in the documentation
Nov 29, 2019
Inside Vue file, in Methods section, I only use
/**
*Description of myFunction
*@param {Type} paramX - param description
*/
myFunction(paramX){
....
}
Instead of using @function, i got my methods well parsed by just giving them a description. The vuejs plugin recognizes and uses the name of each method (defined in code) and that is what i see on html doc.
In the example you have a jsdoc block over a helper function (not a vuejs event). Is that documentation supposed to be generated? The only thing generated for me is what is marked as a
@vue-event
but I often have functions inmethods:
that I wouldn't classify as an event.Here are the jsdoc package versions I have installed.
The text was updated successfully, but these errors were encountered: