wcdoc

Simple API Document Generator for Web Components.

Install

Install with npm

$ npm install wcdoc

Examples

var wcdoc = require('wcdoc');

wcdoc.run({
  src: ['src/**/*.js'],
  basePath: __dirname
}).then(function(result) {
  console.log(result);
});

Running tests

Install dev dependencies:

$ npm install -d && npm test

CHANGELOG

v0.1.19

• Updated the value of ecmaVersion for Espree.
• Added a new config espreeConfig to wcdoc.run.

v0.1.17

• Replaced esprima with espree.

v0.1.14

• Removed ParsedFile#ast.
• Enabled to parse typescript.
• Added DirectiveDoc, InputDoc and OutputDoc for Angular directives.

v0.1.13

• Changed to use Map instead of Object to fix TagDict error on 'constructor' tag.

v0.1.10

• Changed to respect original indentation in doc comments.