doxli

doxli

Interactive help documentation (using dox) for Node.JS modules on the command line.

When using Node.JS modules on the command line, doxli adds a help command to a module's exports, so you can view dox / jsdoc documentation for its exported functions.

Installation

npm install doxli

Usage

Running node on the command line:

> var foo = require('foo');
> var doxli = require('doxli');
> doxli(foo);

Module foo's exported methods now have a help utility!

> foo.bar.help();
// => dox / jsdoc comments for this function will be printed here

Using doxli in a module to automatically provide help functions for exports:

var doxli = require('doxli');
// module definition goes here
doxli(this);