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

Use JSDoc to document an ES6 class property #638

Closed
JohnnyVM opened this issue Oct 22, 2023 · 3 comments · Fixed by #639
Closed

Use JSDoc to document an ES6 class property #638

JohnnyVM opened this issue Oct 22, 2023 · 3 comments · Fixed by #639

Comments

@JohnnyVM
Copy link

Is your feature request related to a problem? Please describe.
Hello
I would like to suggest use JSDoc type for document ES6 class properties
If you agree and you don't have time, I can try to implement it myself and PR.

Describe the solution you'd like
this is the expected generated documentation

class Foo {
// documentation generated
  /**
   * [TODO:description] 
   * @type {[TODO:type]}
   */
  property // use the command DogeGenerate here
}

Describe alternatives you've considered
other alternatives are described here:
https://stackoverflow.com/questions/51467835/how-to-use-jsdoc-to-document-an-es6-class-property?rq=3

@kkoomen
Copy link
Owner

kkoomen commented Oct 26, 2023

Hey,

Yeah sure, I'll implement it this weekend.

@JohnnyVM
Copy link
Author

A lot of thanks :)

@kkoomen
Copy link
Owner

kkoomen commented Oct 29, 2023

@JohnnyVM I forgot to mention: this feature has been merged and released in v4.6.0.

Feel free to submit any new issues if you experience any unwanted behavior in the future. Thanks for your contribution.

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

Successfully merging a pull request may close this issue.

2 participants