hokaccha / esdoc

Documentation Generator For JavaScript(ES6)

ESDoc

ESDoc is a documentation generator for JavaScript(ES6).

Feature

• Generates detailed document.
• Measures document coverage.
• Cross reference of test and document.
• Targets at ES6 class and import/export style.

Demo

• ESDoc is self-hosting 😄
• Libraries written by ES6 without document tags
  • Aurelia HTTP Client
  • Aurelia Validation

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

Document

please visit esdoc.org to see more document.

License

MIT