auto-docu

Automatically generate JSDoc comments at runtime

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
20Aug 6, 2018Jul 27, 2018Minified + gzip package size for auto-docu in KB

Readme

auto-docu Coverage Status

This is a module to auto generate JSDoc comments in NodeJS projects.

DEMO

Workflow

  • run npm i auto-docu
  • run npx enable-inspection <folder> to modify the source files inside the given folder to log the function calls
  • start the application you want to document the code of
  • when all functions have been called run npx generate-doc <folder> to generate the comments for the documentation and insert it into the source code
  • run npx cleanup-inspection <root folder> to remove all meta files that have been created on the inspection

If you want to reset all the changes done by the inspection run npx cleanup-inspection <folder> --restore

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.