esdoc-pr266
Documentation Generator For JavaScript(ES6)
Last updated 5 years ago by amercier .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install esdoc-pr266 
SYNC missed versions from official npm registry.

Owner Status Build Status Coverage Status Document

ESDoc

ESDoc is a documentation generator for JavaScript(ES6).

Feature

  • 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

Document

please visit esdoc.org to see more documentation.

License

MIT

Author

Ryo Maruyama@h13i32maru

Current Tags

  • 0.4.6-pr266.1                                ...           latest (5 years ago)

2 Versions

  • 0.4.6-pr266.1                                ...           5 years ago
  • 0.4.6-pr.266                                ...           5 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 0
Last Month 0
Dependencies (12)
Dev Dependencies (7)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |