runtime-documentation v1.0.0

runtime-documentation

require

Generate documentation at runtime from source files in a package.

Parameters

• file String a file as a require path: this will be resolved by the resolve module, so it does not necessarily have to be absolute.
• callback Function called with (err, res). If the query is successful, res is an array of documentation objects.

Examples

var runtime = require('runtime-documentation');
runtime.require('./fixture', function(err, res) { });