Skip to content

oguzzkilic/vscode-undoc

Repository files navigation

vscode-undoc

An documentation generator for JavaScript functions and class methods. It detects undocumented functions and class methods in your Javascript / Flow / React file and creates a documentation template above the function or method.

Usage

Using Command Palette (CMD/CTRL + Shift + P)

CMD + Shift + P -> Create Docs

Install

undoc

React Example

react-example

Flow Example

flow-example

Supports

  1. ES6
  2. Presets of React
  3. Presets of Flow
  4. States ( only initialized in the constructor )

Contribution

Feel free to open issues and PRs. You can look here for helper documentations.

Contribution

  1. Fork it (https://github.com/oyilmaztekin/vscode-undoc/fork)
  2. Create your branch (git checkout -b fix/issue-id)
  3. Commit your changes (git commit -am 'Fixed something...')
  4. Push to the branch (git push origin fix/issue-id)
  5. Create a new Pull Request
TODO
  1. Create doc with selecting function or method
  2. Currying function
  3. PropTypes

Thanks

About

An extention that detects undocumented functions and generates docs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%