runtime-documentation
v1.0.0
Published
resolve and generate module documentation at runtime
Downloads
19
Readme
runtime-documentation
require
Generate documentation at runtime from source files in a package.
Parameters
fileStringa file as a require path: this will be resolved by the resolve module, so it does not necessarily have to be absolute.callbackFunctioncalled 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) { });