This is a maintained fork of ESDoc that will rapidly see new features and bug fixes. Hopefully one day it can be contributed upstream when the original author is ready. Stay tuned to Ongoing Refactoring to keep informed on current progress.
To include in your project add to package.json in devDependencies: "esdoc": "git+https://git@github.com/typhonjs-node-esdoc/esdoc.git". Please note that this directly links to Github. If you want to pull in the latest version on Github just delete your ./node_modules/esdoc directory and run npm install again.
Fork maintainer: Mike Leahy
ESDoc
ESDoc is a documentation generator for JavaScript(ES6).
Features
- Generates detailed documentation.
- Measures documentation coverage.
- Integrate test codes into documentation.
- Integrate manual into documentation.
- ESDoc Hosting Service
Demo
- ESDoc is self-hosting 😄
Install
npm install -g esdoc
esdoc -h
Usage
esdoc -c esdoc.json
Example
├── esdoc.json
└── src/MyClass.js
src/MyClass.js
/**
* this is MyClass.
*/
export default class MyClass {
/**
* @param {number} param this is param.
* @return {number} this is return.
*/
method(param){}
}
esdoc.json
{
"source": "./src",
"destination": "./esdoc"
}
exec esdoc
esdoc -c esdoc.json
open ./esdoc/index.html
Documentation
please visit esdoc.org to see more documentation.
License
MIT