Coddoc

Description

coddoc is a jsdoc parsing library. Coddoc is different in that it is easily extensible by allowing users to add tag and code parsers through the use of coddoc.addTagHandler and coddoc.addCodeHandler. coddoc also parses source code to be used in APIs.

Coddoc also supports the generation of markdown and html through the use of different templates. Currently the templates use Handlebars but you may use any templating engine you wish

JSDOC Tags

JSDoc tags currently supported are:

Coddoc Tags

Coddoc also has a few additional tags.

Installation

Locally
 npm install coddoc
Globally
 npm install -g coddoc

Usage

Down doc does not currently create multi file docs instead will output to a single file. You may however implement your own formatter to create multiple files. Command line options Examples JSON output
 coddoc -d ./lib > symbols.json
To use the markdown formatter
 coddoc -d ./lib -f markdown > README.md
To use the HTML formatter
 coddoc -d ./lib -f html > index.html
To use pragmatically

var coddoc = require("coddoc");
var tree = coddoc.parse({directory : __dirname + "/lib"});
var classes = tree.classes, namespaces = tree.namespaces;
//do something

API


License

MIT LICENSE

Meta


Code: git clone git://github.com/pollenware/coddoc.git