kkoomen / vim-doge

(Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥
GNU General Public License v3.0
1.01k stars 51 forks source link

Use JSDoc to document an ES6 class property #638

Closed JohnnyVM closed 1 year ago

JohnnyVM commented 1 year ago

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 commented 1 year ago

Hey,

Yeah sure, I'll implement it this weekend.

JohnnyVM commented 1 year ago

A lot of thanks :)

kkoomen commented 1 year ago

@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.