Transcription is an ECMAScript 6 (ES6) documentation generator designed to provide JSON, Markdown, and template driven HTML output.
Mutliple output formats. Flexible options should provided as each project and enviorment is unique. Transcription will out JSON structures (See Dox), Markdown (See Markdox), and template driven HTML output (See JSDoc).
Verify AST structures against JSDoc params. Becuase we have a proper AST object to compare with JSDoc doclets, an analysis will be peformed to verfiy that your comments matches the elements they are describing. This will developers track down any comments that become out of date, and inconsistencies that develop.
Gulp npm module. After basic functionality has been implemented and tested, Transcription should be easy to integrate into your build system.
You can see Transcription in action on your own system by following these steps: (Dependant on Git and Node.js)
npm install transcription
transcription -f html -i ./input -o ./output
transcription -f html -o ./output.html < ./input/controller.js
transcription -f html -o < ./input/controller.js > ./output/controller.html
transcription -f html -i ./input.html > ./output/controller.js