Skip to content
This repository was archived by the owner on Sep 8, 2026. It is now read-only.

Latest commit

 

History

54 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

auto-docu

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages