sutoiku / jsdox

simplified jsdoc 3
jsdox.org
MIT License
212 stars 51 forks source link

How to get parameters of Class Constructor #84

Open wmontgomery opened 9 years ago

wmontgomery commented 9 years ago

Is there any way to get the parameters or examples from the constructor of a class?

My jsdoc for the constructor looks as follow:

/**

psq commented 9 years ago

@wmontgomery this was not possible. The analyzer was not including the params for the constructor. This commit fixes this: https://github.com/sutoiku/jsdox/commit/e7477a2ebc6f33e20d823266f0eeb170e10a691a.

now, if you add something like this to class.mustache it will display the parameters.

{{#params}}
**{{name}}**: {{#typesString}}`{{typesString}}`{{/typesString}}{{#description}}, {{{description}}}{{/description}}
{{/params}}

Probably something that should be added to the default template. @mrjoelkemp what do you think?

mrjoelkemp commented 9 years ago

@psq Sounds good.