Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to get parameters of Class Constructor #84

Open
wmontgomery opened this issue Feb 9, 2015 · 2 comments
Open

How to get parameters of Class Constructor #84

wmontgomery opened this issue Feb 9, 2015 · 2 comments

Comments

@wmontgomery
Copy link

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

My jsdoc for the constructor looks as follow:

/**

  • Constructor for components
  • @Class AmenitiesList
  • @memberof comp.model
  • @param {object} options overwrite defaults
    */
@wmontgomery wmontgomery changed the title How to get parameters of Class How to get parameters of Class Constructor Feb 9, 2015
@psq
Copy link
Contributor

psq commented Feb 9, 2015

@wmontgomery this was not possible. The analyzer was not including the params for the constructor. This commit fixes this: e7477a2.

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
Copy link
Contributor

@psq Sounds good.

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

No branches or pull requests

3 participants