Package Exports

esdoc
esdoc/out/src/Doc/AbstractDoc
esdoc/out/src/Doc/FileDoc
esdoc/out/src/ESDoc.js
esdoc/out/src/ESDocCLI.js
esdoc/out/src/Parser/CommentParser
esdoc/out/src/Parser/ESParser
esdoc/out/src/Parser/ParamParser
esdoc/out/src/Publisher/publish
esdoc/out/src/Publisher/publish.js
esdoc/out/src/Util/ASTUtil
esdoc/out/src/Util/InvalidCodeLogger
esdoc/out/src/Util/PathResolver

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (esdoc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ESDoc

ESDoc is a documentation generator for JavaScript(ES6).

Feature

Generates detailed document.
Measures document coverage.
Integrate test codes into documentation.

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

Document

please visit esdoc.org to see more document.

License

MIT