README (node-docor)

Installation

Integrate information with JSDoc(node-pajsdoc) with AST(node-castjson).

npm install node-docor

Quick Start

1const Docer = require('node-docor');
2
3let docer = new Docer('test/docor.ini');
4let bStatus = docer.parse();
5if (bStatus) {
6    console.log(docer.libraryList);
7}

Example

Test

1$ mocha
2
3  Docer class
4    - Docer()
5      √ should return true
6    - _findModuleFiles()
7      √ should return true
8    - _parseAstToJson()
9      √ should return true (273ms)
10    - _collect()
11      √ should return true (439ms)
12    - _classify()
13      √ should return true (436ms)
14    - parse()
15      √ should return true (432ms)
16
17  6 passing (2s)

Resource

1. node-gendoc https://github.com/dougpuob/node-gendoc.git

License

MIT